Skip to main content
Version: 2.23

yamllint

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

This version of Pants uses yamllint version 1.32.0 by default. Use a dedicated lockfile and the install_from_resolve option to control this.

Backend: pants.backend.experimental.tools.yamllint

Config section: [yamllint]

Basic options​

args​

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

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

exclude​

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

Glob for which YAML files to exclude from linting.

include​

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

Glob for which YAML files to lint.

skip​

--[no-]yamllint-skip
PANTS_YAMLLINT_SKIP
pants.toml
[yamllint]
skip = <bool>
default: False

If true, don't use Yamllint when running pants lint.

Advanced options​

config_file_name​

--yamllint-config-file-name=<str>
PANTS_YAMLLINT_CONFIG_FILE_NAME
pants.toml
[yamllint]
config_file_name = <str>
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.

console_script​

--yamllint-console-script=<str>
PANTS_YAMLLINT_CONSOLE_SCRIPT
pants.toml
[yamllint]
console_script = <str>
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
pants.toml
[yamllint]
entry_point = <str>
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.

install_from_resolve​

--yamllint-install-from-resolve=<str>
PANTS_YAMLLINT_INSTALL_FROM_RESOLVE
pants.toml
[yamllint]
install_from_resolve = <str>
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/2.23/docs/python/overview/lockfiles#lockfiles-for-tools.

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, which uses yamllint version 1.32.0.

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.

interpreter_constraints​

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

Python interpreter constraints for this tool.

orphan_files_behavior​

--yamllint-orphan-files-behavior=<OrphanFilepathConfigBehavior>
PANTS_YAMLLINT_ORPHAN_FILES_BEHAVIOR
pants.toml
[yamllint]
orphan_files_behavior = <OrphanFilepathConfigBehavior>
one of: ignore, error, warn
default: ignore

Whether to ignore, error or show a warning when files are found that are not covered by the config file provided in [yamllint].config_file_name setting.

requirements​

--yamllint-requirements="['<str>', '<str>', ...]"
PANTS_YAMLLINT_REQUIREMENTS
pants.toml
[yamllint]
requirements = [
    '<str>',
    '<str>',
    ...,
]
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). Make sure to use the // prefix to refer to targets using their full address from the root (e.g. //3rdparty/python:tool). This is necessary to distinguish address specs from local or VCS requirements.

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.

Deprecated options​

None

None