Skip to main content
Version: 2.31 (dev)

spectral

A flexible JSON/YAML linter for creating automated style guides (https://github.com/stoplightio/spectral).

Backend: pants.backend.experimental.openapi.lint.spectral

Config section: [spectral]

Basic options​

args​

--spectral-args="[<shell_str>, <shell_str>, ...]"
PANTS_SPECTRAL_ARGS
pants.toml
[spectral]
args = [
  <shell_str>,
  <shell_str>,
  ...,
]
default: []

Arguments to pass directly to Spectral, e.g. --spectral-args='--fail-severity=warn'.

skip​

--[no-]spectral-skip
PANTS_SPECTRAL_SKIP
pants.toml
[spectral]
skip = <bool>
default: False

If true, don't use Spectral when running pants lint.

Advanced options​

binary_name​

--spectral-binary-name=<str>
PANTS_SPECTRAL_BINARY_NAME
pants.toml
[spectral]
binary_name = <str>
default: None

Override the binary to run for this tool. Defaults to the package name.

install_from_resolve​

--spectral-install-from-resolve=<str>
PANTS_SPECTRAL_INSTALL_FROM_RESOLVE
pants.toml
[spectral]
install_from_resolve = <str>
default: None

If specified, install the tool using the lockfile for this named resolve, instead of the version configured in this subsystem.

If unspecified, the tool will use the default configured package manager [nodejs].package_manager`, and install the tool without a lockfile.

version​

--spectral-version=<str>
PANTS_SPECTRAL_VERSION
pants.toml
[spectral]
version = <str>
default: @stoplight/[email protected]

Version string for the tool in the form package@version (e.g. [email protected])

Deprecated options​

None

None