The recommended shareable config for stylelint
Switch branches/tags
Clone or download
Latest commit 6bc958b Aug 19, 2018

README.md

stylelint-config-recommended

NPM version Build Status Build status

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"
}

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-whitelist rule:

{
  "extends": "stylelint-config-recommended",
  "rules": {
    "at-rule-no-unknown": [ true, {
      "ignoreAtRules": [
        "extends"
      ]
    }],
    "block-no-empty": null,
    "unit-whitelist": ["em", "rem", "s"]
  }
}

Changelog

License