|  | 
| 1 | 1 | # stylelint-config-standard-scss | 
| 2 | 2 | 
 | 
| 3 | 3 | [](https://www.npmjs.org/package/stylelint-config-standard-scss) | 
| 4 |  | -[](https://github.com/stylelint-scss/stylelint-config-standard-scss/actions?workflow=Tests) | 
|  | 4 | +[](https://github.com/stylelint-scss/stylelint-config-standard-scss/actions?workflow=CI) | 
| 5 | 5 | [](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github) | 
| 6 | 6 | [](https://npmcharts.com/compare/stylelint-config-standard-scss) | 
| 7 |  | -[](https://greenkeeper.io/) | 
| 8 | 7 | 
 | 
| 9 | 8 | > The standard shareable SCSS config for Stylelint. | 
| 10 | 9 | 
 | 
| 11 |  | -Extends [`stylelint-config-standard`](https://github.com/stylelint/stylelint-config-standard) and [`stylelint-config-recommended-scss`](https://github.com/stylelint-scss/stylelint-config-recommended-scss). | 
|  | 10 | +This config: | 
| 12 | 11 | 
 | 
| 13 |  | -Turns on additional rules to enforce the common stylistic conventions found within a handful of Sass styleguide such as [Sass Guidelines](https://sass-guidelin.es/) and [Sass Style Guide](https://css-tricks.com/sass-style-guide/). | 
| 14 |  | - | 
| 15 |  | -Use it as is or as a foundation for your own config. | 
|  | 12 | +- extends the [`stylelint-config-standard` shared config](https://github.com/stylelint/stylelint-config-standard) and configures its rules for SCSS | 
|  | 13 | +- extends the [`stylelint-config-recommended-scss` shared config](https://github.com/stylelint-scss/stylelint-config-recommended-scss) | 
| 16 | 14 | 
 | 
| 17 | 15 | To see the rules that this config uses, please read the [config itself](/index.js). | 
| 18 | 16 | 
 | 
| 19 | 17 | ## Installation | 
| 20 | 18 | 
 | 
| 21 | 19 | ```shell | 
| 22 |  | -npm install stylelint stylelint-config-standard-scss --save-dev | 
|  | 20 | +npm install --save-dev stylelint-config-standard-scss | 
| 23 | 21 | ``` | 
| 24 | 22 | 
 | 
| 25 | 23 | ## Usage | 
| 26 | 24 | 
 | 
| 27 |  | -If you've installed `stylelint-config-standard-scss` locally within your project, just set your `stylelint` config to: | 
|  | 25 | +Set your `stylelint` config to: | 
| 28 | 26 | 
 | 
| 29 | 27 | ```json | 
| 30 | 28 | { | 
| 31 | 29 |   "extends": "stylelint-config-standard-scss" | 
| 32 | 30 | } | 
| 33 | 31 | ``` | 
| 34 | 32 | 
 | 
| 35 |  | -If you've globally installed `stylelint-config-standard-scss` using the `-g` flag, then you'll need to use the absolute path to `stylelint-config-standard-scss` in your config e.g. | 
| 36 |  | - | 
| 37 |  | -```json | 
| 38 |  | -{ | 
| 39 |  | -  "extends": "/absolute/path/to/stylelint-config-standard-scss" | 
| 40 |  | -} | 
| 41 |  | -``` | 
| 42 |  | - | 
| 43 | 33 | ### Extending the config | 
| 44 | 34 | 
 | 
| 45 | 35 | Simply add a `"rules"` key to your config, then add your overrides and additions there. | 
| 46 | 36 | 
 | 
| 47 |  | -For example, to turn off the `block-no-empty` rule, and add the `unit-whitelist` rule: | 
|  | 37 | +For example, to turn off the `scss/dollar-variable-pattern` rule: | 
| 48 | 38 | 
 | 
| 49 | 39 | ```json | 
| 50 | 40 | { | 
| 51 | 41 |   "extends": "stylelint-config-standard-scss", | 
| 52 | 42 |   "rules": { | 
| 53 |  | -    "block-no-empty": null, | 
| 54 |  | -    "unit-whitelist": ["em", "rem", "s"] | 
|  | 43 | +    "scss/dollar-variable-pattern": null | 
| 55 | 44 |   } | 
| 56 | 45 | } | 
| 57 | 46 | ``` | 
|  | 
0 commit comments