id       = "yamllint"
name     = "yamllint"
homepage = "https://github.com/adrienverge/yamllint"
description = "Linter for YAML files."
icon     = "SimpleIcons:yaml"
executables   = ["yamllint"]

[dotfiles]

# https://github.com/adrienverge/yamllint/blob/master/docs/configuration.rst
# — after project-local files and YAMLLINT_CONFIG_FILE, yamllint searches
# ~/.config/yamllint/config when no explicit configuration was supplied.
paths = ["~/.config/yamllint/config"]
secret = []
side_effect = false

[commands]
format = 1
label = "Lint YAML"
description = "Lint YAML files or directories. Reading from stdin and the --list-files mode are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = true }

[[commands.source]]
id = "cli"
kind = "help"
url = "https://github.com/adrienverge/yamllint/blob/master/yamllint/cli.py"
revision = "master 2026-10-27"
evidence = """
files_group.add_argument('files', metavar='FILE_OR_DIR', nargs='*',
help='files to check')
config_group.add_argument('-c', '--config-file', dest='config_file',
help='path to a custom configuration')
config_group.add_argument('-d', '--config-data', dest='config_data',
help='custom configuration (as YAML source)')
parser.add_argument('-f', '--format',
choices=('parsable', 'standard', 'colored', 'github', 'auto'),
default='auto', help='format for parsing output')
parser.add_argument('-s', '--strict',
help='return non-zero exit code on warnings as well as errors')
parser.add_argument('--no-warnings',
help='output only error level problems')
"""

[[commands.field]]
id = "files"
label = "Files or directories"
type = "path"
path = { kind = "any", role = "input" }
position = 0
multiple = true
sources = ["cli"]

[[commands.field]]
id = "config_file"
label = "Config file"
type = "path"
path = { kind = "file", role = "input" }
option = ["-c", "--config-file"]
sources = ["cli"]

[[commands.field]]
id = "config_data"
label = "Inline config (YAML)"
type = "string"
option = ["-d", "--config-data"]
sources = ["cli"]

[[commands.field]]
id = "format"
label = "Output format"
type = "enum"
option = ["-f", "--format"]
choices = [
  { value = "parsable", label = "Parsable" },
  { value = "standard", label = "Standard" },
  { value = "colored", label = "Colored" },
  { value = "github", label = "GitHub" },
  { value = "auto", label = "Auto" },
]
sources = ["cli"]

[[commands.field]]
id = "strict"
label = "Fail on warnings too"
type = "boolean"
option = ["-s", "--strict"]
sources = ["cli"]

[[commands.field]]
id = "no_warnings"
label = "Errors only"
type = "boolean"
option = ["--no-warnings"]
sources = ["cli"]

[[commands.task]]
id = "lint"
label = "Lint files"
fields = ["files"]
required = ["files"]

[[commands.task]]
id = "strict"
label = "Strict lint (CI)"
fields = ["files", "strict"]
required = ["files"]
set = { strict = [true] }

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["files", "config_file", "format", "strict", "no_warnings"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["config_data"]