Skip to main content

Module docs

Module docs 

Source
Expand description

Rule-based markdown checks. No LLM, no network, no configuration.

Ten checks over the text of a markdown file, run by drep lint-docs. This module deliberately imports nothing from llm, config or analysis beyond the Finding vocabulary: lint-docs runs on every commit, and must not construct a provider chain or open a response cache.

Structure:

  • fence answers “is this line inside a code fence”, once per file, for every check that asks. See its module doc for why that is not a per-check concern.
  • lines holds the checks that look at one line in isolation.
  • links holds the two that need markdown’s link grammar.
  • blocks holds the three that span more than one line.

The split is by what a check needs to see, not by file size, so a new check has an obvious home.

Enums§

Check
The ten checks.

Constants§

BLANK_RUN_MAX
Consecutive blank lines tolerated outside a code fence.
LONG_LINE_MAX
Longest line drep will accept outside a code fence.

Functions§

analyze
Run every check over content, reporting against path.