sort-enums
Enforce sorted TypeScript enum members.
Enums are essential for defining a set of named constants, and keeping them in a consistent and predictable order is a best practice for readability and maintainability.
This rule ensures that TypeScript enum members are sorted, making it easier to reason about their values and identify any missing or duplicate entries. Sorted enums enhance the clarity of your code, making it more straightforward to understand and maintain.
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”).
sortByValue
default:falseControls whether sorting should be done using the enum’s values or names.
true— Use enum values.false— Use enum names.
When this setting is true, numeric enums will have their values sorted numerically regardless of the type setting.
forceNumericSort
default:falseControls whether numeric enums should always be sorted numerically, regardless of the type and sortByValue settings.
true— Use enum values.false— Use enum names.
partitionByComment
default:falseAllows you to use comments to separate the members of enums 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.
Usage
Version
This rule was introduced in v0.8.0.