@glossary

Check terms against a glossary, and definition-list items.

Mission control: These systems are still on the test stand. Fly them, log everything.

Under review: works today, may fold into expressions or a vocabulary before 1.0.

Quick reference

Examples

@glossary/terms

Check document prose against a glossary source: report occurrences of Deprecated: spellings, with the canonical term. Code never reports.

<!-- mdv: document @glossary/terms=./glossary.json -->

@glossary/undefined

Opt-in: report entity-shaped mentions (capitalized runs, acronyms) absent from the glossary source, once per name, with a decision-fork suggestion (use the near-match, add with a definition, or stop and flag a redefinition for human review).

<!-- mdv: document @glossary/undefined=./glossary.json -->

items.all=@glossary/definition

Require every list item to be a **Term** — description (or : description) pair — a bold term, a delimiter, and a non-empty description. The dominant enumerate-named-things README idiom.

<!-- mdv: section -->
## Changes
<!-- mdv: list items.all=@glossary/definition -->
- **driftline-core** — parsing, contract compilation, and the validation engine.
- **driftline-cli** — terminal front end; owns exit codes and output formatting.
<!-- mdv: endlist -->
<!-- mdv: endsection -->

items.all.delimiter

Restrict the delimiter items.all=@glossary/definition accepts between the term and its description — emdash, colon, or any (default).

<!-- mdv: section -->
## Changes
<!-- mdv: list items.all=@glossary/definition items.all.delimiter=colon -->
- **`--watch`**: re-run validation when any input file changes.
<!-- mdv: endlist -->
<!-- mdv: endsection -->

See also: Terminology

On this page