rumdl_lib/rules/
mod.rs

1pub mod code_block_utils;
2pub mod code_fence_utils;
3pub mod emphasis_style;
4pub mod front_matter_utils;
5pub mod heading_utils;
6pub mod list_utils;
7pub mod strong_style;
8
9pub mod blockquote_utils;
10
11mod md001_heading_increment;
12mod md003_heading_style;
13pub mod md004_unordered_list_style;
14mod md005_list_indent;
15mod md007_ul_indent;
16mod md009_trailing_spaces;
17mod md010_no_hard_tabs;
18mod md011_no_reversed_links;
19pub mod md013_line_length;
20mod md014_commands_show_output;
21mod md024_no_duplicate_heading;
22mod md025_single_title;
23mod md026_no_trailing_punctuation;
24mod md027_multiple_spaces_blockquote;
25mod md028_no_blanks_blockquote;
26mod md029_ordered_list_prefix;
27pub mod md030_list_marker_space;
28mod md031_blanks_around_fences;
29mod md032_blanks_around_lists;
30mod md033_no_inline_html;
31mod md034_no_bare_urls;
32mod md035_hr_style;
33pub mod md036_no_emphasis_only_first;
34mod md037_spaces_around_emphasis;
35mod md038_no_space_in_code;
36mod md039_no_space_in_links;
37pub mod md040_fenced_code_language;
38mod md041_first_line_heading;
39mod md042_no_empty_links;
40mod md043_required_headings;
41mod md044_proper_names;
42mod md045_no_alt_text;
43mod md046_code_block_style;
44mod md047_single_trailing_newline;
45mod md048_code_fence_style;
46mod md049_emphasis_style;
47mod md050_strong_style;
48mod md051_link_fragments;
49mod md052_reference_links_images;
50mod md053_link_image_reference_definitions;
51mod md054_link_image_style;
52mod md055_table_pipe_style;
53mod md056_table_column_count;
54mod md058_blanks_around_tables;
55mod md059_link_text;
56mod md060_table_format;
57mod md061_forbidden_terms;
58mod md062_link_destination_whitespace;
59mod md063_heading_capitalization;
60mod md064_no_multiple_consecutive_spaces;
61mod md065_blanks_around_horizontal_rules;
62mod md066_footnote_validation;
63mod md067_footnote_definition_order;
64mod md068_empty_footnote_definition;
65mod md069_no_duplicate_list_markers;
66mod md070_nested_code_fence;
67mod md071_blank_line_after_frontmatter;
68mod md072_frontmatter_key_sort;
69mod md073_toc_validation;
70
71pub use md001_heading_increment::MD001HeadingIncrement;
72pub use md003_heading_style::MD003HeadingStyle;
73pub use md004_unordered_list_style::MD004UnorderedListStyle;
74pub use md004_unordered_list_style::UnorderedListStyle;
75pub use md005_list_indent::MD005ListIndent;
76pub use md007_ul_indent::MD007ULIndent;
77pub use md009_trailing_spaces::MD009TrailingSpaces;
78pub use md010_no_hard_tabs::MD010NoHardTabs;
79pub use md011_no_reversed_links::MD011NoReversedLinks;
80pub use md013_line_length::MD013Config;
81pub use md013_line_length::MD013LineLength;
82pub use md014_commands_show_output::MD014CommandsShowOutput;
83pub use md024_no_duplicate_heading::MD024NoDuplicateHeading;
84pub use md025_single_title::MD025SingleTitle;
85pub use md026_no_trailing_punctuation::MD026NoTrailingPunctuation;
86pub use md027_multiple_spaces_blockquote::MD027MultipleSpacesBlockquote;
87pub use md028_no_blanks_blockquote::MD028NoBlanksBlockquote;
88pub use md029_ordered_list_prefix::{ListStyle, MD029OrderedListPrefix};
89pub use md030_list_marker_space::MD030ListMarkerSpace;
90pub use md031_blanks_around_fences::MD031BlanksAroundFences;
91pub use md032_blanks_around_lists::MD032BlanksAroundLists;
92pub use md033_no_inline_html::MD033NoInlineHtml;
93pub use md034_no_bare_urls::MD034NoBareUrls;
94pub use md035_hr_style::MD035HRStyle;
95pub use md036_no_emphasis_only_first::MD036NoEmphasisAsHeading;
96pub use md037_spaces_around_emphasis::MD037NoSpaceInEmphasis;
97pub use md038_no_space_in_code::MD038NoSpaceInCode;
98pub use md039_no_space_in_links::MD039NoSpaceInLinks;
99pub use md040_fenced_code_language::MD040FencedCodeLanguage;
100pub use md041_first_line_heading::MD041FirstLineHeading;
101pub use md042_no_empty_links::MD042NoEmptyLinks;
102pub use md043_required_headings::MD043RequiredHeadings;
103pub use md044_proper_names::MD044ProperNames;
104pub use md045_no_alt_text::MD045NoAltText;
105pub use md046_code_block_style::MD046CodeBlockStyle;
106pub use md047_single_trailing_newline::MD047SingleTrailingNewline;
107pub use md048_code_fence_style::MD048CodeFenceStyle;
108pub use md049_emphasis_style::MD049EmphasisStyle;
109pub use md050_strong_style::MD050StrongStyle;
110pub use md051_link_fragments::MD051LinkFragments;
111pub use md052_reference_links_images::MD052ReferenceLinkImages;
112pub use md053_link_image_reference_definitions::MD053LinkImageReferenceDefinitions;
113pub use md054_link_image_style::MD054LinkImageStyle;
114pub use md055_table_pipe_style::MD055TablePipeStyle;
115pub use md056_table_column_count::MD056TableColumnCount;
116pub use md058_blanks_around_tables::MD058BlanksAroundTables;
117pub use md059_link_text::MD059LinkText;
118pub use md060_table_format::ColumnAlign;
119pub use md060_table_format::MD060Config;
120pub use md060_table_format::MD060TableFormat;
121pub use md061_forbidden_terms::MD061ForbiddenTerms;
122pub use md062_link_destination_whitespace::MD062LinkDestinationWhitespace;
123pub use md063_heading_capitalization::MD063HeadingCapitalization;
124pub use md064_no_multiple_consecutive_spaces::MD064NoMultipleConsecutiveSpaces;
125pub use md065_blanks_around_horizontal_rules::MD065BlanksAroundHorizontalRules;
126pub use md066_footnote_validation::MD066FootnoteValidation;
127pub use md067_footnote_definition_order::MD067FootnoteDefinitionOrder;
128pub use md068_empty_footnote_definition::MD068EmptyFootnoteDefinition;
129pub use md069_no_duplicate_list_markers::MD069NoDuplicateListMarkers;
130pub use md070_nested_code_fence::MD070NestedCodeFence;
131pub use md071_blank_line_after_frontmatter::MD071BlankLineAfterFrontmatter;
132pub use md072_frontmatter_key_sort::MD072FrontmatterKeySort;
133pub use md073_toc_validation::MD073TocValidation;
134
135mod md012_no_multiple_blanks;
136pub use md012_no_multiple_blanks::MD012NoMultipleBlanks;
137
138mod md018_no_missing_space_atx;
139pub use md018_no_missing_space_atx::MD018NoMissingSpaceAtx;
140
141mod md019_no_multiple_space_atx;
142pub use md019_no_multiple_space_atx::MD019NoMultipleSpaceAtx;
143
144mod md020_no_missing_space_closed_atx;
145mod md021_no_multiple_space_closed_atx;
146pub use md020_no_missing_space_closed_atx::MD020NoMissingSpaceClosedAtx;
147pub use md021_no_multiple_space_closed_atx::MD021NoMultipleSpaceClosedAtx;
148
149mod md022_blanks_around_headings;
150pub use md022_blanks_around_headings::MD022BlanksAroundHeadings;
151
152mod md023_heading_start_left;
153pub use md023_heading_start_left::MD023HeadingStartLeft;
154
155mod md057_existing_relative_links;
156
157pub use md057_existing_relative_links::MD057ExistingRelativeLinks;
158
159use crate::rule::Rule;
160
161/// Type alias for rule constructor functions
162type RuleCtor = fn(&crate::config::Config) -> Box<dyn Rule>;
163
164/// Registry of all available rules with their constructor functions
165/// This enables automatic inline config support - the engine can recreate
166/// any rule with a merged config without per-rule opt-in
167const RULES: &[(&str, RuleCtor)] = &[
168    ("MD001", MD001HeadingIncrement::from_config),
169    ("MD003", MD003HeadingStyle::from_config),
170    ("MD004", MD004UnorderedListStyle::from_config),
171    ("MD005", MD005ListIndent::from_config),
172    ("MD007", MD007ULIndent::from_config),
173    ("MD009", MD009TrailingSpaces::from_config),
174    ("MD010", MD010NoHardTabs::from_config),
175    ("MD011", MD011NoReversedLinks::from_config),
176    ("MD012", MD012NoMultipleBlanks::from_config),
177    ("MD013", MD013LineLength::from_config),
178    ("MD014", MD014CommandsShowOutput::from_config),
179    ("MD018", MD018NoMissingSpaceAtx::from_config),
180    ("MD019", MD019NoMultipleSpaceAtx::from_config),
181    ("MD020", MD020NoMissingSpaceClosedAtx::from_config),
182    ("MD021", MD021NoMultipleSpaceClosedAtx::from_config),
183    ("MD022", MD022BlanksAroundHeadings::from_config),
184    ("MD023", MD023HeadingStartLeft::from_config),
185    ("MD024", MD024NoDuplicateHeading::from_config),
186    ("MD025", MD025SingleTitle::from_config),
187    ("MD026", MD026NoTrailingPunctuation::from_config),
188    ("MD027", MD027MultipleSpacesBlockquote::from_config),
189    ("MD028", MD028NoBlanksBlockquote::from_config),
190    ("MD029", MD029OrderedListPrefix::from_config),
191    ("MD030", MD030ListMarkerSpace::from_config),
192    ("MD031", MD031BlanksAroundFences::from_config),
193    ("MD032", MD032BlanksAroundLists::from_config),
194    ("MD033", MD033NoInlineHtml::from_config),
195    ("MD034", MD034NoBareUrls::from_config),
196    ("MD035", MD035HRStyle::from_config),
197    ("MD036", MD036NoEmphasisAsHeading::from_config),
198    ("MD037", MD037NoSpaceInEmphasis::from_config),
199    ("MD038", MD038NoSpaceInCode::from_config),
200    ("MD039", MD039NoSpaceInLinks::from_config),
201    ("MD040", MD040FencedCodeLanguage::from_config),
202    ("MD041", MD041FirstLineHeading::from_config),
203    ("MD042", MD042NoEmptyLinks::from_config),
204    ("MD043", MD043RequiredHeadings::from_config),
205    ("MD044", MD044ProperNames::from_config),
206    ("MD045", MD045NoAltText::from_config),
207    ("MD046", MD046CodeBlockStyle::from_config),
208    ("MD047", MD047SingleTrailingNewline::from_config),
209    ("MD048", MD048CodeFenceStyle::from_config),
210    ("MD049", MD049EmphasisStyle::from_config),
211    ("MD050", MD050StrongStyle::from_config),
212    ("MD051", MD051LinkFragments::from_config),
213    ("MD052", MD052ReferenceLinkImages::from_config),
214    ("MD053", MD053LinkImageReferenceDefinitions::from_config),
215    ("MD054", MD054LinkImageStyle::from_config),
216    ("MD055", MD055TablePipeStyle::from_config),
217    ("MD056", MD056TableColumnCount::from_config),
218    ("MD057", MD057ExistingRelativeLinks::from_config),
219    ("MD058", MD058BlanksAroundTables::from_config),
220    ("MD059", MD059LinkText::from_config),
221    ("MD060", MD060TableFormat::from_config),
222    ("MD061", MD061ForbiddenTerms::from_config),
223    ("MD062", MD062LinkDestinationWhitespace::from_config),
224    ("MD063", MD063HeadingCapitalization::from_config),
225    ("MD064", MD064NoMultipleConsecutiveSpaces::from_config),
226    ("MD065", MD065BlanksAroundHorizontalRules::from_config),
227    ("MD066", MD066FootnoteValidation::from_config),
228    ("MD067", MD067FootnoteDefinitionOrder::from_config),
229    ("MD068", MD068EmptyFootnoteDefinition::from_config),
230    ("MD069", MD069NoDuplicateListMarkers::from_config),
231    ("MD070", MD070NestedCodeFence::from_config),
232    ("MD071", MD071BlankLineAfterFrontmatter::from_config),
233    ("MD072", MD072FrontmatterKeySort::from_config),
234    ("MD073", MD073TocValidation::from_config),
235];
236
237/// Returns all rule instances for config validation and CLI
238pub fn all_rules(config: &crate::config::Config) -> Vec<Box<dyn Rule>> {
239    RULES.iter().map(|(_, ctor)| ctor(config)).collect()
240}
241
242/// Creates a single rule by name with the given config
243///
244/// This enables automatic inline config support - the engine can recreate
245/// any rule with a merged config without per-rule changes.
246///
247/// Returns None if the rule name is not found.
248pub fn create_rule_by_name(name: &str, config: &crate::config::Config) -> Option<Box<dyn Rule>> {
249    RULES
250        .iter()
251        .find(|(rule_name, _)| *rule_name == name)
252        .map(|(_, ctor)| ctor(config))
253}
254
255// Filter rules based on config (moved from main.rs)
256// Note: This needs access to GlobalConfig from the config module.
257use crate::config::GlobalConfig;
258use std::collections::HashSet;
259
260pub fn filter_rules(rules: &[Box<dyn Rule>], global_config: &GlobalConfig) -> Vec<Box<dyn Rule>> {
261    let mut enabled_rules: Vec<Box<dyn Rule>> = Vec::new();
262    let disabled_rules: HashSet<String> = global_config.disable.iter().cloned().collect();
263
264    // Handle 'disable: ["all"]'
265    if disabled_rules.contains("all") {
266        // If 'enable' is also provided, only those rules are enabled, overriding "disable all"
267        if !global_config.enable.is_empty() {
268            let enabled_set: HashSet<String> = global_config.enable.iter().cloned().collect();
269            for rule in rules {
270                if enabled_set.contains(rule.name()) {
271                    // Clone the rule (rules need to implement Clone or we need another approach)
272                    // For now, assuming rules are copyable/default constructible easily is complex.
273                    // Let's recreate the rule instance instead. This is brittle.
274                    // A better approach would involve rule registration and instantiation by name.
275                    // --> Reverting to filtering the input slice by cloning Box<dyn Rule>.
276                    enabled_rules.push(dyn_clone::clone_box(&**rule));
277                }
278            }
279        }
280        // If 'enable' is empty and 'disable: ["all"]', return empty vector.
281        return enabled_rules;
282    }
283
284    // If 'enable' is specified, only use those rules
285    if !global_config.enable.is_empty() {
286        let enabled_set: HashSet<String> = global_config.enable.iter().cloned().collect();
287        for rule in rules {
288            if enabled_set.contains(rule.name()) && !disabled_rules.contains(rule.name()) {
289                enabled_rules.push(dyn_clone::clone_box(&**rule));
290            }
291        }
292    } else {
293        // Otherwise, use all rules except the disabled ones
294        for rule in rules {
295            if !disabled_rules.contains(rule.name()) {
296                enabled_rules.push(dyn_clone::clone_box(&**rule));
297            }
298        }
299    }
300
301    enabled_rules
302}
rumdl_lib/rules/mod.rs

rumdl_lib/rules/
mod.rs
