File ignores¶

Excluding files and paths¶

Per-line ignores suppress rules on lines matching a pattern. This page covers the coarser layer: skipping whole files, or switching off chosen rules for a path.

Three mechanisms, narrowing from left to right:

exclude¶

A top-level exclude lists paths ryl skips entirely. No rule runs against them, ryl format leaves them alone, and they produce no diagnostics.

--exclude <GLOBS> replaces config exclusions, including patterns loaded through exclude-from-file, for one run. Pass comma-separated gitignore-style globs once per command, anchored at the current working directory rather than the config:

ryl check --enable ALL --exclude 'pnpm-lock.yaml,vendor/**' .
ryl format --exclude 'generated/**' .

--exclude '' clears the config's exclusions. Explicit file arguments remain subject to exclusions. Git ignore handling during directory walks is unchanged.

exclude = """
vendor/**
generated/**
"""

[lint.rules.document-start]
present = true

exclude replaces the deprecated top-level ignore, which still works but warns until ryl --migrate-configs renames it. yamllint-compatible YAML config keeps yamllint's ignore key:

rules:
  document-start:
    present: true
ignore: |
  vendor/**
  generated/**

exclude-from-file (ignore-from-file in YAML) reads the same patterns from a file instead, so a project can reuse its .gitignore:

exclude-from-file = ".gitignore"

[lint.rules.document-start]
present = true

Glob semantics¶

Patterns are gitignore-style: ** crosses directory boundaries, a bare *.yaml matches at any depth, and a leading ! negates an earlier pattern.

On Windows and macOS, path globs and config filename comparisons ignore ASCII case. The policy applies to exclude, [files], rule ignores, per-line path filters and key-ordering file selectors, including stdin filenames and the language server. Other platforms keep case-sensitive matching.

A pattern with a directory in it is anchored at the directory holding the config file, whether discovered or passed with -c, or at the working directory for inline -d config. A file outside that directory matches by file name only, so *.lock.yaml still applies to it and .github/workflows/* does not — the same as ruff.

exclude = """
*.generated.yaml
!schema.generated.yaml
"""

[lint.rules.document-start]
present = true

exclude also applies to files named on the command line¶

Unlike a shell glob, exclude is not just a directory-walk filter: a path matching it is skipped even when passed explicitly, so ryl check vendor/a.yaml reports nothing if vendor/** is excluded. This is the equivalent of ruff's force-exclude, always on. See YAML in Markdown for how it interacts with a pre-commit hook that passes filenames.

per-file-ignores¶

per-file-ignores keeps linting a file but switches off the rules named for it. Use it where a file legitimately breaks one rule and should still be checked for everything else — a Helm values file with no document start, a workflow file whose on: key trips truthy.

[lint.rules.document-start]
present = true

[lint.rules.truthy]

[lint.per-file-ignores]
"**/values.yaml" = ["document-start"]
".github/workflows/*" = ["truthy"]

Each key is a path glob with the same semantics as exclude, including ! negation. Each value is a list of rule IDs, or ["ALL"] to switch off every rule for the matching files:

[lint.rules]
truthy = "enable"

[lint.per-file-ignores]
"**/pnpm-*.yaml" = ["ALL"]

A file under ["ALL"] is still parsed, so a syntax error in it is still reported and the run exits 1. To skip the file entirely, use exclude.

per-file-ignores is configured in TOML only; YAML config rejects it.

Per-rule ignore¶

Every rule accepts its own ignore, scoping that one rule to a subset of the tree. Other rules still run against the excluded paths.

[lint.rules.line-length]
max = 80
ignore = """
docs/**
"""

[lint.rules.colons]

Here docs/** is exempt from line-length but still checked by colons.

Choosing between them¶

Related¶

• Per-line ignores — suppress rules on lines matching a regex or path.
• Inline directives — in-file suppression with # ryl disable / disable-line.
• Migrating from yamllint — how exclude and exclude-from-file resolve relative paths per config source.