noRootType

GraphQL

Summary

Diagnostic Category: lint/nursery/noRootType
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
      "nursery": {
5
        "noRootType": "error"
6
      }
7
    }
8
  }
9
}

Description

Disallow the usage of specified root types

Prevent the usage of certain root types (e.g. mutation and/or subscription)

Examples

Invalid

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

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

Valid

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

Options

`disallow`

This required option lists all disallowed root types (e.g. mutation and/or subscription). The values of the list are case-insensitive.

Default []

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

1
type Subscription {
2
  user: User
3
}