Skip to main content
Version: 2.25 (dev)

scc

The Succinct Code Counter, aka scc (https://github.com/boyter/scc).

Backend: pants.backend.project_info

Config section: [scc]

Basic options​

args​

--scc-args="[<shell_str>, <shell_str>, ...]", ... -- [<shell_str> [<shell_str> [...]]]
PANTS_SCC_ARGS
pants.toml
[scc]
args = [
    <shell_str>,
    <shell_str>,
    ...,
]
default: []

Arguments to pass directly to SCC, e.g. --scc-args='--no-cocomo'.

Refer to to https://github.com/boyter/scc.

Advanced options​

known_versions​

--scc-known-versions="['<str>', '<str>', ...]"
PANTS_SCC_KNOWN_VERSIONS
pants.toml
[scc]
known_versions = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "3.0.0|macos_arm64 |846cb1b25025a0794d455719bc17cfb3f588576a58af1d95036f6c654e294f98|2006145",
  "3.0.0|macos_x86_64|9c3064e477ab36e16204ad34f649372034bca4df669615eff5de4aa05b2ddf1a|2048134",
  "3.0.0|linux_arm64 |04f9e797b70a678833e49df5e744f95080dfb7f963c0cd34f5b5d4712d290f33|1768037",
  "3.0.0|linux_x86_64|13ca47ce00b5bd032f97f3af7aa8eb3c717b8972b404b155a378b09110e4aa0c|1948341"
]

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​

--scc-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
PANTS_SCC_URL_PLATFORM_MAPPING
pants.toml
[scc.url_platform_mapping]
key1 = val1
key2 = val2
...
default: 
{
  "linux_arm64": "arm64-unknown-linux",
  "linux_x86_64": "x86_64-unknown-linux",
  "macos_arm64": "arm64-apple-darwin",
  "macos_x86_64": "x86_64-apple-darwin"
}

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​

--scc-url-template=<str>
PANTS_SCC_URL_TEMPLATE
pants.toml
[scc]
url_template = <str>
default: https://github.com/boyter/scc/releases/download/v{version}/scc-{version}-{platform}.zip

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​

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

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

Supported SCC versions: unspecified

version​

--scc-version=<str>
PANTS_SCC_VERSION
pants.toml
[scc]
version = <str>
default: 3.0.0

Use this version of SCC.

Deprecated options​

None

None