Skip to main content

Module lint_docs

Module lint_docs 

Source
Expand description

drep lint-docs - rule-based markdown checks. No LLM, no network.

This command runs on every commit, so its startup path is load-bearing. It touches crate::docs, crate::files and - in --staged mode only - crate::diff, and nothing else: no config file is read, no provider chain is built, no response cache is opened. The 1.x equivalent imported its workflows at module scope and paid 190 ms of sqlalchemy and GitPython on every commit for a command that needs neither.

Two exit rules, and they are independent:

  • A file the user named that drep could not analyze exits 2, whether or not --strict was passed. “Report-only” governs findings; a file that went unread is not a finding, it is the absence of analysis, and that is the one thing drep never reports as clean.
  • Findings exit 1 only at or above --fail-on, which is unset by default. The default is report-only because the checks include whitespace and line length, and a gate that blocks a commit over a trailing space is a gate that gets switched off. --strict is the shorthand for --fail-on info: one mechanism, asked at two thresholds.

Structs§

LintDocsArgs
LintOutcome
Everything one lint-docs run produced.

Enums§

Gating
What a run’s threshold did to its findings.

Functions§

run
One lint-docs invocation.