Directories
¶
| Path | Synopsis |
|---|---|
|
Package config loads .doclint.yaml: rule defaults/toggles, per-rule settings, ignore globs, and the declarative custom-rule block.
|
Package config loads .doclint.yaml: rule defaults/toggles, per-rule settings, ignore globs, and the declarative custom-rule block. |
|
Package document turns a file's bytes into a Document: raw content, fence-aware source lines, and a parsed frontmatter/data map.
|
Package document turns a file's bytes into a Document: raw content, fence-aware source lines, and a parsed frontmatter/data map. |
|
Package engine discovers files, runs rules in parallel, applies inline suppression, and applies fixes or renders diffs.
|
Package engine discovers files, runs rules in parallel, applies inline suppression, and applies fixes or renders diffs. |
|
Package report renders findings as human-readable or JSON output.
|
Package report renders findings as human-readable or JSON output. |
|
Package rule defines the Rule interface, severity/fix-safety vocabulary, and the Finding/TextEdit types every rule emits.
|
Package rule defines the Rule interface, severity/fix-safety vocabulary, and the Finding/TextEdit types every rule emits. |
|
builtin
Package builtin holds programmatic (Go) rules.
|
Package builtin holds programmatic (Go) rules. |
Click to show internal directories.
Click to hide internal directories.