description-capitalized

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

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.

The rule applies to definitions. An # apigenie-lint-disable description-capitalized 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 The description of object type 'User' should start with a capital letter.

"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:
        description-capitalized: off
Was this helpful?