scr

stylelint-config-recommended-scss

The recommended shareable SCSS config for stylelint

Showing:

Popularity

Downloads/wk

281K

GitHub Stars

149

Maintenance

Last Commit

2mos ago

Contributors

7

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

stylelint-config-recommended-scss

npm version Build Status contributions welcome Downloads per month Greenkeeper badge

The recommended shareable SCSS 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

First, install stylelint-scss and stylelint, if you haven't done so yet via npm:

npm install stylelint stylelint-scss --save-dev

and then you can install the config:

npm install stylelint-config-recommended-scss --save-dev

Usage

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

{
  "extends": "stylelint-config-recommended-scss"
}

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

{
  "extends": "/absolute/path/to/stylelint-config-recommended-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 block-no-empty rule, and add the unit-whitelist rule:

{
  "extends": "stylelint-config-recommended-scss",
  "rules": {
    "block-no-empty": null,
    "unit-whitelist": ["em", "rem", "s"]
  }
}

Changelog

License

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100