A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.
It's mighty because it:
It's easy to get started.
First, decide how you want to use stylelint:
Then create your configuration object. You can either extend a shared configuration or craft your own.
This is the quickest way to get started. We suggest you extend either:
The recommended config turns on just the possible error rules. The standard config extends it by turning on 60 stylistic rules. We suggest you extend the:
You may want to add rules to your config that limit language features as these will be specific to your team and/or project.
If you use language extensions, for example @if
and @extends
, you can use a community config like stylelint-config-recommended-scss
instead.
Alternatively, you can learn about the rules and then either:
You'll find detailed information on customising stylelint in our guides:
Read our FAQ first.
If the answer to your problem isn't there, then post it on stackoverflow.
Create a new issue if:
If you're upgrading, read our CHANGELOG to learn what changes to expect in the latest version.
To help out, you can:
Our VISION document guides our work.
We have a semantic versioning policy. Any minor update may report more errors than the previous release. As such, we recommend using the tilde (~
) in package.json
e.g. "stylelint": "~7.2.0"
to guarantee the results of your builds.
This project exists thanks to all these people. Contribute.
Thank you to all our backers! Become a backer.
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor.