Skip to main content
Version: 2.16.x (deprecated)

yamllint

A linter for YAML files (https://yamllint.readthedocs.io)

Backend: pants.backend.experimental.tools.yamllint

Config section: [yamllint]

Basic options​

include​

--yamllint-include="['<str>', '<str>', ...]"
PANTS_YAMLLINT_INCLUDE
default: 
[
  "**/*.yml",
  "**/*.yaml"
]

Glob for which YAML files to lint.

exclude​

--yamllint-exclude="['<str>', '<str>', ...]"
PANTS_YAMLLINT_EXCLUDE
default: []

Glob for which YAML files to exclude from linting.

args​

--yamllint-args="[<shell_str>, <shell_str>, ...]"
PANTS_YAMLLINT_ARGS
default: []

Arguments to pass directly to Yamllint, e.g. --yamllint-args='-d relaxed'.

skip​

--[no-]yamllint-skip
PANTS_YAMLLINT_SKIP
default: False

If true, don't use Yamllint when running scie-pants-linux-x86_64 lint.

Advanced options​

install_from_resolve​

--yamllint-install-from-resolve=<str>
PANTS_YAMLLINT_INSTALL_FROM_RESOLVE
default: None

If specified, install the tool using the lockfile for this named resolve.

This resolve must be defined in [python].resolves, as described in https://www.pantsbuild.org/v2.16/docs/python-third-party-dependencies#user-lockfiles.

The resolve's entire lockfile will be installed, unless specific requirements are listed via the requirements option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.

If unspecified, and the lockfile option is unset, the tool will be installed using the default lockfile shipped with Pants.

If unspecified, and the lockfile option is set, the tool will use the custom yamllint "tool lockfile" generated from the version and extra_requirements options. But note that this mechanism is deprecated.

requirements​

--yamllint-requirements="['<str>', '<str>', ...]"
PANTS_YAMLLINT_REQUIREMENTS
default: []

If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile.

Values can be pip-style requirements (e.g., tool or tool==1.2.3 or tool>=1.2.3), or addresses of python_requirement targets (or targets that generate or depend on python_requirement targets).

The lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.

If unspecified, install the entire lockfile.

interpreter_constraints​

--yamllint-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_YAMLLINT_INTERPRETER_CONSTRAINTS
default: ["CPython>=3.7,<4"]

Python interpreter constraints for this tool.

console_script​

--yamllint-console-script=<str>
PANTS_YAMLLINT_CONSOLE_SCRIPT
default: yamllint

The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an --entry-point since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.

entry_point​

--yamllint-entry-point=<str>
PANTS_YAMLLINT_ENTRY_POINT
default: None

The entry point for the tool. Generally you only want to use this option if the tool does not offer a --console-script (which this option is mutually exclusive with). Usually, you will not want to change this from the default.

config_file_name​

--yamllint-config-file-name=<str>
PANTS_YAMLLINT_CONFIG_FILE_NAME
default: .yamllint

Name of a config file understood by yamllint (https://yamllint.readthedocs.io/en/stable/configuration.html). The plugin will search the ancestors of each directory in which YAML files are found for a config file of this name.

Deprecated options​

version​

--yamllint-version=<str>
PANTS_YAMLLINT_VERSION
default: yamllint==1.29.0

Requirement string for the tool.

extra_requirements​

--yamllint-extra-requirements="['<str>', '<str>', ...]"
PANTS_YAMLLINT_EXTRA_REQUIREMENTS
default: []

Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.

lockfile​

--yamllint-lockfile=<str>
PANTS_YAMLLINT_LOCKFILE
default: <default>

Path to a lockfile used for installing the tool.

Set to the string <default> to use a lockfile provided by Pants, so long as you have not changed the --version and --extra-requirements options, and the tool's interpreter constraints are compatible with the default. Pants will error or warn if the lockfile is not compatible (controlled by [python].invalid_lockfile_behavior). See https://github.com/pantsbuild/pants/blob/release_2.16.1rc4/src/python/pants/backend/tools/yamllint/yamllint.lock for the default lockfile contents.

Set to the string <none> to opt out of using a lockfile. We do not recommend this, though, as lockfiles are essential for reproducible builds and supply-chain security.

To use a custom lockfile, set this option to a file path relative to the build root, then run scie-pants-linux-x86_64 generate-lockfiles --resolve=yamllint.

Alternatively, you can set this option to the path to a custom lockfile using pip's requirements.txt-style, ideally with --hash. Set [python].invalid_lockfile_behavior = 'ignore' so that Pants does not complain about missing lockfile headers.

export​

--[no-]yamllint-export
PANTS_YAMLLINT_EXPORT
default: True

If true, export a virtual environment with Yamllint when running scie-pants-linux-x86_64 export.

This can be useful, for example, with IDE integrations to point your editor to the tool's binary.