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:trueControls 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”).
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.spread-first— Group all spread values before literal values.
Usage
Version
This rule was introduced in v0.5.0.