Skip to content

Configuration

odcslint looks for a config file in the directory you run it from, then in each parent directory up to the root of your git repository. It uses the nearest directory that has one. Within a directory, it picks the first of these:

  1. odcslint.yml
  2. odcslint.yaml
  3. odcslint.toml
  4. pyproject.toml, if it has a [tool.odcslint] section

Outside a git repository, only the current directory is searched. Pass --config <FILE> to use a specific file instead. Without a config file, odcslint only runs schema validation. Rules stay off until you list them.

Structure

settings:
  include: ["**/*.odcs.yaml", "**/*.odcs.yml"]
  exclude: ["examples/**"]
  schema_validation: error   # error | warning | off

rules:
  - type: property_order
  - type: allowed_values
    name: approved_owners
    severity: error
    description: Owners must be on the data governance list.
    field: team.members.username
    role: owner
    values: [alice, bob]
    excludes: ["sandbox/**"]

[settings]
include = ["**/*.odcs.yaml", "**/*.odcs.yml"]
exclude = ["examples/**"]
schema_validation = "error"

[[rules]]
type = "property_order"

[[rules]]
type = "allowed_values"
name = "approved_owners"
severity = "error"
description = "Owners must be on the data governance list."
field = "team.members.username"
role = "owner"
values = ["alice", "bob"]
excludes = ["sandbox/**"]

[tool.odcslint.settings]
exclude = ["examples/**"]

[[tool.odcslint.rules]]
type = "property_order"

[[tool.odcslint.rules]]
type = "allowed_values"
name = "approved_owners"
field = "team.members.username"
role = "owner"
values = ["alice", "bob"]

settings

Key Default Description
include ["**/*.odcs.yaml", "**/*.odcs.yml"] Globs a file must match to be checked when a directory is walked.
exclude [] Globs to skip when walking. With --force-exclude, also applied to files passed explicitly.
schema_validation error Severity of schema findings, or off.

Globs in the config, including a rule's includes and excludes, are matched against paths relative to the directory that contains the config file, with / as the separator. That way a config at the repository root behaves the same when you run odcslint from a subdirectory. * stays within one directory, while ** matches across directories.

rules

rules is a list. Every entry accepts the keys below, plus the options of its type:

Key Default Description
type required The rule type. See the rules.
name the type Display name in output. Useful when the same type is configured more than once.
severity error error or warning. Only errors make odcslint check exit with 1.
description Free text that documents why the rule exists.
includes all files Only run the rule on files matching these globs.
excludes none Skip files matching these globs.

You can list the same rule type more than once, for example with different values, a different name, or different includes and excludes.

odcslint rejects unknown keys, unknown rule types and invalid regexes or globs, and exits with code 2. The error names the file, line and rule, and suggests the closest valid name when you made a typo:

error: invalid config odcslint.yml:4:5: rules[0] (allowed_values): unknown field `valuse`, expected one of `field`, `values`, `pattern`, `role`, `required`, `case_sensitive`; did you mean `values`?