| 1 | # Stylelint Config
|
| 2 | Standard configuration for [Stylelint](https://stylelint.io).
|
| 3 |
|
| 4 | **Why?** — We use Stylelint for quality control of our SCSS code.
|
| 5 | The standard Stylelint configurations ensure that we use the same rules across
|
| 6 | all our projects.
|
| 7 |
|
| 8 | At the moment a single Stylelint configuration is provided by the package:
|
| 9 |
|
| 10 | - [**`config/stylelint/default`**](#default) — Default Stylelint
|
| 11 | configuration.
|
| 12 |
|
| 13 | Under the hood it matches the
|
| 14 | [standard Stylelint config](https://github.com/stylelint/stylelint-config-standard)
|
| 15 | with a few extra options to ignore some valid rules and selectors not known to
|
| 16 | Stylelint: `@content`, `@extend`, `@for`, `@include`, `@mixin`, `:global`.
|
| 17 |
|
| 18 | To use it, just create the following `.stylelintrc`:
|
| 19 | ```json
|
| 20 | {
|
| 21 | "extends": "./node_modules/topcoder-react-utils/config/stylelint/default.json"
|
| 22 | }
|
| 23 | ```
|
| 24 |
|
| 25 | `.stylelintrc` allows you to further modify the standard configuration, but it
|
| 26 | is not recommended without a very good and special reason.
|