@udyux/stylelint-order
v4.0.2
Published
[fork] A collection of order related linting rules for stylelint.
Downloads
203
Maintainers
Readme
[forked] stylelint-order
A plugin pack of order-related linting rules for stylelint. Every rule supports autofixing (stylelint --fix
).
Installation
- If you haven't, install stylelint:
npm install stylelint --save-dev
- Install
stylelint-order
:
npm install stylelint-order --save-dev
Usage
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
.
{
"plugins": ["stylelint-order"],
"rules": {
"order/order": ["custom-properties", "declarations"],
"order/properties-alphabetical-order": true
}
}
Rules
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.
Autofixing
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:
"rules": {
"order/order": [
["custom-properties", "declarations"],
{
"disableFix": true
}
]
}
Less may work but isn't officially supported.
Thanks
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.