field-naming
Since 0.9.0 · In the rulesets: Recommended at warning, Strict at error, All at error
This rule checks that the field names follow a naming convention, camelCase 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 field-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(orUPPER_CASE),kebab-caseorHeader-Case; the strict forms reject two capitals in a row (userID)allowLeadingUnderscore: whether leading underscores are ignored, e.g. in_service;falseby default
version: "1.0"
commands:
lint:
graphql:
rules:
field-naming: [warning, { convention: snake_case, allowLeadingUnderscore: true }]
Examples
Good.
type User { firstName: String }
Bad. The linter reports Field name 'first_name' should be camelCase, e.g. 'firstName'.
type User { first_name: String }
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:
field-naming: off