description-capitalized

Since 0.9.0

This rule checks that descriptions start with a capital letter.

Rule Details

Descriptions are sentences shown by documentation tools. Descriptions starting with a character other than a letter, such as a backtick or a digit, are not reported.

Configuration

This rule has no options.

version: "1.0"
commands:
  lint:
    graphql:
      rules:
        description-capitalized: warning

The rule can be disabled for a node and everything nested in it with an # apigenie-lint-disable description-capitalized 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 The description of object type 'User' should start with a capital letter.

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