useSortedEnumMembers (GraphQL)

Summary

Rule available since: v2.5.0
Diagnostic Category: assist/source/useSortedEnumMembers
Sources:
- Inspired from @graphql-eslint/alphabetize

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 GraphQL enum values.

Keeping enum values sorted makes schema definitions easier to review and maintain, especially as enums grow over time.

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 Role {
2
  SUPER_ADMIN
3
  ADMIN
4
  USER
5
  GOD
6
}

code-block.graphql:1:1 assist/source/useSortedEnumMembers  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ The members of the enum Role are not sorted.
  
  > 1 │ enum Role {
      │ ^^^^^^^^^^^
  > 2 │   SUPER_ADMIN
  > 3 │   ADMIN
  > 4 │   USER
  > 5 │   GOD
  > 6 │ }
      │ ^
    7 │ 
  
  ℹ Safe fix: Sort the enum members.
  
    1 1 │   enum Role {
    2   │ - ··SUPER_ADMIN
    3   │ - ··ADMIN
    4   │ - ··USER
    5   │ - ··GOD
      2 │ + ··ADMIN
      3 │ + ··GOD
      4 │ + ··SUPER_ADMIN
      5 │ + ··USER
    6 6 │   }
    7 7 │

Valid

1
enum Role {
2
  ADMIN
3
  GOD
4
  SUPER_ADMIN
5
  USER
6
}