useGraphqlSortedArguments (GraphQL)

Language GraphQL

Summary

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

How to enable in your editor

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

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

Use the source action code source.action.useGraphqlSortedArguments.biome

How to configure

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

Description

Sort the arguments of GraphQL fields and directives in natural order.

This action sorts both the arguments passed to fields and directives, and the arguments declared by field and directive definitions. Keeping them sorted makes long argument lists easier to scan and review. The order of arguments doesn’t affect how a field or a directive is executed.

Arguments 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).

Examples

Invalid

1
query {
2
  users(orderBy: NAME, first: 10, after: "cursor") {
3
    name
4
  }
5
}

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

  ℹ Source action diff:
  
    1 1 │   query {
    2   │ - ··users(orderBy:·NAME,·first:·10,·after:·"cursor")·{
      2 │ + ··users(after:·"cursor",·first:·10,·orderBy:·NAME)·{
    3 3 │       name
    4 4 │     }

1
type Query {
2
  users(orderBy: Order, first: Int, after: String): [User]
3
}

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

  ℹ Source action diff:
  
    1 1 │   type Query {
    2   │ - ··users(orderBy:·Order,·first:·Int,·after:·String):·[User]
      2 │ + ··users(after:·String,·first:·Int,·orderBy:·Order):·[User]
    3 3 │   }
    4 4 │

Valid

1
query {
2
  users(after: "cursor", first: 10, orderBy: NAME) {
3
    name
4
  }
5
}
6

7
type Query {
8
  users(after: String, first: Int, orderBy: Order): [User]
9
}

Caveats

Comments above an argument and comments at the end of its line move with that argument. No fix is offered when a moved comment would end up on the same line as other code, because the comment would then hide that code or describe a different argument. Sort such arguments manually, or put each argument on its own line.