sort-switch-case
Enforce sorted switch case statements.
Switch statements with numerous cases can quickly become cumbersome and hard to navigate. With this rule, you can easily locate specific cases and ensure that your codebase adheres to a predictable and standardized format.
This practice contributes to a more readable and maintainable codebase, allowing developers to quickly understand and modify the logic without getting lost in a jumble of unsorted case clauses.
By integrating this rule into your ESLint configuration, you can focus on the functionality of your code, confident that your switch statements are consistently structured and easy to manage.
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”) using localeCompare.'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”).
specialCharacters
default:keepControls 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).
locales
default:'en-US'Specifies the sorting locales. See String.prototype.localeCompare() - locales.
string— A BCP 47 language tag (e.g.'en','en-US','zh-CN').string[]— An array of BCP 47 language tags.
Usage
Version
This rule was introduced in v3.0.0.