useConsistentGraphqlDescriptions (GraphQL)

Language GraphQL

Summary

Rule available since: v2.3.6
Diagnostic Category: lint/style/useConsistentGraphqlDescriptions
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/description-style

How to configure

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

Description

Require one description style throughout a GraphQL schema.

GraphQL supports triple-quoted block descriptions and one-line descriptions in double quotes. Using one style consistently makes schema documentation easier to scan.

Examples

style: `block`

Invalid

1
enum EnumValue {
2
  "this is a description"
3
  DEFAULT
4
}

code-block.graphql:2:3 lint/style/useConsistentGraphqlDescriptions ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected inline description style.
  
    1 │ enum EnumValue {
  > 2 │   "this is a description"
      │   ^^^^^^^^^^^^^^^^^^^^^^^
    3 │   DEFAULT
    4 │ }
  
  ℹ To stay consistent within the project, write the description block style.

Valid

1
enum EnumValue {
2
  """
3
  this is a description
4
  """
5
  DEFAULT
6
}

Options

`style`

Selects the required description style:

"block" requires triple-quoted descriptions ("""...""");
"inline" requires one-line descriptions in double quotes ("...").

Defaults to "block".

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "useConsistentGraphqlDescriptions": {
6
          "level": "on",
7
          "options": {
8
            "style": "inline"
9
          }
10
        }
11
      }
12
    }
13
  }
14
}

1
enum EnumValue {
2
  """
3
  this is a description
4
  """
5
  DEFAULT
6
}

code-block.graphql:2:3 lint/style/useConsistentGraphqlDescriptions ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected block description style.
  
    1 │ enum EnumValue {
  > 2 │   """
      │   ^^^
  > 3 │   this is a description
  > 4 │   """
      │   ^^^
    5 │   DEFAULT
    6 │ }
  
  ℹ To stay consistent within the project, write the description inline style.