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

Natural order compares numbers by value, so ROLE_9 comes before ROLE_10. It places uppercase letters before lowercase letters when names otherwise match. Keeping values sorted makes growing enums easier to scan and review.

Examples

Invalid

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

code-block.graphql ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Source action diff:
  
    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
}