Skip to main content

Module lint

Module lint 

Source
Expand description

Vale and Harper lint for the markdown corpus (CLI + in-process harper-core).

Structsยง

LintFinding
One lint finding from any engine.
LintReport
Aggregated report from one or more engines.

Enumsยง

LintEngine
Which external (or in-process) lint engine to run.

Functionsยง

binary_available
Check whether a binary is on PATH and responds successfully to --version or --help.
domain_vocab_tokens ๐Ÿ”’
Domain tokens always allowed for spelling (tooling / corpus jargon). Also merged with styles/Vocab/canonic/accept.txt when present (Vale vocab).
format_report
Format a human-readable report to a string.
harper_binary_name
Resolve which binary name to use for Harper CLI (optional fallback).
harper_command_args
Construct Harper CLI args (best-effort across harper-cli naming).
harper_core_available
In-process harper-core is always linked in this build.
is_domain_vocab_spelling ๐Ÿ”’
lint_paths
Lint the given paths with the selected engine(s). Missing optional tools produce explicit entries in report.missing and do not panic. Harper always uses in-process harper-core when the Harper engine is selected.
lint_text_harper_inprocess
Lint a single text buffer with in-process harper-core (unit-testable pure path).
prose_paragraphs ๐Ÿ”’
Yield (1-based start line, paragraph text), skipping front matter, headings, fences, lists markers lightly.
run_harper_cli ๐Ÿ”’
run_harper_inprocess ๐Ÿ”’
run_vale ๐Ÿ”’
vale_command_args
Construct the Vale command line for the given paths (tested without running Vale).