Stylelint Stylistic

[![License: MIT][license-image]][license-url]
[![Changelog][changelog-image]][changelog-url]
[![NPM version][npm-image]][npm-url]
[![Test Status][test-image]][test-url]

An updatable collection of stylistic rules for Stylelint (in plugin form).

About and purpose

Stylelint has removed 76 rules that enforce stylistic conventions. This project returns these rules to keep styles consistent with your codeguide. In addition, new rules may be added in the future.

Installation and usage

Add @stylistic/stylelint-plugin and stylelint itself to your project:

``shell
npm add -D stylelint @stylistic/stylelint-plugin
`

Create the .stylelintrc config file (or open the existing one), add @stylistic/stylelint-plugin to the plugins array and the rules you need to the rules list. All rules from @stylistic/stylelint-plugin need to be namespaced with @stylistic/:

`json
{
"plugins": [
"@stylistic/stylelint-plugin"
],
"rules": {
// syntax rules from stylelint:
"color-function-notation": "modern",
"selector-max-compound-selectors": 2,

// stylistic rules from @stylistic/stylelint-plugin:
"@stylistic/color-hex-case": "lower",
"@stylistic/number-leading-zero": "always",
"@stylistic/unit-case": "lower"
}
}
`

To avoid listing a lot of rules, you can use @stylistic/stylelint-config, which returns the stylistic rules removed in stylelint-config-standard and stylelint-config-recommended`.

---

Please refer to Stylelint docs for detailed info on using this linter.

Need more?

ESLint deprecates stylistic rules, too. But you can continue to use them thanks to ESLint Stylistic.

Important documents

- Rule list
- Contributing

[license-url]: https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/LICENSE.md
[license-image]: https://img.shields.io/badge/License-MIT-limegreen.svg

[changelog-url]: https://github.com/stylelint-stylistic/stylelint-stylistic/blob/main/CHANGELOG.md
[changelog-image]: https://img.shields.io/badge/Change-log-limegreen

[npm-url]: https://npmjs.org/package/@stylistic/stylelint-plugin
[npm-image]: https://badge.fury.io/js/@stylistic%2Fstylelint-plugin.svg

[test-url]: https://github.com/stylelint-stylistic/stylelint-stylistic/actions
[test-image]: https://github.com/stylelint-stylistic/stylelint-stylistic/actions/workflows/test.yaml/badge.svg?branch=main