[fork] A collection of order related linting rules for stylelint.
npm install @udyux/stylelint-order[![npm version][npm-version-img]][npm] [![npm downloads last month][npm-downloads-img]][npm]
A plugin pack of order-related linting rules for [stylelint]. Every rule supports autofixing (stylelint --fix).
1. If you haven't, install [stylelint]:
```
npm install stylelint --save-dev
2. Install stylelint-order:
``
npm install stylelint-order --save-dev
Add stylelint-order to your stylelint config plugins array, then add rules you need to the rules list. All rules from stylelint-order need to be namespaced with order.
`json`
{
"plugins": ["stylelint-order"],
"rules": {
"order/order": ["custom-properties", "declarations"],
"order/properties-alphabetical-order": true
}
}
- order: Specify the order of content within declaration blocks.
- properties-order: Specify the order of properties within declaration blocks.
- properties-alphabetical-order: Specify the alphabetical order of properties within declaration blocks.
Every rule supports autofixing with stylelint --fix. [postcss-sorting] is used internally for order autofixing.
Automatic sorting has some limitations that are described for every rule, if any. Please, take a look at how comments are handled by postcss-sorting.
CSS-in-JS styles with template interpolation could be ignored by autofixing to avoid style corruption.
Autofixing is enabled by default if it's enabled in stylelint's configuration file. It can be disabled on a per rule basis using the secondary option disableFix: true. Here's an example:
`json`
"rules": {
"order/order": [
["custom-properties", "declarations"],
{
"disableFix": true
}
]
}
Less may work but isn't officially supported.
properties-order and properties-alphabetical-order code and README are based on the declaration-block-properties-order` rule which was a core rule prior to stylelint 8.0.0.
[npm-version-img]: https://img.shields.io/npm/v/stylelint-order.svg
[npm-downloads-img]: https://img.shields.io/npm/dm/stylelint-order.svg
[npm]: https://www.npmjs.com/package/stylelint-order
[stylelint]: https://stylelint.io/
[postcss-sorting]: https://github.com/hudochenkov/postcss-sorting