Linter rulesGraphQLlone-schema-definition

lone-schema-definition

Since 0.9.0

This rule checks that a document has at most one schema definition, as the GraphQL specification requires.

Rule Details

The rule reports the issues of the validation rule of the same name, with the messages of graphql-js. A document that breaks it is rejected by GraphQL servers and tools, so the rule should stay enabled with the error severity.

Configuration

This rule has no options.

version: "1.0"
commands:
  lint:
    graphql:
      rules:
        lone-schema-definition: warning

The rule can be disabled for a node and everything nested in it with an # apigenie-lint-disable lone-schema-definition comment on the node, or for a whole file with the comment at the top of the file, separated from the first definition by a blank line. It applies to definitions.

Examples

Good.

schema { query: Query }
type Query { a: Int }

Bad. The linter reports Must provide only one schema definition..

schema { query: Query }
schema { query: Query }
type Query { a: Int }

Further reading