eslint-plugin-sort-keys-plus weekly downloads statistics

eslint-plugin-sort-keys-plus

Fork of eslint rule that sorts keys in objects (https://eslint.org/docs/rules/sort-keys) with autofix enabled

Installation

You'll first need to install ESLint:

Next, install eslint-plugin-sort-keys-plus:

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-sort-keys-plus globally.

Usage

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

Then add sort-keys-plus rule under the rules section.

Often it makes sense to enable sort-keys-plus only for certain files/directories. For cases like that, use override key of eslint config:

In some cases, there should be a specific order for some properties of an object, such as with mongodb aggregations. For that, use the override key of the configuration:

Rule configuration

For available config options, see official sort-keys reference. All options supported by sort-keys are supported by sort-keys-plus.

Additional properties that can be set in the 2nd option object supported are as follows:

• ignoreSingleline - if true, this rule is ignored on single line objects. Default is false. • allCaps handling for ALL_CAPS properties • ignore no rules for all caps • first all caps properties must be first • last all caps properties must be last • shorthand handling for shorthand properties • ignore no rules for shorthands • first shorthand properties must be first • last shrothand properties must be last

shorthand is checked after allCaps, so ALL_CAPS will be before shorthand when both are 'first'.

• overrides allows custom orders for specific sets of keys, or sub-objects with a specific parent key. See below for configuration.

ignoreSingleLine

Examples of incorrect code for the {ignoreSingleLine: true} option:

Examples of correct code for the {ignoreSingleLine: true} option:

allCaps

Examples of incorrect code for the {allCaps: 'first'} option:

Examples of correct code for the {allCaps: 'first'} option:

shorthand

Examples of incorrect code for the {shorthand: 'first'} option:

Examples of correct code for the {shorthand: 'first'} option:

overrides

Configuration:

• order define the property keys that should be ordered • ignore allow any property key order • esquery define an esquery filter which must match the target object for this override to apply • properties define parent property key for this rule. Equivalent to esquery: 'Property:is([key.name=property1], [key.name=property2]) > .value'; • If neither esquery or properties are not provided, the override will apply to all objects with a subset of the keys in order • message optional custom message when the rule is violated

Examples of incorrect code for the {overrides: [{order: ['b', 'a', 'd']}]} option:

Examples of correct code for the {overrides: [{order: ['b', 'a', 'd']}]} option:

Examples of incorrect code for the {overrides: [{esquery: 'Property[key.name=a] > .value', order: ['b', 'a', 'd']}]} or {overrides: [{properties: ['a'], order: ['b', 'a', 'd']}]} option:

Examples of correct code for the {overrides: [{esquery: 'Property[key.name=a] > .value', order: ['b', 'a', 'd']}]} or {overrides: [{properties: ['a'], order: ['b', 'a', 'd']}]} option: