no-hashtag-description

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

This rule checks that definitions are documented with descriptions rather than with # comments.

Rule details

Comments are dropped by GraphQL servers: introspection, GraphiQL and generated code never show them. The rule reports a # comment directly above a definition that can have a description and has none. Comments separated from the definition by a blank line, and apigenie-lint-disable comments, are not reported.

The rule applies to definitions. An # apigenie-lint-disable no-hashtag-description 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.

"The users of the shop."
type User { id: ID! }

Bad. The linter reports Use a description instead of a comment to document object type 'User'.

# The users of the shop.
type User { id: ID! }

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:
        no-hashtag-description: off

Related rules

Last updated on View as Markdown
Was this helpful?