# stylelint
[](https://www.npmjs.org/package/stylelint) [](https://travis-ci.org/stylelint/stylelint) [](https://ci.appveyor.com/project/stylelint/stylelint/branch/master) [](https://npmcharts.com/compare/stylelint?minimal=true) [](#backers) [](#sponsors)
A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.
## Features
It's mighty because 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** some violations (*experimental feature*)
- is **well tested** with over 10000 unit tests
- supports **shareable configs** that you can extend or create your own of
- is **unopinionated** so you can tailor the linter 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/ntwb/stylelint-config-wordpress/)
## Example output
## Getting started
It's easy to get started.
First, decide how you want to use stylelint:
- [on the command line](docs/user-guide/cli.md)
- [in your text editor](docs/user-guide/complementary-tools.md#editor-plugins), for example in VS Code
- [in for your build tool](docs/user-guide/complementary-tools.md#build-tool-plugins), for example in webpack
- [via the Node.js API](docs/user-guide/node-api.md)
- [as a PostCSS plugin](docs/user-guide/postcss-plugin.md)
Then create your [configuration object](docs/user-guide/configuration.md). You can either extend a shared configuration or craft your own.
### Extend a shared configuration
This is the quickest way to get started. We suggest you extend either:
- [`stylelint-config-recommended`](https://github.com/stylelint/stylelint-config-recommended)
- [`stylelint-config-standard`](https://github.com/stylelint/stylelint-config-standard)
The recommended config turns on just the [possible error](docs/user-guide/rules.md#possible-errors) rules. The standard config extends it by turning on 60 [stylistic rules](docs/user-guide/rules.md#stylistic-issues). We suggest you extend the:
- recommended config if you use a pretty printer like [prettier](https://prettier.io/)
- standard config if you want stylelint to enforce stylistic conventions
You may want to add rules to your config that [limit language features](docs/user-guide/rules.md#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`](https://github.com/kristerkari/stylelint-config-recommended-scss) instead.*
### Craft your own config
Alternatively, you can [learn about the rules](docs/user-guide/about-rules.md) and then either:
- start small and add only [the rules](docs/user-guide/rules.md) you want to turn on
- copy, paste and adapt [this example configuration](docs/user-guide/example-config.md) which lists all of the rules and their primary options
## Guides
You'll find detailed information on customising stylelint in our guides:
- [user guide](docs/user-guide.md) - how to use and configure stylelint
- [developer guide](docs/developer-guide.md) - how to develop for stylelint
## Need help?
Read our [FAQ](docs/user-guide/faq.md) first.
If the answer to your problem isn't there, then post it on [stackoverflow](https://stackoverflow.com/questions/tagged/stylelint).
Create a [new issue](https://github.com/stylelint/stylelint/issues/new/choose) if:
- you think you've found a bug
- you have a feature request
If you're upgrading, read our [CHANGELOG](CHANGELOG.md) to learn what changes to expect in the latest version.
## Help out
To help out, you can:
- get involved in any open [issue](https://github.com/stylelint/stylelint/issues) or [pull request](https://github.com/stylelint/stylelint/pulls)
- create, enhance and debug rules using our [working on rules](docs/developer-guide/rules.md) guide
- improve the [documentation](docs/)
- add new tests to *absolutely anything*
- improve the [performance of rules](docs/developer-guide/rules.md#improving-the-performance-of-a-rule)
- open [new issues](https://github.com/stylelint/stylelint/issues/new/choose) about your ideas for making stylelint better
- open [a pull request](https://github.com/stylelint/stylelint/compare) to show us how your idea works
- create or contribute to [ecosystem tools](docs/user-guide/complementary-tools.md), for example the plugin for [VS Code](https://github.com/shinnn/vscode-stylelint)
Our [VISION document](VISION.md) guides our work.
## Semantic Versioning Policy
We have a [semantic versioning policy](docs/user-guide/semantic-versioning-policy.md). 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.
## License
[The MIT License](https://raw.githubusercontent.com/stylelint/stylelint/master/LICENSE).
## Contributors
This project exists thanks to all these people. [Contribute](CONTRIBUTING.md).
## Backers
Thank you to all our backers! [Become a backer](https://opencollective.com/stylelint#backer).
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor](https://opencollective.com/stylelint#sponsor).
