shfmt¶
An autoformatter for shell scripts (https://github.com/mvdan/sh).
Backend: pants.backend.shell.lint.shfmt
Config section: [shfmt]
Basic options¶
skip¶
--[no-]shfmt-skip
PANTS_SHFMT_SKIP
default: False
If true, don't use shfmt when running pants fmt and pants lint.
args¶
--shfmt-args="[<shell_str>, <shell_str>, ...]"
PANTS_SHFMT_ARGS
default: []
Arguments to pass directly to shfmt, e.g. --shfmt-args='-i 2'.
Advanced options¶
version¶
--shfmt-version=<str>
PANTS_SHFMT_VERSION
default: v3.6.0
Use this version of shfmt.
known_versions¶
--shfmt-known-versions="['<str>', '<str>', ...]"
PANTS_SHFMT_KNOWN_VERSIONS
default:
[
"v3.2.4|macos_arm64 |e70fc42e69debe3e400347d4f918630cdf4bf2537277d672bbc43490387508ec|2998546",
"v3.2.4|macos_x86_64|43a0461a1b54070ddc04fbbf1b78f7861ee39a65a61f5466d15a39c4aba4f917|2980208",
"v3.2.4|linux_arm64 |6474d9cc08a1c9fe2ef4be7a004951998e3067d46cf55a011ddd5ff7bfab3de6|2752512",
"v3.2.4|linux_x86_64|3f5a47f8fec27fae3e06d611559a2063f5d27e4b9501171dde9959b8c60a3538|2797568",
"v3.6.0|macos_arm64 |633f242246ee0a866c5f5df25cbf61b6af0d5e143555aca32950059cf13d91e0|3065202",
"v3.6.0|macos_x86_64|b8c9c025b498e2816b62f0b717f6032e9ab49e725a45b8205f52f66318f17185|3047552",
"v3.6.0|linux_arm64 |fb1cf0af3dbe9aac7d98e38e3c7426765208ecfe23cb2da51037bb234776fd70|2818048",
"v3.6.0|linux_x86_64|5741a02a641de7e56b8da170e71a97e58050d66a3cf485fb268d6a5a8bb74afb|2850816"
]
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¶
--shfmt-url-template=<str>
PANTS_SHFMT_URL_TEMPLATE
default: https://github.com/mvdan/sh/releases/download/{version}/shfmt_{version}_{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.
url_platform_mapping¶
--shfmt-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
PANTS_SHFMT_URL_PLATFORM_MAPPING
default:
{
"linux_arm64": "linux_arm64",
"linux_x86_64": "linux_amd64",
"macos_arm64": "darwin_arm64",
"macos_x86_64": "darwin_amd64"
}
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¶
--shfmt-use-unsupported-version=<UnsupportedVersionUsage>
PANTS_SHFMT_USE_UNSUPPORTED_VERSION
one of: error, warning
default: error
What action to take in case the requested version of shfmt is not supported.
Supported shfmt versions: unspecified
config_discovery¶
--[no-]shfmt-config-discovery
PANTS_SHFMT_CONFIG_DISCOVERY
default: True
If true, Pants will include all relevant .editorconfig files during runs. See https://editorconfig.org.
Deprecated options¶
None