eslint-plugin-sort-keys-custom-order-fix
Fork of eslint rule that sorts keys in objects (https://eslint.org/docs/rules/sort-keys) with a custom order and autofix enabled.
Installation
You'll first need to install ESLint:
$ npm i eslint --save-dev
Next, install eslint-plugin-sort-keys-custom-order-fix:
$ npm i eslint-plugin-sort-keys-custom-order-fix --save-dev
Note: If you installed ESLint globally (using the -g flag), then you must also install eslint-plugin-sort-keys-custom-order-fix globally.
Usage
Add sort-keys-custom-order-fix to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:
{
"plugins": ["sort-keys-custom-order-fix"]
}
Then add sort-keys-custom-order-fix rule under the rules section:
{
"rules": {
"sort-keys-custom-order-fix/sort-keys-custom-order-fix": "warn"
}
}
Example using custom order:
{
"rules": {
"sort-keys-custom-order-fix/sort-keys-custom-order-fix": ["warn", "custom", { "order": ["a", "c", "b"] }]
}
}
Example using custom order + orderBy:
{
"rules": {
"sort-keys-custom-order-fix/sort-keys-custom-order-fix": [
"warn",
"custom",
{ "orderBy": "asc", "order": ["a", "c", "b"] }
]
}
}
Often it makes sense to enable sort-keys-custom-order-fix only for certain files/directories. For cases like that, use override key of eslint config:
{
"rules": {
// ...
},
"overrides": [
{
"files": ["src/alphabetical.js", "bin/*.js", "lib/*.js"],
"rules": {
"sort-keys-custom-order-fix/sort-keys-custom-order-fix": "warn"
}
}
]
}
Rule configuration
For available config options, see official sort-keys reference. All options supported by sort-keys, besides minKeys, are supported by sort-keys-custom-order-fix.
