useInputName (GraphQL)

Language GraphQL

Summary

Rule available since: v2.3.14
Diagnostic Category: lint/style/useInputName
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/input-name

How to configure

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

Description

Require mutation arguments to be named input.

A consistent argument name makes mutations predictable for schema users and client tools.

Examples

Invalid

1
type Mutation {
2
  SetMessage(message: InputMessage): String
3
}

code-block.graphql:2:14 lint/style/useInputName ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected input name, expected the input name "message" to be named "input".
  
    1 │ type Mutation {
  > 2 │   SetMessage(message: InputMessage): String
      │              ^^^^^^^^^^^^^^^^^^^^^
    3 │ }
    4 │ 
  
  ℹ Using the same name for all input parameters will make your schemas easier to consume and more predictable.

Valid

1
type Mutation {
2
  SetMessage(input: SetMessageInput): String
3
}

Options

`checkInputType`

Optionally requires the input type to be named <mutation name>Input, so schema readers can identify its related mutation.

"off" does not check the type name;
"loose" checks the name without regard to letter case;
"strict" requires matching letter case.

Defaults to "off".

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

1
type Mutation {
2
  SetMessage(input: InputMessage): String
3
}

code-block.graphql:2:14 lint/style/useInputName ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected input type name, expected the input type name "InputMessage" to be named "SetMessageInput".
  
    1 │ type Mutation {
  > 2 │   SetMessage(input: InputMessage): String
      │              ^^^^^^^^^^^^^^^^^^^
    3 │ }
    4 │ 
  
  ℹ Using the name of the operation in the input type name will make it easier to find the operation that the input type belongs to.

1
type Mutation {
2
  SetMessage(input: setMessageInput): String
3
}

1
type Mutation {
2
  SetMessage(input: SetMessageInput): String
3
}

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

1
type Mutation {
2
  SetMessage(input: InputMessage): String
3
}

code-block.graphql:2:14 lint/style/useInputName ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected input type name, expected the input type name "InputMessage" to be named "SetMessageInput".
  
    1 │ type Mutation {
  > 2 │   SetMessage(input: InputMessage): String
      │              ^^^^^^^^^^^^^^^^^^^
    3 │ }
    4 │ 
  
  ℹ Using the name of the operation in the input type name will make it easier to find the operation that the input type belongs to.

1
type Mutation {
2
  SetMessage(input: setMessageInput): String
3
}

code-block.graphql:2:14 lint/style/useInputName ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected input type name, expected the input type name "setMessageInput" to be named "SetMessageInput".
  
    1 │ type Mutation {
  > 2 │   SetMessage(input: setMessageInput): String
      │              ^^^^^^^^^^^^^^^^^^^^^^
    3 │ }
    4 │ 
  
  ℹ Using the name of the operation in the input type name will make it easier to find the operation that the input type belongs to.

1
type Mutation {
2
  SetMessage(input: SetMessageInput): String
3
}