no-get-prefix-on-query-fields

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

This rule checks that the fields of the query root type are not named getSomething.

Rule details

Query fields are nouns: the operation type already says that they read data. user(id:) is the convention, getUser(id:) comes from RPC APIs.

The rule applies to definitions. An # apigenie-lint-disable no-get-prefix-on-query-fields 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.

type Query { user(id: ID!): User }

Bad. The linter reports Query field 'getUser' should not start with 'get', e.g. 'user'.

type Query { getUser(id: ID!): User }

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:
        no-get-prefix-on-query-fields: off
Last updated on View as Markdown
Was this helpful?