useGraphqlSortedDefinitions (GraphQL)

Language GraphQL

Summary

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

How to enable in your editor

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

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

Use the source action code source.action.useGraphqlSortedDefinitions.biome

How to configure

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

Description

Sort the named definitions in a GraphQL document.

This action natural sorts the named definitions of a document by name: the scalar, type, interface, union, enum, and input definitions, their extend counterparts, the directive definitions, the fragment definitions, and the named query, mutation, and subscription operations. Keeping them sorted makes growing documents easier to scan and review. The order of definitions doesn’t affect how a document is executed or how a schema is built.

Definitions are sorted by name 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).

Definitions without a name, such as schema definitions, anonymous operations, and shorthand queries, are placed after the named definitions. Definitions with the same name aren’t sorted.

Examples

Invalid

1
type User {
2
  id: ID!
3
}
4

5
enum Role {
6
  ADMIN
7
  USER
8
}
9

10
directive @auth on FIELD_DEFINITION

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

  ℹ Source action diff:
  
     1    │ - type·User·{
     2    │ - ··id:·ID!
     3    │ - }
        1 │ + directive·@auth·on·FIELD_DEFINITION
     4  2 │   
     5  3 │   enum Role {
    ····· │ 
     8  6 │   }
     9  7 │   
    10    │ - directive·@auth·on·FIELD_DEFINITION
        8 │ + type·User·{
        9 │ + ··id:·ID!
       10 │ + }
    11 11 │

Valid

1
directive @auth on FIELD_DEFINITION
2

3
enum Role {
4
  ADMIN
5
  USER
6
}
7

8
type User {
9
  id: ID!
10
}

Caveats

Comments above a definition and comments at the end of its last line move with that definition. Because moving a comment can change which definition it describes or hide code, the action offers no fix in these cases:

A moved end-of-line comment would share a line with the next definition. Since a # comment continues to the end of its line, it would hide that definition. For example, sorting this input would move Apple before Zebra, but the comment would hide Zebra:

1
type Zebra { id: ID! } type Apple { id: ID! } # Keep Apple

A definition with a comment above it is, or would become, the first definition in the document.

Sort such definitions manually, or put each definition on its own line.