eslint-plugin-sort-keys-custom-order

This plugin enforces alphabetically sorting keys in objects and typescript types with auto-fix. You can add a list of priority sorted keys for custom sorting (ex: if you want "id" to be the first property).

Installation

You'll first need to install ESLint:

$ npm install -D eslint

Next, install eslint-plugin-sort-keys-custom-order:

$ npm install -D eslint-plugin-sort-keys-custom-order

Usage

Add sort-keys-custom-order to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

1// eslint.config.js
2import sortKeysCustomOrder from "eslint-plugin-sort-keys-custom-order";
3
4export default [{
5    /* ... */
6    plugins: {
7        "sort-keys-custom-order": sortKeysCustomOrder
8    }
9    /* ... */
10}]

Then configure the rules you want to use under the rules section.

1// .eslintrc.js
2export default [{
3    /* ... */
4    "rules": {
5        // For JS objects sorting
6        "sort-keys-custom-order/object-keys": [
7            "error", { "orderedKeys": ["id", "name", "title"] }
8        ],
9        // For TS types sorting
10        "sort-keys-custom-order/type-keys": [
11            "error", { "orderedKeys": ["id", "name", "title"] }
12        ]
13    }
14    /* ... */
15}]

Or you can use the recommended configuration:

1// eslint.config.js
2import sortKeysCustomOrder from "eslint-plugin-sort-keys-custom-order";
3
4export default [
5    /* ... */
6    sortKeysCustomOrder.configs["flat/recommended"],
7    /* ... */
8]

Configuration

orderedKeys: Array<string> : You can pass an array of ordered keys to the rule configuration. The rule will sort the keys in the order you provided.

sorting: "asc" | "desc" | "none" : You can pass the sorting order for the keys not in orderedKeys. Default is "asc".

Example:

1{
2    "sort-keys-custom-order/object-keys": [
3        "error", 
4        { 
5            "orderedKeys": ["id","name","title"],
6            "sorting": "asc"
7        }
8    ]
9}

Supported Rules

sort-keys-custom-order/object-keys

Allow you to sort properties inside JS objects

sort-keys-custom-order/type-keys

Allow you to sort properties inside TS types

sort-keys-custom-order/import-object-keys

Allow you to sort properties inside JS import objects

sort-keys-custom-order/export-object-keys

Allow you to sort properties inside JS export objects

Example

1// Bad
2const module = {
3    isValid: true,
4    id: 1234,
5    create: () => { doThing() },
6    isRunning: false,
7    name: "test",
8    url: "https://google.com",
9    isAvailable: true
10}

1// Good
2const module = {
3    id: 1234,
4    name: "test",
5    create: () => { doThing() },
6    isAvailable: true,
7    isRunning: false,
8    isValid: true,
9    url: "https://google.com"
10}