README.md

stylelint-config-scss

A shareable stylelint config for SCSS used at Tonik

Installation

npm install @tonik/stylelint-config-scss --save-dev

Usage

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

{
  "extends": "@tonik/stylelint-config-scss"
}

If you've globally installed stylelint-config-scss using the -g flag, then you'll need to use the absolute path to stylelint-config-scss in your config e.g.

{
  "extends": "/absolute/path/to/@tonik/stylelint-config-scss"
}

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": "@tonik/stylelint-config-scss",
  "rules": {
    "at-rule-no-unknown": [true, {
      "ignoreAtRules": [
        "extends"
      ]
    }],
    "block-no-empty": null,
    "unit-whitelist": ["em", "rem", "s"]
  }
}

License

Licensed under the MIT license.