lone-executable-definition
Since 0.9.0 · In the rulesets: All at error
This rule checks that a document holds a single operation or fragment.
Rule details
One definition per file keeps files small, and lets tools map files to operations.
The rule applies to operations and fragments. An # apigenie-lint-disable lone-executable-definition 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 is an object with the ignore property: the kinds of definitions
(query, mutation, subscription, fragment) that may be added to a document.
version: "1.0"
commands:
lint:
graphql:
rules:
lone-executable-definition: [error, { ignore: [fragment] }]
Examples
Good.
query Me { me { id } }
Bad. The linter reports Operation 'Users' should be in a document of its own; a document should hold one operation or fragment.
query Me { me { id } }
query Users { users { 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:
lone-executable-definition: off