Perfectionist
Rulessort-enums

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”) 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).
  • 'custom' — Sort items using the alphabet entered in the alphabet option.

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).

alphabet

default: ''

Only used when the type option is set to 'custom'. Specifies the custom alphabet to use when sorting.

Use the Alphabet utility class from eslint-plugin-perfectionist/alphabet to quickly generate a custom alphabet.

Example: 0123456789abcdef...

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).

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.

sortByValue

default: false

Controls 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: false

Controls 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: false

Allows 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 regexp pattern to specify which comments should act as delimiters.
  • string[] — A list of regexp patterns to specify which comments should act as delimiters.
  • { block: boolean | string | string[]; line: boolean | string | string[] } — Specify which block and line comments should act as delimiters.

partitionByNewLine

default: false

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

enum Enum {
  // Group 1
  C = 'C',
  D = 'D',

  // Group 2
  B = 'B',

  // Group 3
  A = 'A',
  E = 'E',
}

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

Usage

Version

This rule was introduced in v0.8.0.

Resources

Table of Contents