51 lines
1.7 KiB
Markdown
51 lines
1.7 KiB
Markdown
|
# stylelint-config-standard-scss
|
||
|
|
|
||
|
|
[](https://www.npmjs.com/package/stylelint-config-standard-scss)
|
||
|
|
[](https://github.com/stylelint-scss/stylelint-config-standard-scss/actions/workflows/test.yml?query=workflow%3ATests)
|
||
|
|
[](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
|
||
|
|
[](https://npmcharts.com/compare/stylelint-config-standard-scss)
|
||
|
|
|
||
|
|
> The standard shareable SCSS config for Stylelint.
|
||
|
|
|
||
|
|
This config:
|
||
|
|
|
||
|
|
- extends the [`stylelint-config-standard` shared config](https://github.com/stylelint/stylelint-config-standard) and configures its rules for SCSS
|
||
|
|
- extends the [`stylelint-config-recommended-scss` shared config](https://github.com/stylelint-scss/stylelint-config-recommended-scss)
|
||
|
|
|
||
|
|
To see the rules that this config uses, please read the [config itself](/index.js).
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```shell
|
||
|
|
npm install --save-dev stylelint-config-standard-scss
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Set your `stylelint` config to:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"extends": "stylelint-config-standard-scss"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Extending the config
|
||
|
|
|
||
|
|
Simply add a `"rules"` key to your config, then add your overrides and additions there.
|
||
|
|
|
||
|
|
For example, to turn off the `scss/dollar-variable-pattern` rule:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"extends": "stylelint-config-standard-scss",
|
||
|
|
"rules": {
|
||
|
|
"scss/dollar-variable-pattern": null
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## [Changelog](CHANGELOG.md)
|
||
|
|
|
||
|
|
## [License](LICENSE)
|