Skip to main content
Version: 2.23 (prerelease)

shellcheck

A linter for shell scripts.

Backend: pants.backend.shell.lint.shellcheck

Config section: [shellcheck]

Basic options​

args​

--shellcheck-args="[<shell_str>, <shell_str>, ...]"
PANTS_SHELLCHECK_ARGS
pants.toml
[shellcheck]
args = [
    <shell_str>,
    <shell_str>,
    ...,
]
default: []

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

skip​

--[no-]shellcheck-skip
PANTS_SHELLCHECK_SKIP
pants.toml
[shellcheck]
skip = <bool>
default: False

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

Advanced options​

config_discovery​

--[no-]shellcheck-config-discovery
PANTS_SHELLCHECK_CONFIG_DISCOVERY
pants.toml
[shellcheck]
config_discovery = <bool>
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.

known_versions​

--shellcheck-known-versions="['<str>', '<str>', ...]"
PANTS_SHELLCHECK_KNOWN_VERSIONS
pants.toml
[shellcheck]
known_versions = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "v0.10.0|macos_arm64 |bbd2f14826328eee7679da7221f2bc3afb011f6a928b848c80c321f6046ddf81|7205756",
  "v0.10.0|macos_x86_64|ef27684f23279d112d8ad84e0823642e43f838993bbb8c0963db9b58a90464c2|4371632",
  "v0.10.0|linux_arm64 |324a7e89de8fa2aed0d0c28f3dab59cf84c6d74264022c00c22af665ed1a09bb|4291764",
  "v0.10.0|linux_x86_64|6c881ab0698e4e6ea235245f22832860544f17ba386442fe7e9d629f8cbedf87|2404716"
]

Known versions to verify downloads against.

Each element is a pipe-separated string of version|platform|sha256|length or version|platform|sha256|length|url_override, 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
  • (Optional) url_override is a specific url to use instead of the normally generated url for this version

E.g., 3.1.2|macos_x86_64|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813. and 3.1.2|macos_arm64 |aca5c1da0192e2fd46b7b55ab290a92c5f07309e7b0ebf4e45ba95731ae98291|50926|https://example.mac.org/bin/v3.1.2/mac-aarch64-v3.1.2.tgz.

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

url_platform_mapping​

--shellcheck-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
PANTS_SHELLCHECK_URL_PLATFORM_MAPPING
pants.toml
[shellcheck.url_platform_mapping]
key1 = val1
key2 = val2
...
default: 
{
  "linux_arm64": "linux.aarch64",
  "linux_x86_64": "linux.x86_64",
  "macos_arm64": "darwin.aarch64",
  "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.

url_template​

--shellcheck-url-template=<str>
PANTS_SHELLCHECK_URL_TEMPLATE
pants.toml
[shellcheck]
url_template = <str>
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-&#123;version&#125;-&#123;platform&#125;.zip.

use_unsupported_version​

--shellcheck-use-unsupported-version=<UnsupportedVersionUsage>
PANTS_SHELLCHECK_USE_UNSUPPORTED_VERSION
pants.toml
[shellcheck]
use_unsupported_version = <UnsupportedVersionUsage>
one of: error, warning
default: error

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

Supported Shellcheck versions: unspecified

version​

--shellcheck-version=<str>
PANTS_SHELLCHECK_VERSION
pants.toml
[shellcheck]
version = <str>
default: v0.10.0

Use this version of Shellcheck.

Deprecated options​

None

None