Configuration reference¶

dddlint reads dddlint.yaml from the project root. Every key is optional; an empty file is valid and produces no findings.

Top-level keys¶

Key	Type	Default	Description
`similarity_threshold`	float	`0.85`	Ratio above which two domain/context names are flagged as duplicates
`enforce_canonical`	bool	`true`	Flag alias terms in addition to forbidden ones
`forbidden`	list[str]	`[]`	Terms that must never appear in a definition name
`synonyms`	list[SynonymGroup]	`[]`	Canonical terms and their aliases
`domains`	list[Scope]	`[]`	Path-scoped rules for high-level business domains
`contexts`	list[Scope]	`[]`	Path-scoped rules applied after domains — win on conflict

SynonymGroup¶

Key	Type	Default	Description
`canonical`	str	required	The one true term
`aliases`	list[str]	`[]`	Terms that should be renamed to `canonical`

Scope¶

domains and contexts share the same shape. Both add their rules to the global rules for any file whose path matches an include glob.

Key	Type	Default	Description
`name`	str	required	Identifier for the scope, shown in config-rule messages
`include`	list[str]	required	`fnmatch` globs matched against each file path
`forbidden`	list[str]	`[]`	Banned terms within this scope
`synonyms`	list[SynonymGroup]	`[]`	Scope-specific canonical terms

Precedence: global → domains → contexts. Contexts are applied last, so a context can override a domain's alias mapping. See how checking works.

Full example¶

dddlint.yaml

similarity_threshold: 0.85
enforce_canonical: true

forbidden:
  - util
  - helper
  - manager

synonyms:
  - canonical: customer
    aliases: [client, user, accountholder]
  - canonical: order
    aliases: [purchase, transaction]

domains:
  - name: commerce
    include: ["**/commerce/**"]
    synonyms:
      - canonical: order
        aliases: [purchase]

contexts:
  - name: billing
    include: ["**/billing/**"]
    forbidden: [discount]
    synonyms:
      - canonical: invoice
        aliases: [bill, statement]

Loading config in Python¶

from pathlib import Path
from tempfile import mkdtemp

from dddlint.config import load_config

path = Path(mkdtemp()) / "dddlint.yaml"
path.write_text("forbidden: [manager]\n")

config = load_config(path)

assert config.forbidden == ["manager"]
assert config.enforce_canonical is True
assert config.similarity_threshold == 0.85