Skip to main content
Version: 2.22

taplo

An autoformatter for TOML files (https://taplo.tamasfe.dev/)

Backend: pants.backend.tools.taplo

Config section: [taplo]

Basic options​

args​

--taplo-args="[<shell_str>, <shell_str>, ...]"
PANTS_TAPLO_ARGS
pants.toml
[taplo]
args = [
    <shell_str>,
    <shell_str>,
    ...,
]
default: []

Arguments to pass directly to Taplo, e.g. --taplo-args='--option=align_entries=false'.

skip​

--[no-]taplo-skip
PANTS_TAPLO_SKIP
pants.toml
[taplo]
skip = <bool>
default: False

If true, don't use Taplo when running pants fmt and pants lint.

Advanced options​

config_discovery​

--[no-]taplo-config-discovery
PANTS_TAPLO_CONFIG_DISCOVERY
pants.toml
[taplo]
config_discovery = <bool>
default: True

If true, Pants will include a taplo.toml or .taplo.toml file found in the build root during a run.

glob_pattern​

--taplo-glob-pattern="['<str>', '<str>', ...]"
PANTS_TAPLO_GLOB_PATTERN
pants.toml
[taplo]
glob_pattern = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "**/*.toml",
  "!.taplo.toml",
  "!taplo.toml"
]

A list of glob patterns of files to include/exclude in formatting relative to the build root. Leading exclamation points exclude an item from formatting.

Example:

["**/*.toml", "**/pyproject.toml", "!pyproject.toml"]

The default includes all files with a .toml extension recursively and excludes .taplo.toml or taplo.toml files in the build root.

known_versions​

--taplo-known-versions="['<str>', '<str>', ...]"
PANTS_TAPLO_KNOWN_VERSIONS
pants.toml
[taplo]
known_versions = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "0.8.0|macos_arm64|79c1691c3c46be981fa0cec930ec9a6d6c4ffd27272d37d1885514ce59bd8ccf|3661689",
  "0.8.0|macos_x86_64|a1917f1b9168cb4f7d579422dcdf9c733028d873963d8fa3a6f499e41719c502|3926263",
  "0.8.0|linux_arm64|a6a94482f125c21090593f94cad23df099c4924f5b9620cda4a8653527c097a1|3995383",
  "0.8.0|linux_x86_64|3703294fac37ca9a9f76308f9f98c3939ccb7588f8972acec68a48d7a10d8ee5|4123593"
]

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​

--taplo-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
PANTS_TAPLO_URL_PLATFORM_MAPPING
pants.toml
[taplo.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​

--taplo-url-template=<str>
PANTS_TAPLO_URL_TEMPLATE
pants.toml
[taplo]
url_template = <str>
default: https://github.com/tamasfe/taplo/releases/download/{version}/taplo-{platform}.gz

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​

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

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

Supported Taplo versions: unspecified

version​

--taplo-version=<str>
PANTS_TAPLO_VERSION
pants.toml
[taplo]
version = <str>
default: 0.8.0

Use this version of Taplo.

Deprecated options​

None

None