golangci-lint
A fast Go linters runner
Backend: pants.backend.experimental.go.lint.golangci_lint
Config section: [golangci-lint]
Basic options
args
--golangci-lint-args="[<shell_str>, <shell_str>, ...]"
PANTS_GOLANGCI_LINT_ARGS
[golangci-lint]
args = [
<shell_str>,
<shell_str>,
...,
]
[]
Arguments to pass directly to golangci-lint, e.g. --golangci-lint-args='--enable gocritic'
.
skip
--[no-]golangci-lint-skip
PANTS_GOLANGCI_LINT_SKIP
[golangci-lint]
skip = <bool>
False
If true, don't use golangci-lint when running pants lint
.
Advanced options
config
--golangci-lint-config=<file_option>
PANTS_GOLANGCI_LINT_CONFIG
[golangci-lint]
config = <file_option>
None
Path to a YAML config file understood by golangci-lint (https://golangci-lint.run/usage/configuration/#config-file).
Setting this option will disable [golangci-lint].config_discovery
. Use this option if the config is located in a non-standard location.
config_discovery
--[no-]golangci-lint-config-discovery
PANTS_GOLANGCI_LINT_CONFIG_DISCOVERY
[golangci-lint]
config_discovery = <bool>
True
If true, Pants will include all relevant config files during runs (.golangci.yml
, .golangci.yaml
, golangci.toml
, and golangci.json
).
Use [golangci-lint].config
instead if your config is in a non-standard location.
known_versions
--golangci-lint-known-versions="['<str>', '<str>', ...]"
PANTS_GOLANGCI_LINT_KNOWN_VERSIONS
[golangci-lint]
known_versions = [
'<str>',
'<str>',
...,
]
[ "1.51.1|macos_arm64 |75b8f0ff3a4e68147156be4161a49d4576f1be37a0b506473f8c482140c1e7f2|9724049", "1.51.1|macos_x86_64|fba08acc4027f69f07cef48fbff70b8a7ecdfaa1c2aba9ad3fb31d60d9f5d4bc|10054954", "1.51.1|linux_arm64 |9744bc34e7b8d82ca788b667bfb7155a39b4be9aef43bf9f10318b1372cea338|8927955", "1.51.1|linux_x86_64|17aeb26c76820c22efa0e1838b0ab93e90cfedef43fbfc9a2f33f27eb9e5e070|9712769" ]
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 stringplatform
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 byshasum -a 256
length
is the expected length of the download file in bytes, as emitted bywc -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
--golangci-lint-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
PANTS_GOLANGCI_LINT_URL_PLATFORM_MAPPING
[golangci-lint.url_platform_mapping]
key1 = val1
key2 = val2
...
{ "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
.
url_template
--golangci-lint-url-template=<str>
PANTS_GOLANGCI_LINT_URL_TEMPLATE
[golangci-lint]
url_template = <str>
https://github.com/golangci/golangci-lint/releases/download/v{version}/golangci-lint-{version}-{platform}.tar.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-{version}-{platform}.zip.
use_unsupported_version
--golangci-lint-use-unsupported-version=<UnsupportedVersionUsage>
PANTS_GOLANGCI_LINT_USE_UNSUPPORTED_VERSION
[golangci-lint]
use_unsupported_version = <UnsupportedVersionUsage>
error, warning
default:
error
What action to take in case the requested version of golangci-lint is not supported.
Supported golangci-lint versions: unspecified
version
--golangci-lint-version=<str>
PANTS_GOLANGCI_LINT_VERSION
[golangci-lint]
version = <str>
1.51.1
Use this version of golangci-lint.
Deprecated options
None
Related subsystems
None