Expand description
The standard library of lint rules.
Every rule here implements crate::LintRule. The constructors
defaults and all return ready-made RuleSets; by_name
looks up a fresh instance of one stdlib rule by its kebab-case
name, used by the CLI’s --rules parser.
§Rules
| Name | Default | Advisory |
|---|---|---|
unbalanced-backtick | yes | no |
math/unbalanced-delim | yes | no |
math/unbalanced-env | yes | no |
math/unbalanced-braces | yes | no |
adjacent-code-no-space | yes | no |
heading-punctuation | yes | no |
orphan-reference-link | yes | no |
duplicate-link-label | yes | no |
bare-url | yes | no |
trailing-whitespace | yes | no |
inconsistent-list-marker | yes | no |
list-tightness-flipped | no | yes |
duplicate-heading | yes | no |
unicodeable-subscript | yes | yes |
info-string-typo | yes | yes |
stray-dollar | no | no |
latex-command | no | no |
escaped-emphasis | no | no |
subscript-damage | no | no |
Structs§
- Adjacent
Code NoSpace - BareUrl
- Duplicate
Heading - Duplicate
Link Label - Escaped
Emphasis - Heading
Punctuation - Inconsistent
List Marker - Info
String Typo - Latex
Command - List
Tightness Flipped - Math
Unbalanced Braces - Math
Unbalanced Delim - Math
Unbalanced Env - Orphan
Reference Link - Stray
Dollar - Subscript
Damage - Trailing
Whitespace - Unbalanced
Backtick - Unicodeable
Subscript
Constants§
- NAMES
- Every stdlib rule’s kebab-case name, in registration order.
Functions§
- all
- Every stdlib rule, including the default-off ones.
- by_name
- Construct a fresh instance of one stdlib rule by kebab-case name.
Returns
Noneifnameis not a stdlib rule. Used by the CLI’s--rulesparser to look up+rule-namemodifiers. - defaults
- The curated default-on subset.
- names
- Iterator over every stdlib rule’s kebab-case name. Used by the
suppression-map builder to validate names in
<!-- mdwright: ... -->comments without instantiating every rule.