An autoformatter for shell scripts (https://github.com/mvdan/sh).
Backend: <span style="color: purple"><code>pants.backend.shell.lint.shfmt</code></span> Config section: <span style="color: purple"><code>[shfmt]</code></span>
## Basic options
<div style="color: purple"> <h3><code>skip</code></h3> <code>--[no-]shfmt-skip</code><br> <code>PANTS_SHFMT_SKIP</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>False</code></span>
<br>
Don't use shfmt when running `./pants fmt` and `./pants lint`.
</div> <br>
<div style="color: purple"> <h3><code>args</code></h3> <code>--shfmt-args="[<shell_str>, <shell_str>, ...]"</code><br> <code>PANTS_SHFMT_ARGS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>[]</code></span>
<br>
Arguments to pass directly to shfmt, e.g. `--shfmt-args='-i 2'`.'
</div> <br>
## Advanced options
<div style="color: purple"> <h3><code>version</code></h3> <code>--shfmt-version=<str></code><br> <code>PANTS_SHFMT_VERSION</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>v3.2.4</code></span>
<br>
Use this version of shfmt.
</div> <br>
<div style="color: purple"> <h3><code>known_versions</code></h3> <code>--shfmt-known-versions="['<str>', '<str>', ...]"</code><br> <code>PANTS_SHFMT_KNOWN_VERSIONS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <pre>[ "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" ]</pre></span>
<br>
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.
</div> <br>
<div style="color: purple"> <h3><code>use_unsupported_version</code></h3> <code>--shfmt-use-unsupported-version=<UnsupportedVersionUsage></code><br> <code>PANTS_SHFMT_USE_UNSUPPORTED_VERSION</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">one of: <code>error, warning</code></span><br> <span style="color: green">default: <code>error</code></span>
<br>
What action to take in case the requested version of shfmt is not supported.
Supported shfmt versions: unspecified
</div> <br>
<div style="color: purple"> <h3><code>url_template</code></h3> <code>--shfmt-url-template=<str></code><br> <code>PANTS_SHFMT_URL_TEMPLATE</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>https://github.com/mvdan/sh/releases/download/{version}/shfmt_{version}_{platform}</code></span>
<br>
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.
</div> <br>
<div style="color: purple"> <h3><code>url_platform_mapping</code></h3> <code>--shfmt-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"</code><br> <code>PANTS_SHFMT_URL_PLATFORM_MAPPING</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <pre>{ "linux_arm64": "linux_arm64", "linux_x86_64": "linux_amd64", "macos_arm64": "darwin_arm64", "macos_x86_64": "darwin_amd64" }</pre></span>
<br>
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.
</div> <br>
<div style="color: purple"> <h3><code>config_discovery</code></h3> <code>--[no-]shfmt-config-discovery</code><br> <code>PANTS_SHFMT_CONFIG_DISCOVERY</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>True</code></span>
<br>
If true, Pants will include all relevant `.editorconfig` files during runs. See https://editorconfig.org.
</div> <br>
## Deprecated options
None