compendium-lint

Solid

Use to gardening-check a Compendium-style controlled-vocabulary store before committing or publishing it — verifying pointer integrity, register discipline, and store health. Invoke after adding/editing entries, on a cadence, or before a release that touches the vocabulary store. Runs the deterministic `lint.cjs` if the runtime is present (`node plugins/compendium/lint.cjs [--reindex]`); otherwise applies the same seven checks by inspection. Portable: the checks are defined over plain markdown+frontmatter, so they hold for any vault (a dashboard store, an Obsidian vault, a provider memory directory). Pairs with `compendium-curate` (curate first, then lint).

Code & Development 7 stars 0 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 81/100

Stars 20%
30
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Compendium Lint — gardening checks for the vocabulary store A controlled-vocabulary store degrades silently: a renamed heading orphans a pointer, a copied definition drifts, a superseded term keeps getting cited. These checks make that degradation **computable**, like a build's verify pass. **Four hard** (build-failing) + **three soft** (gardening signal) — seven checks total. This is the runtime's severity view of the spec's §9 grouping: the four gardening lints (broken-link · orphan · duplicate-concept · stale) plus the pointer-resolution check (slug resolution · no-competing-full-def · redaction) — same seven, sliced by severity instead of by family. ## If the runtime is present (preferred) ``` node plugins/compendium/lint.cjs # check only node plugins/compendium/lint.cjs --reindex # check + regenerate INDEX.md / index.json + the viewer-agnostic [[id]] projection node plugins/compendium/lint.cjs --quiet # exit code only (CI) ``` Exit `1` on any **hard** failure; `0` otherwise. Hard failures must be fixed before commit; soft warnings are a gardening worklist. ## If no runtime — apply the checks by inspection **HARD (must fix):** 1. **broken-link** — every id in `links:` resolves to an existing entry id. A dangling peer link is a hard failure. 2. **pointer-resolution** — `owner_spec` is of the form `<file>#<slug>`, the file exists, and the slug is an **actual heading** in that file (GitHub-style slug: lowercase, spaces→`-`, punctuation dropped). A point...

Details

Author
SoliEstre
Repository
SoliEstre/EstreGenesis
Created
2 months ago
Last Updated
today
Language
JavaScript
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category