type-naming

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

This rule checks that type names follow a naming convention, PascalCase by default.

Rule details

Consistent names make a schema predictable for its clients: generated code, documentation and queries read the same everywhere. The rule reports a name that doesn’t follow the convention, with the name converted to it as a suggestion.

The rule applies to definitions. An # apigenie-lint-disable type-naming 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.

Configuration

The configuration block can be a string, the convention, or an object with the properties:

  • convention: camelCase, camelCaseStrict, PascalCase, PascalCaseStrict, snake_case, CONST_CASE (or UPPER_CASE), kebab-case or Header-Case; the strict forms reject two capitals in a row (userID)
  • allowLeadingUnderscore: whether leading underscores are ignored, e.g. in _service; false by default
version: "1.0"
commands:
  lint:
    graphql:
      rules:
        type-naming: [warning, { convention: snake_case, allowLeadingUnderscore: true }]

Examples

Good.

type UserProfile { id: ID! }

Bad. The linter reports Type name 'user_profile' should be PascalCase, e.g. 'UserProfile'.

type user_profile { 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:
        type-naming: off

Related rules

Last updated on View as Markdown
Was this helpful?