useSortedEnumMembers (JavaScript)

Summary

Rule available since: v2.5.0
Diagnostic Category: assist/source/useSortedEnumMembers
Sources:
- Inspired from perfectionist/sort-enums
- Inspired from typescript-sort-keys/string-enum

How to enable in your editor

1
{
2
  "editor.codeActionsOnSave": {
3
    "source.action.useSortedEnumMembers.biome": "explicit",
4
    "source.fixAll.biome": "explicit"
5
  }
6
}

1
{
2
  "code_actions_on_format": {
3
    "source.action.useSortedEnumMembers.biome": true,
4
    "source.fixAll.biome": true
5
  }
6
}

Use the source action code source.action.useSortedEnumMembers.biome

How to configure

1
{
2
  "assist": {
3
    "actions": {
4
      "source": {
5
        "useSortedEnumMembers": "on"
6
      }
7
    }
8
  }
9
}

Description

Sort the members of an enum in natural order.

Enforce a consistent natural sort order for TypeScript enum members with string initializers.

This rule sorts members in string enums so declarations stay predictable and easier to scan. Members that cannot be compared, such as computed names, are left in place and split the enum into sortable groups.

Members are sorted in a Natural order, meaning that uppercase letters come before lowercase letters (e.g. A < a < B < b) and numbers are compared to their numerical value (e.g. 9 < 10).

Examples

Invalid

1
enum Status {
2
  InProgress = 'In Progress',
3
  Completed = 'Completed',
4
  OnHold = 'On Hold',
5
  Cancelled = 'Cancelled',
6
  NotStarted = 'Not Started',
7
}

code-block.ts ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Source action diff:
  
    1 1 │   enum Status {
    2   │ - → InProgress·=·'In·Progress',
      2 │ + → Cancelled·=·'Cancelled',
    3 3 │     Completed = 'Completed',
    4   │ - → OnHold·=·'On·Hold',
    5   │ - → Cancelled·=·'Cancelled',
    6   │ - → NotStarted·=·'Not·Started',
      4 │ + → InProgress·=·'In·Progress',
      5 │ + → NotStarted·=·'Not·Started',
      6 │ + → OnHold·=·'On·Hold',
    7 7 │   }
    8 8 │

Valid

1
enum Status {
2
  Cancelled = 'Cancelled',
3
  Completed = 'Completed',
4
  InProgress = 'In Progress',
5
  NotStarted = 'Not Started',
6
  OnHold = 'On Hold',
7
}