useInputName

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 argument to be always called “input”

Using the same name for all input parameters will make your schemas easier to consume and more predictable.

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`

With the option checkInputType on, the input type name requires to be called <mutation name>Input. This can either be “loose” (case-insensitive) or “strict” (case-sensitive). Using the name of the mutation in the input type name will make it easier to find the mutation that the input type belongs to.

Default "off"

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

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

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
          "options": {
7
            "checkInputType": "strict"
8
          }
9
        }
10
      }
11
    }
12
  }
13
}

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

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

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