sort-array-includes

Enforce sorted array values if the includes method is immediately called after the array is created.

By keeping arrays sorted, developers can quickly scan and verify the values, making the code more predictable and reducing the likelihood of errors. This practice simplifies debugging and enhances the overall clarity of the codebase.

Try it out

Options

This rule accepts an options object with the following properties:

type

_{default: 'alphabetical'}

Specifies the sorting method.

'alphabetical' — Sort items alphabetically (e.g., “a” < “b” < “c”).
'natural' — Sort items in a natural order (e.g., “item2” < “item10”).
'line-length' — Sort items by the length of the code line (shorter lines first).

order

_{default: 'asc'}

Determines whether the sorted items should be in ascending or descending order.

'asc' — Sort items in ascending order (A to Z, 1 to 9).
'desc' — Sort items in descending order (Z to A, 9 to 1).

ignoreCase

_{default: true}

Controls whether sorting should be case-sensitive or not.

true — Ignore case when sorting alphabetically or naturally (e.g., “A” and “a” are the same).
false — Consider case when sorting (e.g., “A” comes before “a”).

specialCharacters

_{default: keep}

Controls whether special characters should be trimmed, removed or kept before sorting.

'keep' — Keep special characters when sorting (e.g., “_a” comes before “a”).
'trim' — Trim special characters when sorting alphabetically or naturally (e.g., “_a” and “a” are the same).
'remove' — Remove special characters when sorting (e.g., “/a/b” and “ab” are the same).

groupKind

_{default: 'literals-first'}

Allows you to group array elements by their kind, determining whether spread values should come before or after literal values.

mixed — Do not group array elements by their kind; spread values are sorted together with literal values.
literals-first — Group all literal values before spread values.
spreads-first — Group all spread values before literal values.

partitionByComment

_{default: false}

Allows you to use comments to separate the members of arrays into logical groups. This can help in organizing and maintaining large enums by creating partitions within the enum based on comments.

true — All comments will be treated as delimiters, creating partitions.
false — Comments will not be used as delimiters.
string — A glob pattern to specify which comments should act as delimiters.
string[] — A list of glob patterns to specify which comments should act as delimiters.

partitionByNewLine

_{default: false}

When true, the rule will not sort the members of an array if there is an empty line between them. This can be useful for keeping logically separated groups of members in their defined order.

if ([
     // Group 1
    'Drone',
    'Keyboard',
    'Mouse',
    'Smartphone',

    // Group 2
    'Laptop',
    'Monitor',
    'Smartwatch',
    'Tablet',

    // Group 3
    'Headphones',
    'Router',
  ].includes(product.name)) {
    return 'Electronics'
  }

Each group of elements (separated by empty lines) is treated independently, and the order within each group is preserved.

matcher

_{default: 'minimatch'}

Determines the matcher used for patterns in the partitionByComment option.

'minimatch' — Use the minimatch library for pattern matching.
'regex' — Use regular expressions for pattern matching.

Usage

Version

This rule was introduced in v0.5.0.