49 lines
2.5 KiB
Markdown
49 lines
2.5 KiB
Markdown
|
# stylelint
|
||
|
|
|
||
|
|
[](https://www.npmjs.org/package/stylelint) [](https://github.com/stylelint/stylelint/actions) [](https://npmcharts.com/compare/stylelint?minimal=true)
|
||
|
|
|
||
|
|
A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
It's mighty as it:
|
||
|
|
|
||
|
|
- understands the **latest CSS syntax** including custom properties and level 4 selectors
|
||
|
|
- extracts **embedded styles** from HTML, markdown and CSS-in-JS object & template literals
|
||
|
|
- parses **CSS-like syntaxes** like SCSS, Sass, Less and SugarSS
|
||
|
|
- has over **170 built-in rules** to catch errors, apply limits and enforce stylistic conventions
|
||
|
|
- supports **plugins** so you can create your own rules or make use of plugins written by the community
|
||
|
|
- automatically **fixes** the majority of stylistic violations
|
||
|
|
- is **well tested** with over 15000 unit tests
|
||
|
|
- supports **shareable configs** that you can extend or create
|
||
|
|
- is **unopinionated** so that you can customize it to your exact needs
|
||
|
|
- 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/WordPress-Coding-Standards/stylelint-config-wordpress)
|
||
|
|
|
||
|
|
## Example output
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Getting started
|
||
|
|
|
||
|
|
You'll find steps to [get started in our User guide](docs/user-guide/get-started.md).
|
||
|
|
|
||
|
|
## Contributors
|
||
|
|
|
||
|
|
Without the contributions from [all these fantastic people](https://github.com/stylelint/stylelint/graphs/contributors), stylelint would not exist. [Become a contributor](CONTRIBUTING.md).
|
||
|
|
|
||
|
|
## Backers
|
||
|
|
|
||
|
|
<a href="https://opencollective.com/stylelint#backers" target="_blank"><img src="https://opencollective.com/stylelint/backers.svg?width=890"></a>
|
||
|
|
|
||
|
|
Thank you to all our backers! [Become a backer](https://opencollective.com/stylelint#backer).
|
||
|
|
|
||
|
|
## Sponsors
|
||
|
|
|
||
|
|
<a href="https://opencollective.com/stylelint/sponsor/0/website" target="_blank"><img src="https://opencollective.com/stylelint/sponsor/0/avatar.svg"></a>
|
||
|
|
|
||
|
|
Support this project to show your logo here with a link to your website. [Become a sponsor](https://opencollective.com/stylelint#sponsor).
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
[The MIT License](https://raw.githubusercontent.com/stylelint/stylelint/master/LICENSE).
|