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;
33mod md036_no_emphasis_only_first;
34mod md037_spaces_around_emphasis;
35mod md038_no_space_in_code;
36mod md039_no_space_in_links;
37mod 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;
58
59pub use md001_heading_increment::MD001HeadingIncrement;
60pub use md003_heading_style::MD003HeadingStyle;
61pub use md004_unordered_list_style::MD004UnorderedListStyle;
62pub use md004_unordered_list_style::UnorderedListStyle;
63pub use md005_list_indent::MD005ListIndent;
64pub use md007_ul_indent::MD007ULIndent;
65pub use md009_trailing_spaces::MD009TrailingSpaces;
66pub use md010_no_hard_tabs::MD010NoHardTabs;
67pub use md011_no_reversed_links::MD011NoReversedLinks;
68pub use md013_line_length::MD013LineLength;
69pub use md014_commands_show_output::MD014CommandsShowOutput;
70pub use md024_no_duplicate_heading::MD024NoDuplicateHeading;
71pub use md025_single_title::MD025SingleTitle;
72pub use md026_no_trailing_punctuation::MD026NoTrailingPunctuation;
73pub use md027_multiple_spaces_blockquote::MD027MultipleSpacesBlockquote;
74pub use md028_no_blanks_blockquote::MD028NoBlanksBlockquote;
75pub use md029_ordered_list_prefix::{ListStyle, MD029OrderedListPrefix};
76pub use md030_list_marker_space::MD030ListMarkerSpace;
77pub use md031_blanks_around_fences::MD031BlanksAroundFences;
78pub use md032_blanks_around_lists::MD032BlanksAroundLists;
79pub use md033_no_inline_html::MD033NoInlineHtml;
80pub use md034_no_bare_urls::MD034NoBareUrls;
81pub use md035_hr_style::MD035HRStyle;
82pub use md036_no_emphasis_only_first::MD036NoEmphasisAsHeading;
83pub use md037_spaces_around_emphasis::MD037NoSpaceInEmphasis;
84pub use md038_no_space_in_code::MD038NoSpaceInCode;
85pub use md039_no_space_in_links::MD039NoSpaceInLinks;
86pub use md040_fenced_code_language::MD040FencedCodeLanguage;
87pub use md041_first_line_heading::MD041FirstLineHeading;
88pub use md042_no_empty_links::MD042NoEmptyLinks;
89pub use md043_required_headings::MD043RequiredHeadings;
90pub use md044_proper_names::MD044ProperNames;
91pub use md045_no_alt_text::MD045NoAltText;
92pub use md046_code_block_style::MD046CodeBlockStyle;
93pub use md047_single_trailing_newline::MD047SingleTrailingNewline;
94pub use md048_code_fence_style::MD048CodeFenceStyle;
95pub use md049_emphasis_style::MD049EmphasisStyle;
96pub use md050_strong_style::MD050StrongStyle;
97pub use md051_link_fragments::MD051LinkFragments;
98pub use md052_reference_links_images::MD052ReferenceLinkImages;
99pub use md053_link_image_reference_definitions::MD053LinkImageReferenceDefinitions;
100pub use md054_link_image_style::MD054LinkImageStyle;
101pub use md055_table_pipe_style::MD055TablePipeStyle;
102pub use md056_table_column_count::MD056TableColumnCount;
103pub use md058_blanks_around_tables::MD058BlanksAroundTables;
104pub use md059_link_text::MD059LinkText;
105pub use md060_table_format::MD060TableFormat;
106pub use md061_forbidden_terms::MD061ForbiddenTerms;
107
108mod md012_no_multiple_blanks;
109pub use md012_no_multiple_blanks::MD012NoMultipleBlanks;
110
111mod md018_no_missing_space_atx;
112pub use md018_no_missing_space_atx::MD018NoMissingSpaceAtx;
113
114mod md019_no_multiple_space_atx;
115pub use md019_no_multiple_space_atx::MD019NoMultipleSpaceAtx;
116
117mod md020_no_missing_space_closed_atx;
118mod md021_no_multiple_space_closed_atx;
119pub use md020_no_missing_space_closed_atx::MD020NoMissingSpaceClosedAtx;
120pub use md021_no_multiple_space_closed_atx::MD021NoMultipleSpaceClosedAtx;
121
122mod md022_blanks_around_headings;
123pub use md022_blanks_around_headings::MD022BlanksAroundHeadings;
124
125mod md023_heading_start_left;
126pub use md023_heading_start_left::MD023HeadingStartLeft;
127
128mod md057_existing_relative_links;
129
130pub use md057_existing_relative_links::MD057ExistingRelativeLinks;
131
132use crate::rule::Rule;
133
134/// Returns all rule instances for config validation and CLI
135pub fn all_rules(config: &crate::config::Config) -> Vec<Box<dyn Rule>> {
136    type RuleCtor = fn(&crate::config::Config) -> Box<dyn Rule>;
137    const RULES: &[(&str, RuleCtor)] = &[
138        ("MD001", MD001HeadingIncrement::from_config),
139        ("MD003", MD003HeadingStyle::from_config),
140        ("MD004", MD004UnorderedListStyle::from_config),
141        ("MD005", MD005ListIndent::from_config),
142        ("MD007", MD007ULIndent::from_config),
143        ("MD009", MD009TrailingSpaces::from_config),
144        ("MD010", MD010NoHardTabs::from_config),
145        ("MD011", MD011NoReversedLinks::from_config),
146        ("MD012", MD012NoMultipleBlanks::from_config),
147        ("MD013", MD013LineLength::from_config),
148        ("MD014", MD014CommandsShowOutput::from_config),
149        ("MD018", MD018NoMissingSpaceAtx::from_config),
150        ("MD019", MD019NoMultipleSpaceAtx::from_config),
151        ("MD020", MD020NoMissingSpaceClosedAtx::from_config),
152        ("MD021", MD021NoMultipleSpaceClosedAtx::from_config),
153        ("MD022", MD022BlanksAroundHeadings::from_config),
154        ("MD023", MD023HeadingStartLeft::from_config),
155        ("MD024", MD024NoDuplicateHeading::from_config),
156        ("MD025", MD025SingleTitle::from_config),
157        ("MD026", MD026NoTrailingPunctuation::from_config),
158        ("MD027", MD027MultipleSpacesBlockquote::from_config),
159        ("MD028", MD028NoBlanksBlockquote::from_config),
160        ("MD029", MD029OrderedListPrefix::from_config),
161        ("MD030", MD030ListMarkerSpace::from_config),
162        ("MD031", MD031BlanksAroundFences::from_config),
163        ("MD032", MD032BlanksAroundLists::from_config),
164        ("MD033", MD033NoInlineHtml::from_config),
165        ("MD034", MD034NoBareUrls::from_config),
166        ("MD035", MD035HRStyle::from_config),
167        ("MD036", MD036NoEmphasisAsHeading::from_config),
168        ("MD037", MD037NoSpaceInEmphasis::from_config),
169        ("MD038", MD038NoSpaceInCode::from_config),
170        ("MD039", MD039NoSpaceInLinks::from_config),
171        ("MD040", MD040FencedCodeLanguage::from_config),
172        ("MD041", MD041FirstLineHeading::from_config),
173        ("MD042", MD042NoEmptyLinks::from_config),
174        ("MD043", MD043RequiredHeadings::from_config),
175        ("MD044", MD044ProperNames::from_config),
176        ("MD045", MD045NoAltText::from_config),
177        ("MD046", MD046CodeBlockStyle::from_config),
178        ("MD047", MD047SingleTrailingNewline::from_config),
179        ("MD048", MD048CodeFenceStyle::from_config),
180        ("MD049", MD049EmphasisStyle::from_config),
181        ("MD050", MD050StrongStyle::from_config),
182        ("MD051", MD051LinkFragments::from_config),
183        ("MD052", MD052ReferenceLinkImages::from_config),
184        ("MD053", MD053LinkImageReferenceDefinitions::from_config),
185        ("MD054", MD054LinkImageStyle::from_config),
186        ("MD055", MD055TablePipeStyle::from_config),
187        ("MD056", MD056TableColumnCount::from_config),
188        ("MD057", MD057ExistingRelativeLinks::from_config),
189        ("MD058", MD058BlanksAroundTables::from_config),
190        ("MD059", MD059LinkText::from_config),
191        ("MD060", MD060TableFormat::from_config),
192        ("MD061", MD061ForbiddenTerms::from_config),
193    ];
194    RULES.iter().map(|(_, ctor)| ctor(config)).collect()
195}
196
197// Filter rules based on config (moved from main.rs)
198// Note: This needs access to GlobalConfig from the config module.
199use crate::config::GlobalConfig;
200use std::collections::HashSet;
201
202pub fn filter_rules(rules: &[Box<dyn Rule>], global_config: &GlobalConfig) -> Vec<Box<dyn Rule>> {
203    let mut enabled_rules: Vec<Box<dyn Rule>> = Vec::new();
204    let disabled_rules: HashSet<String> = global_config.disable.iter().cloned().collect();
205
206    // Handle 'disable: ["all"]'
207    if disabled_rules.contains("all") {
208        // If 'enable' is also provided, only those rules are enabled, overriding "disable all"
209        if !global_config.enable.is_empty() {
210            let enabled_set: HashSet<String> = global_config.enable.iter().cloned().collect();
211            for rule in rules {
212                if enabled_set.contains(rule.name()) {
213                    // Clone the rule (rules need to implement Clone or we need another approach)
214                    // For now, assuming rules are copyable/default constructible easily is complex.
215                    // Let's recreate the rule instance instead. This is brittle.
216                    // A better approach would involve rule registration and instantiation by name.
217                    // --> Reverting to filtering the input slice by cloning Box<dyn Rule>.
218                    enabled_rules.push(dyn_clone::clone_box(&**rule));
219                }
220            }
221        }
222        // If 'enable' is empty and 'disable: ["all"]', return empty vector.
223        return enabled_rules;
224    }
225
226    // If 'enable' is specified, only use those rules
227    if !global_config.enable.is_empty() {
228        let enabled_set: HashSet<String> = global_config.enable.iter().cloned().collect();
229        for rule in rules {
230            if enabled_set.contains(rule.name()) && !disabled_rules.contains(rule.name()) {
231                enabled_rules.push(dyn_clone::clone_box(&**rule));
232            }
233        }
234    } else {
235        // Otherwise, use all rules except the disabled ones
236        for rule in rules {
237            if !disabled_rules.contains(rule.name()) {
238                enabled_rules.push(dyn_clone::clone_box(&**rule));
239            }
240        }
241    }
242
243    enabled_rules
244}
rumdl_lib/rules/mod.rs

rumdl_lib/rules/
mod.rs
