noRootType (GraphQL)

Language GraphQL

Summary

Rule available since: v2.3.12
Diagnostic Category: lint/style/noRootType
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/no-root-type

How to configure

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

Description

Disallow configured GraphQL root operation types.

A schema uses the Query, Mutation, and Subscription root types as entry points. This rule can forbid root types that a project does not support. It does nothing until at least one type is listed in the disallow option.

Examples

Invalid

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "noRootType": {
6
          "level": "on",
7
          "options": {
8
            "disallow": [
9
              "mutation"
10
            ]
11
          }
12
        }
13
      }
14
    }
15
  }
16
}

1
type Mutation {
2
  createUser(input: CreateUserInput!): User!
3
}

code-block.graphql:1:6 lint/style/noRootType ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ This schema defines the disallowed root type Mutation.
  
  > 1 │ type Mutation {
      │      ^^^^^^^^
    2 │   createUser(input: CreateUserInput!): User!
    3 │ }
  
  ℹ This project forbids that root type to enforce a specific schema design.
  
  ℹ Use a different root type, or update the rule configuration if this root type should be allowed.

Valid

1
type Query {
2
  users: [User!]!
3
}

Options

`disallow`

Lists root types to disallow, without regard to letter case. Defaults to an empty list.

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "noRootType": {
6
          "level": "on",
7
          "options": {
8
            "disallow": [
9
              "subscription"
10
            ]
11
          }
12
        }
13
      }
14
    }
15
  }
16
}

1
type Subscription {
2
  user: User
3
}

code-block.graphql:1:6 lint/style/noRootType ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ This schema defines the disallowed root type Subscription.
  
  > 1 │ type Subscription {
      │      ^^^^^^^^^^^^
    2 │   user: User
    3 │ }
  
  ℹ This project forbids that root type to enforce a specific schema design.
  
  ℹ Use a different root type, or update the rule configuration if this root type should be allowed.