Skip to content

shellcheck

A linter for shell scripts.

Backend: pants.backend.shell
Config section: [shellcheck]

Basic options

skip

--[no-]shellcheck-skip

PANTS_SHELLCHECK_SKIP

default: False

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

args

--shellcheck-args="[<shell_str>, <shell_str>, ...]"

PANTS_SHELLCHECK_ARGS

default: []

Arguments to pass directly to Shellcheck, e.g. --shellcheck-args='-e SC20529'.

Advanced options

version

--shellcheck-version=<str>

PANTS_SHELLCHECK_VERSION

default: v0.8.0

Use this version of Shellcheck.

known_versions

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

PANTS_SHELLCHECK_KNOWN_VERSIONS

default:

[
  "v0.8.0|macos_arm64 |e065d4afb2620cc8c1d420a9b3e6243c84ff1a693c1ff0e38f279c8f31e86634|4049756",
  "v0.8.0|macos_x86_64|e065d4afb2620cc8c1d420a9b3e6243c84ff1a693c1ff0e38f279c8f31e86634|4049756",
  "v0.8.0|linux_arm64 |9f47bbff5624babfa712eb9d64ece14c6c46327122d0c54983f627ae3a30a4ac|2996468",
  "v0.8.0|linux_x86_64|ab6ee1b178f014d1b86d1e24da20d1139656c8b0ed34d2867fbb834dad02bf0a|1403852"
]


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_template

--shellcheck-url-template=<str>

PANTS_SHELLCHECK_URL_TEMPLATE

default: https://github.com/koalaman/shellcheck/releases/download/{version}/shellcheck-{version}.{platform}.tar.xz

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.

url_platform_mapping

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

PANTS_SHELLCHECK_URL_PLATFORM_MAPPING

default:

{
  "linux_arm64": "linux.aarch64",
  "linux_x86_64": "linux.x86_64",
  "macos_arm64": "darwin.x86_64",
  "macos_x86_64": "darwin.x86_64"
}

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.

use_unsupported_version

--shellcheck-use-unsupported-version=<UnsupportedVersionUsage>

PANTS_SHELLCHECK_USE_UNSUPPORTED_VERSION

one of: error, warning

default: error


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

Supported Shellcheck versions: unspecified

config_discovery

--[no-]shellcheck-config-discovery

PANTS_SHELLCHECK_CONFIG_DISCOVERY

default: True

If true, Pants will include all relevant .shellcheckrc and shellcheckrc files during runs. See https://www.mankier.com/1/shellcheck#RC_Files for where these can be located.

Deprecated options

None