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 a string-valued TypeScript enum.

The action uses natural order: uppercase letters come before lowercase letters (A before a), and numbers are compared by value (item9 before item10). This keeps enum declarations predictable and easy to scan.

A member with a computed name cannot be compared reliably. The action leaves that member in place and sorts the comparable members on each side independently.

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
}