graphql-schema-linter

graphql-schema-linter documentation

Version in MegaLinter: 3.0.1
Visit Official Web Site
See How to configure graphql-schema-linter rules
See How to disable graphql-schema-linter rules in files
See Index of problems detected by graphql-schema-linter

Configuration in MegaLinter

Enable graphql-schema-linter by adding GRAPHQL_GRAPHQL_SCHEMA_LINTER in ENABLE_LINTERS variable
Disable graphql-schema-linter by adding GRAPHQL_GRAPHQL_SCHEMA_LINTER in DISABLE_LINTERS variable

Variable	Description	Default value
GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS	User custom arguments to add in linter CLI call Ex: `-s --foo "bar"`
GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_INCLUDE	Custom regex including filter Ex: `(src\\|lib)`	Include every file
GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_EXCLUDE	Custom regex excluding filter Ex: `(test\\|examples)`	Exclude no file
GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_LINT_MODE	Override default CLI lint mode - `file`: Calls the linter for each file - `project`: Call the linter from the root of the project	`file`
GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS	Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files Ex: `[".py", ""]`	`[".graphql"]`
GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX	File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]`	Include every file
GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS	List of bash commands to run before the linter	None
GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS	List of bash commands to run after the linter	None
GRAPHQL_GRAPHQL_SCHEMA_LINTER_UNSECURED_ENV_VARIABLES	List of env variables explicitly not filtered before calling GRAPHQL_GRAPHQL_SCHEMA_LINTER and its pre/post commands	None
GRAPHQL_GRAPHQL_SCHEMA_LINTER_CONFIG_FILE	graphql-schema-linter configuration file nameUse `LINTER_DEFAULT` to let the linter find it	`.graphql-schema-linterrc`
GRAPHQL_GRAPHQL_SCHEMA_LINTER_RULES_PATH	Path where to find linter configuration file	Workspace folder, then MegaLinter default rules
GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS	Run linter but consider errors as warnings	`false`
GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS_IF_LESS_THAN	Maximum number of errors allowed	`0`
GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_EXECUTABLE	Override CLI executable	`['graphql-schema-linter']`

MegaLinter Flavours

This linter is available in the following flavours

Flavor	Description	Embedded linters
all	Default MegaLinter Flavor	113
cupcake	MegaLinter for the most commonly used languages	81
documentation	MegaLinter for documentation projects	47
dotnet	Optimized for C, C++, C# or VB based projects	59
go	Optimized for GO based projects	49
java	Optimized for JAVA based projects	51
javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	56
php	Optimized for PHP based projects	50
python	Optimized for PYTHON based projects	58
ruby	Optimized for RUBY based projects	47
rust	Optimized for RUST based projects	47
salesforce	Optimized for Salesforce based projects	50
swift	Optimized for SWIFT based projects	47
terraform	Optimized for TERRAFORM based projects	51

Behind the scenes

How are identified applicable files

File extensions: .graphql

How the linting is performed

graphql-schema-linter is called one time by identified file (file CLI lint mode)

Example calls

graphql-schema-linter myfile.graphql

Help content

Usage: graphql-schema-linter [options] [schema.graphql ...]

Options:
  -r, --rules <rules>                 only the rules specified will be used to validate the schema. Example: fields-have-descriptions,types-have-descriptions
  -o, --rules-options <rulesOptions>  configure the specified rules with the passed in configuration options. example: {"enum-values-sorted-alphabetically":{"sortOrder":"lexicographical"}}
  -i, --ignore <ignore list>          ignore errors for specific schema members, example: {'fields-have-descriptions':['Obvious','Query.obvious','Query.something.obvious']}
  -f, --format <format>               choose the output format of the report. Possible values: json, text, compact
  -s, --stdin                         schema definition will be read from STDIN instead of specified file.
  -c, --config-directory <path>       path to begin searching for config files.
  -p, --custom-rule-paths <paths>     path to additional custom rules to be loaded. Example: rules/*.js
  --comment-descriptions              use old way of defining descriptions in GraphQL SDL
  --old-implements-syntax             use old way of defining implemented interfaces in GraphQL SDL
  -o, --only <rules>                  This option is DEPRECATED. Use `--rules` instead.
  -e, --except <rules>                This option is DEPRECATED. Use `--rules` instead.
  --version                           output the version number
  -h, --help                          output usage information

Installation on mega-linter Docker image

NPM packages (node.js):
- graphql
- graphql-schema-linter