1 | # Stylelint
|
2 |
|
3 | [![NPM version](https://img.shields.io/npm/v/stylelint.svg)](https://www.npmjs.org/package/stylelint) [![Build Status](https://github.com/stylelint/stylelint/workflows/CI/badge.svg)](https://github.com/stylelint/stylelint/actions) [![NPM Downloads](https://img.shields.io/npm/dm/stylelint.svg)](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 **modern** CSS syntax and features
|
12 | - has over **170 built-in rules** to catch errors and enforce conventions
|
13 | - supports **plugins** so you can create your own rules
|
14 | - automatically **fixes** the majority of stylistic problems
|
15 | - is **well tested** with over 15000 unit tests
|
16 | - supports **shareable configs** that you can extend or create
|
17 | - is **unopinionated** so that you can customize it to your exact needs
|
18 | - has a **growing community** and is used by Google, GitHub and WordPress
|
19 |
|
20 | And can be extended to:
|
21 |
|
22 | - parse **CSS-like syntaxes** like SCSS, Sass, Less and SugarSS
|
23 | - extract **embedded styles** from HTML, Markdown and CSS-in-JS object & template literals
|
24 |
|
25 | ## Example output
|
26 |
|
27 | ![Example](https://github.com/stylelint/stylelint/raw/master/example.png?raw=true)
|
28 |
|
29 | ## Guides
|
30 |
|
31 | - User guide
|
32 | - [Getting started](docs/user-guide/get-started.md)
|
33 | - [Configuration](docs/user-guide/configure.md)
|
34 | - Rules
|
35 | - [List of rules](docs/user-guide/rules/list.md)
|
36 | - [About rules](docs/user-guide/rules/about.md)
|
37 | - [Combining rules](docs/user-guide/rules/combine.md)
|
38 | - [Using regex in rules](docs/user-guide/rules/regex.md)
|
39 | - Usage
|
40 | - [CLI](docs/user-guide/usage/cli.md)
|
41 | - [Node.js API](docs/user-guide/usage/node-api.md)
|
42 | - [PostCSS plugin](docs/user-guide/usage/postcss-plugin.md)
|
43 | - [Shared options](docs/user-guide/usage/options.md)
|
44 | - Integrations
|
45 | - [Editor integrations](docs/user-guide/integrations/editor.md)
|
46 | - [Task runner integrations](docs/user-guide/integrations/task-runner.md)
|
47 | - [Other integrations](docs/user-guide/integrations/other.md)
|
48 | - [Ignoring code](docs/user-guide/ignore-code.md)
|
49 | - [Errors & warnings](docs/user-guide/errors.md)
|
50 | - Developer guide
|
51 | - [Working on rules](docs/developer-guide/rules.md)
|
52 | - [Writing plugins](docs/developer-guide/plugins.md)
|
53 | - [Writing custom syntaxes](docs/developer-guide/syntaxes.md)
|
54 | - [Writing custom formatters](docs/developer-guide/formatters.md)
|
55 | - [Writing system tests](docs/developer-guide/system-tests.md)
|
56 | - [Writing processors](docs/developer-guide/processors.md)
|
57 | - Migration guide
|
58 | - [Migrating to 14.0.0](docs/migration-guide/to-14.md)
|
59 | - Maintainer guide
|
60 | - [Managing issues](docs/maintainer-guide/issues.md)
|
61 | - [Managing pull requests](docs/maintainer-guide/pull-requests.md)
|
62 | - [Performing releases](docs/maintainer-guide/releases.md)
|
63 | - About
|
64 | - [Vision](docs/about/vision.md)
|
65 | - [Linting](docs/about/linting.md)
|
66 | - [Semantic versioning](docs/about/semantic-versioning.md)
|
67 |
|
68 | ## Contributors
|
69 |
|
70 | Stylelint is maintained by volunteers. Without the code contributions from [all these fantastic people](https://github.com/stylelint/stylelint/graphs/contributors), Stylelint would not exist. [Become a contributor](CONTRIBUTING.md).
|
71 |
|
72 | ### Sponsors
|
73 |
|
74 | <object data="https://opencollective.com/stylelint/sponsors.svg?width=420&button=false" type="image/svg+xml">
|
75 | <img src="https://opencollective.com/stylelint/sponsors.svg?width=840&button=false" />
|
76 | </object>
|
77 |
|
78 | Thank you to all our sponsors! [Become a sponsor](https://opencollective.com/stylelint).
|
79 |
|
80 | ### Backers
|
81 |
|
82 | <object data="https://opencollective.com/stylelint/backers.svg?width=420&avatarHeight=48&button=false" type="image/svg+xml">
|
83 | <img src="https://opencollective.com/stylelint/backers.svg?width=840&avatarHeight=48&button=false" />
|
84 | </object>
|
85 |
|
86 | Thank you to all our backers! [Become a backer](https://opencollective.com/stylelint).
|
87 |
|
88 | ### Website hosting
|
89 |
|
90 | <a href="https://www.netlify.com"><img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" alt="Deploys by Netlify" /></a>
|
91 |
|
92 | ## License
|
93 |
|
94 | [The MIT License](https://raw.githubusercontent.com/stylelint/stylelint/master/LICENSE).
|