stylelint-config-styled-components

The shareable stylelint config for stylelint-processor-styled-components

Why

When using stylelint-processor-styled-components a couple of stylelint rules throw errors that you cannot prevent. Like 'no-empty-source' or 'no-missing-end-of-source-newline'.

This shareable config will automatically disable rules that cause unresolvable conflicts. Besides those rules vendor prefixed properties and values will throw an error since styled-components automatically generates vendor prefixes for your css. Note that if you want to change any of these rules you can always override them in your stylelint config.

Installation

npm install stylelint-config-styled-components --save-dev

Usage

After installing, add this config to your stylelint config like so:

{
  "extends": "stylelint-config-styled-components"
}

If you're extending multiple shareable configs, put this config as the last so it overrides the relevant rules in all previous configs:

{
  "extends": [
    "stylelint-config-standard",
    "stylelint-config-styled-components"
  ]
}

See also https://stylelint.io/user-guide/configuration for documentation on the various ways stylelint can be configured.

License

MIT