useLoneExecutableDefinition

GraphQL

Summary

Rule available since: v2.3.12
Diagnostic Category: lint/style/useLoneExecutableDefinition
This rule isn’t recommended, so you need to enable it.
This rule doesn’t have a fix.
The default severity of this rule is information.
Sources:
- Same as @graphql-eslint/lone-executable-definition

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "useLoneExecutableDefinition": "error"
6
      }
7
    }
8
  }
9
}

Description

Require queries, mutations, subscriptions or fragments each to be located in separate files.

This rule ensures that each GraphQL document only contains a single operation (query, mutation, or subscription) or fragment definition. Having multiple executable definitions in a single file can make code harder to maintain, test, and understand.

Examples

Invalid

1
query Foo {
2
  id
3
}
4

5
fragment Bar on Baz {
6
  id
7
}

code-block.graphql:5:1 lint/style/useLoneExecutableDefinition ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Document contains multiple definitions. This definition should be in a separate file.
  
    3 │ }
    4 │ 
  > 5 │ fragment Bar on Baz {
      │ ^^^^^^^^^^^^^^^^^^^^^
  > 6 │   id
  > 7 │ }
      │ ^
    8 │ 
  
  ℹ Queries, mutations, subscriptions or fragments each must be defined in separate files.

1
query Foo {
2
  id
3
}
4

5
mutation ($name: String!) {
6
  createUser {
7
    id
8
  }
9
}

code-block.graphql:5:1 lint/style/useLoneExecutableDefinition ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Document contains multiple definitions. This definition should be in a separate file.
  
     3 │ }
     4 │ 
   > 5 │ mutation ($name: String!) {
       │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
   > 6 │   createUser {
   > 7 │     id
   > 8 │   }
   > 9 │ }
       │ ^
    10 │ 
  
  ℹ Queries, mutations, subscriptions or fragments each must be defined in separate files.

1
query Foo {
2
  id
3
}
4

5
query Bar {
6
  id
7
}

code-block.graphql:5:1 lint/style/useLoneExecutableDefinition ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Document contains multiple definitions. This definition should be in a separate file.
  
    3 │ }
    4 │ 
  > 5 │ query Bar {
      │ ^^^^^^^^^^^
  > 6 │   id
  > 7 │ }
      │ ^
    8 │ 
  
  ℹ Queries, mutations, subscriptions or fragments each must be defined in separate files.

Valid

1
query Foo {
2
  id
3
}

1
fragment Bar on Baz {
2
  id
3
}