spectral

spectral documentation

Version in MegaLinter: 6.11.0
Visit Official Web Site
See How to configure spectral rules
- If custom .openapirc.yml config file isn't found, .openapirc.yml will be used
See Index of problems detected by spectral

Configuration in MegaLinter

Enable spectral by adding OPENAPI_SPECTRAL in ENABLE_LINTERS variable
Disable spectral by adding OPENAPI_SPECTRAL in DISABLE_LINTERS variable

Variable	Description	Default value
OPENAPI_SPECTRAL_ARGUMENTS	User custom arguments to add in linter CLI call Ex: `-s --foo "bar"`
OPENAPI_SPECTRAL_COMMAND_REMOVE_ARGUMENTS	User custom arguments to remove from command line before calling the linter Ex: `-s --foo "bar"`
OPENAPI_SPECTRAL_FILTER_REGEX_INCLUDE	Custom regex including filter Ex: `(src\\|lib)`	Include every file
OPENAPI_SPECTRAL_FILTER_REGEX_EXCLUDE	Custom regex excluding filter Ex: `(test\\|examples)`	Exclude no file
OPENAPI_SPECTRAL_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`
OPENAPI_SPECTRAL_FILE_EXTENSIONS	Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files Ex: `[".py", ""]`	`[".yml", ".yaml", ".json"]`
OPENAPI_SPECTRAL_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
OPENAPI_SPECTRAL_PRE_COMMANDS	List of bash commands to run before the linter	None
OPENAPI_SPECTRAL_POST_COMMANDS	List of bash commands to run after the linter	None
OPENAPI_SPECTRAL_UNSECURED_ENV_VARIABLES	List of env variables explicitly not filtered before calling OPENAPI_SPECTRAL and its pre/post commands	None
OPENAPI_SPECTRAL_CONFIG_FILE	spectral configuration file nameUse `LINTER_DEFAULT` to let the linter find it	`.openapirc.yml`
OPENAPI_SPECTRAL_RULES_PATH	Path where to find linter configuration file	Workspace folder, then MegaLinter default rules
OPENAPI_SPECTRAL_DISABLE_ERRORS	Run linter but consider errors as warnings	`false`
OPENAPI_SPECTRAL_DISABLE_ERRORS_IF_LESS_THAN	Maximum number of errors allowed	`0`
OPENAPI_SPECTRAL_CLI_EXECUTABLE	Override CLI executable	`['spectral']`

IDE Integration

Use spectral in your favorite IDE to catch errors before MegaLinter !

	IDE	Extension Name	Install
	stoplight	Native integration	Visit Web Site
	Visual Studio Code	vscode-spectral	Visit Web Site

MegaLinter Flavours

This linter is available in the following flavours

Flavor	Description	Embedded linters
all	Default MegaLinter Flavor	121
c_cpp	Optimized for pure C/C++ projects	55
documentation	MegaLinter for documentation projects	51
dotnet	Optimized for C, C++, C# or VB based projects	64
dotnetweb	Optimized for C, C++, C# or VB based projects with JS/TS	73
go	Optimized for GO based projects	53
java	Optimized for JAVA based projects	54
javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	60
php	Optimized for PHP based projects	54
python	Optimized for PYTHON based projects	62
ruby	Optimized for RUBY based projects	51
rust	Optimized for RUST based projects	51
salesforce	Optimized for Salesforce based projects	55
swift	Optimized for SWIFT based projects	51
terraform	Optimized for TERRAFORM based projects	55

Behind the scenes

How are identified applicable files

File extensions: .yml, .yaml, .json
Detected file content (regex): "openapi":, "swagger":, openapi:, swagger:

How the linting is performed

spectral is called one time by identified file (file CLI lint mode)

Example calls

spectral lint myfile.yml

spectral lint -r .openapirc.yml myfile.yml

Help content

spectral lint [documents..]

lint JSON/YAML documents from files or URLs

Positionals:
  documents  Location of JSON/YAML documents. Can be either a file, a glob or fetchable resource(s) on the web.  [array] [default: []]

Options:
      --version                  Show version number  [boolean]
      --help                     Show help  [boolean]
  -e, --encoding                 text encoding to use  [string] [choices: "utf8", "ascii", "utf-8", "utf16le", "ucs2", "ucs-2", "base64", "latin1"] [default: "utf8"]
  -f, --format                   formatters to use for outputting results, more than one can be given joining them with a comma  [string] [choices: "json", "stylish", "junit", "html", "text", "teamcity", "pretty", "github-actions", "sarif"] [default: "stylish"]
  -o, --output                   where to output results, can be a single file name, multiple "output.<format>" or missing to print to stdout  [string]
      --stdin-filepath           path to a file to pretend that stdin comes from  [string]
      --resolver                 path to custom json-ref-resolver instance  [string]
  -r, --ruleset                  path/URL to a ruleset file  [string]
  -F, --fail-severity            results of this level or above will trigger a failure exit code  [string] [choices: "error", "warn", "info", "hint"] [default: "error"]
  -D, --display-only-failures    only output results equal to or greater than --fail-severity  [boolean] [default: false]
      --ignore-unknown-format    do not warn about unmatched formats  [boolean] [default: false]
      --fail-on-unmatched-globs  fail on unmatched glob patterns  [boolean] [default: false]
  -v, --verbose                  increase verbosity  [boolean]
  -q, --quiet                    no logging - output only  [boolean]

Installation on mega-linter Docker image

NPM packages (node.js):
- @stoplight/spectral-cli