unused-directive-definition

Since 0.9.0 · In the rulesets: Strict at error, All at error

This rule checks that the directives defined for schemas are applied in the document.

Rule details

An unused directive definition is dead code. Directives with executable locations (e.g. FIELD) are meant for operations and are not reported.

Turn the rule off when the directives are defined in a file and applied in others.

The rule applies to definitions. An # apigenie-lint-disable unused-directive-definition comment on a node turns it off for the node and everything nested in it; at the top of the file, separated from the first definition by a blank line, the comment turns it off for the whole file.

Examples

Good.

directive @auth on FIELD_DEFINITION
type Query { me: User @auth }

Bad. The linter reports Directive '@auth' is defined but never applied.

directive @auth on FIELD_DEFINITION
type Query { me: User }

Turn it off or change its severity

In apigenie.yaml, off turns the rule off and warning or error sets its severity; a rule with options takes the severity and the options as a pair, [warning, options]. lint.graphql has the details.

commands:
  lint:
    graphql:
      rules:
        unused-directive-definition: off
Last updated on View as Markdown
Was this helpful?