useSortedTypeFields (GraphQL)

Language GraphQL

Summary

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

How to enable in your editor

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

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

Use the source action code source.action.useSortedTypeFields.biome

How to configure

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

Description

Sort fields in GraphQL type definitions alphabetically.

This rule ensures that fields within type, interface, and input definitions are sorted alphabetically. For GraphQL identifiers ([A-Za-z0-9_]), the sort order matches JavaScript’s localeCompare(), including case handling.

Examples

1
type User {
2
  name: String
3
  age: Int
4
  id: ID
5
}

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

  ℹ Source action diff:
  
    1 1 │   type User {
    2   │ - ··name:·String
    3   │ - ··age:·Int
    4   │ - ··id:·ID
      2 │ + ··age:·Int
      3 │ + ··id:·ID
      4 │ + ··name:·String
    5 5 │   }
    6 6 │

1
interface Node {
2
  name: String
3
  id: ID
4
}

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

  ℹ Source action diff:
  
    1 1 │   interface Node {
    2   │ - ··name:·String
    3   │ - ··id:·ID
      2 │ + ··id:·ID
      3 │ + ··name:·String
    4 4 │   }
    5 5 │

1
input CreateUserInput {
2
  name: String
3
  age: Int
4
}

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

  ℹ Source action diff:
  
    1 1 │   input CreateUserInput {
    2   │ - ··name:·String
    3   │ - ··age:·Int
      2 │ + ··age:·Int
      3 │ + ··name:·String
    4 4 │   }
    5 5 │