sort-maps
Enforce sorted elements within JavaScript Map object.
Sorting elements within JavaScript Map objects provides a clear and predictable structure to the codebase. This rule detects instances where Map elements are not sorted and raises linting errors, encouraging developers to arrange elements in the desired order.
By maintaining a consistent structure across Map objects, this rule improves readability and makes it easier to locate and understand key-value pairs.
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”).
Usage
Version
This rule was introduced in v0.5.0.