| 1 | # stylelint
|
| 2 |
|
| 3 | [](https://www.npmjs.org/package/stylelint) [](https://github.com/stylelint/stylelint/actions) [](https://npmcharts.com/compare/stylelint?minimal=true)
|
| 4 |
|
| 5 | A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.
|
| 6 |
|
| 7 | ## Features
|
| 8 |
|
| 9 | It's mighty as it:
|
| 10 |
|
| 11 | - understands the **latest CSS syntax** including custom properties and level 4 selectors
|
| 12 | - extracts **embedded styles** from HTML, markdown and CSS-in-JS object & template literals
|
| 13 | - parses **CSS-like syntaxes** like SCSS, Sass, Less and SugarSS
|
| 14 | - has over **170 built-in rules** to catch errors, apply limits and enforce stylistic conventions
|
| 15 | - supports **plugins** so you can create your own rules or make use of plugins written by the community
|
| 16 | - automatically **fixes** the majority of stylistic violations
|
| 17 | - is **well tested** with over 15000 unit tests
|
| 18 | - supports **shareable configs** that you can extend or create
|
| 19 | - is **unopinionated** so that you can customize it to your exact needs
|
| 20 | - has a **growing community** and is used by [Facebook](https://code.facebook.com/posts/879890885467584/improving-css-quality-at-facebook-and-beyond/), [GitHub](https://github.com/primer/stylelint-config-primer) and [WordPress](https://github.com/ntwb/stylelint-config-wordpress/)
|
| 21 |
|
| 22 | ## Example output
|
| 23 |
|
| 24 | 
|
| 25 |
|
| 26 | ## Getting started
|
| 27 |
|
| 28 | You'll find steps to [get started in our User guide](docs/user-guide/get-started.md).
|
| 29 |
|
| 30 | ## Contributors
|
| 31 |
|
| 32 | Without the contributions from [all these fantastic people](https://github.com/stylelint/stylelint/graphs/contributors), stylelint would not exist. [Become a contributor](CONTRIBUTING.md).
|
| 33 |
|
| 34 | ## Backers
|
| 35 |
|
| 36 | <a href="https://opencollective.com/stylelint#backers" target="_blank"><img src="https://opencollective.com/stylelint/backers.svg?width=890"></a>
|
| 37 |
|
| 38 | Thank you to all our backers! [Become a backer](https://opencollective.com/stylelint#backer).
|
| 39 |
|
| 40 | ## Sponsors
|
| 41 |
|
| 42 | <a href="https://opencollective.com/stylelint/sponsor/0/website" target="_blank"><img src="https://opencollective.com/stylelint/sponsor/0/avatar.svg"></a>
|
| 43 |
|
| 44 | Support this project to show your logo here with a link to your website. [Become a sponsor](https://opencollective.com/stylelint#sponsor).
|
| 45 |
|
| 46 | ## License
|
| 47 |
|
| 48 | [The MIT License](https://raw.githubusercontent.com/stylelint/stylelint/master/LICENSE).
|