no-hashtag-description

Since 0.9.0

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.

Configuration

This rule has no options.

version: "1.0"
commands:
  lint:
    graphql:
      rules:
        no-hashtag-description: warning

The rule can be disabled for a node and everything nested in it with an # apigenie-lint-disable no-hashtag-description 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.

"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! }

Related rules

• type-description-defined