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:

1{
2  "plugins": ["sort-keys-custom-order-fix"]
3}

Then add sort-keys-custom-order-fix rule under the rules section:

1{
2  "rules": {
3    "sort-keys-custom-order-fix/sort-keys-custom-order-fix": "warn"
4  }
5}

Example using custom order:

1{
2  "rules": {
3    "sort-keys-custom-order-fix/sort-keys-custom-order-fix": ["warn", "custom", { "order": ["a", "c", "b"] }]
4  }
5}

Example using custom order + orderBy:

1{
2  "rules": {
3    "sort-keys-custom-order-fix/sort-keys-custom-order-fix": [
4      "warn",
5      "custom",
6      { "orderBy": "asc", "order": ["a", "c", "b"] }
7    ]
8  }
9}

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:

1{
2  "rules": {
3    // ...
4  },
5  "overrides": [
6    {
7      "files": ["src/alphabetical.js", "bin/*.js", "lib/*.js"],
8      "rules": {
9        "sort-keys-custom-order-fix/sort-keys-custom-order-fix": "warn"
10      }
11    }
12  ]
13}

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.