Expand description
Opinionated bundle health checks, beyond conformance and validation.
validate_bundle enforces the spec’s hard
conformance requirements and reports material deviations, data integrity
problems, broken links, temporal inconsistencies, and contract issues as
validation warnings. lint_bundle goes further into opinionated
authoring hygiene, markdown prose layout, code-block syntax tagging,
and whitespace formatting.
Every finding is tagged with a stable rule code (L1..L12) so CI can pin or
silence individual checks. None of them is a conformance failure: a bundle
with lint findings is still conformant if validate_bundle says so, which
is why okf lint is a separate command rather than a stricter
okf validate.
| Code | Severity | Finding |
|---|---|---|
| L1 | warning | body has no top-level # heading |
| L2 | info | frontmatter keys not in canonical preferred order |
| L3 | warning | heading hierarchy drift (heading levels skipped or multiple #) |
| L4 | warning | empty / stub section heading with no content |
| L5 | info | source declared in frontmatter but never cited with footnote |
| L6 | info | non-standard actor identity in generated, verified, or author |
| L7 | warning | # Computation code block missing language tag |
| L8 | info | trailing whitespace or excess blank lines in markdown body |
| L9 | warning | orphan: no inbound links and not listed in any index.md |
| L10 | info | self-link (concept links to itself) |
| L11 | info | no verified events, trust tier is unverified |
| L12 | info | status: draft |
Functions§
- lint_
bundle - Lints a loaded bundle, returning all findings.
- lint_
bundle_ at - Lints a bundle, returning all opinionated formatting and style findings.