Stylelint config

The recommended stylelint config for scss files.

It turns on all the possible errors rules within stylelint.

• SCSS Property: Use stylelint-scss plugin and stylelint-config-standard-scss config.

• Property Ordering: Extends stylelint-config-property-sort-order-smacss. Refer to here for the comprehensive list of property orders.

Installation

1npm install stylelint stylelint-scss stylelint-config-property-sort-order-smacss stylelint-order @wide/stylelint-config --save-dev

Usage

If you've installed @wide/stylelint-config locally within your project, just set your stylelint config to:

1{
2  "extends": "@wide/stylelint-config"
3}

Extending the config

Simply add a "rules" key to your config, then add your overrides and additions there.

For example, to change the at-rule-no-unknown rule to use its ignoreAtRules option, turn off the block-no-empty rule, and add the unit-allowed-list rule:

1{
2  "extends": "@wide/stylelint-config",
3  "rules": {
4    "at-rule-no-unknown": [
5      true,
6      {
7        "ignoreAtRules": ["extends"]
8      }
9    ],
10    "block-no-empty": null,
11    "unit-allowed-list": ["em", "rem", "s"]
12  }
13}

Stylelint CLI

Use Stylelint CLI to check the supported files. Drop this line into your package.json and customize it as your needs:

1{
2  "scripts": {
3    "lint:scss": "stylelint src/**/*.scss --formatter verbose"
4  }
5}

Thanks

• stylelint
• stylelint-config-property-sort-order-smacss
• stylelint-config-standard-scss
• stylelint-order
• stylelint-scss

Authors

• Aymeric Assier - github.com/myeti
• Julien Martins Da Costa - github.com/jdacosta

Contributors

• Sébastien Robillard - github.com/robiseb

License

This project is licensed under the MIT License - see the licence file for details