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 /home/josh/work/scie-pants/dist/pants lint.

Advanced options

known_versions

--spectral-known-versions="['<str>', '<str>', ...]"
PANTS_SPECTRAL_KNOWN_VERSIONS

pants.toml

[spectral]
known_versions = [
    '<str>',
    '<str>',
    ...,
]

default:

[
  "v6.5.1|linux_arm64 |81017af87e04711ab0a0a7c15af9985241f6c84101d039775057bbec17572916|72709153",
  "v6.5.1|linux_x86_64|81017af87e04711ab0a0a7c15af9985241f6c84101d039775057bbec17572916|72709153",
  "v6.5.1|macos_arm64 |5b10d772cb309d82b6a49b689ed58580dcb3393ead82b82ab648eead7da4bd79|77446257",
  "v6.5.1|macos_x86_64|5b10d772cb309d82b6a49b689ed58580dcb3393ead82b82ab648eead7da4bd79|77446257"
]

Known versions to verify downloads against.

Each element is a pipe-separated string of version|platform|sha256|length, where:

- `version` is the version string
- `platform` is one of [linux_arm64,linux_x86_64,macos_arm64,macos_x86_64],
- `sha256` is the 64-character hex representation of the expected sha256
digest of the download file, as emitted by `shasum -a 256`
- `length` is the expected length of the download file in bytes, as emitted by
`wc -c`

E.g., 3.1.2|macos_x86_64|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813.

Values are space-stripped, so pipes can be indented for readability if necessary.

url_platform_mapping

--spectral-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
PANTS_SPECTRAL_URL_PLATFORM_MAPPING

pants.toml

[spectral.url_platform_mapping]
key1 = val1
key2 = val2
...

default:

{
  "linux_arm64": "linux",
  "linux_x86_64": "linux",
  "macos_arm64": "macos",
  "macos_x86_64": "macos"
}

A dictionary mapping platforms to strings to be used when generating the URL to download the tool.

In --url-template, anytime the {platform} string is used, Pants will determine the current platform, and substitute {platform} with the respective value from your dictionary.

For example, if you define {"macos_x86_64": "apple-darwin", "linux_x86_64": "unknown-linux"}, and run Pants on Linux with an intel architecture, then {platform} will be substituted in the --url-template option with unknown-linux.

url_template

--spectral-url-template=<str>
PANTS_SPECTRAL_URL_TEMPLATE

pants.toml

[spectral]
url_template = <str>

default: https://github.com/stoplightio/spectral/releases/download/{version}/spectral-{platform}

URL to download the tool, either as a single binary file or a compressed file (e.g. zip file). You can change this to point to your own hosted file, e.g. to work with proxies or for access via the filesystem through a file:$abspath URL (e.g. file:/this/is/absolute, possibly by templating the buildroot in a config file).

Use {version} to have the value from --version substituted, and {platform} to have a value from --url-platform-mapping substituted in, depending on the current platform. For example, https://github.com/.../protoc-{version}-{platform}.zip.

use_unsupported_version

--spectral-use-unsupported-version=<UnsupportedVersionUsage>
PANTS_SPECTRAL_USE_UNSUPPORTED_VERSION

pants.toml

[spectral]
use_unsupported_version = <UnsupportedVersionUsage>

one of: error, warning
default: error

What action to take in case the requested version of Spectral is not supported.

Supported Spectral versions: unspecified

version

--spectral-version=<str>
PANTS_SPECTRAL_VERSION

pants.toml

[spectral]
version = <str>

default: v6.5.1

Use this version of Spectral.

Deprecated options

None

Related subsystems

None