.. | ||
CHANGELOG.md | ||
index.js | ||
LICENSE | ||
package.json | ||
README.md |
stylelint-config-recommended
The recommended shareable config for stylelint.
It turns on all the possible errors rules within stylelint.
Use it as is or as a foundation for your own config.
Installation
npm install stylelint-config-recommended --save-dev
Usage
If you've installed stylelint-config-recommended
locally within your project, just set your stylelint
config to:
{
"extends": "stylelint-config-recommended"
}
If you've globally installed stylelint-config-recommended
using the -g
flag, then you'll need to use the absolute path to stylelint-config-recommended
in your config e.g.
{
"extends": "/absolute/path/to/stylelint-config-recommended"
}
Since stylelint 9.7.0, you can simply use the globally installed configuration name instead of the absolute path:
{
"extends": "stylelint-config-recommended"
}
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:
{
"extends": "stylelint-config-recommended",
"rules": {
"at-rule-no-unknown": [
true,
{
"ignoreAtRules": ["extends"]
}
],
"block-no-empty": null,
"unit-allowed-list": ["em", "rem", "s"]
}
}