markdownlint-rs 0.3.4

A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

use crate::config::types::{Config, RuleConfig};
use std::collections::HashMap;

pub fn merge_configs(mut base: Config, override_cfg: Config) -> Config {
    // Extend custom rules
    if !override_cfg.custom_rules.is_empty() {
        base.custom_rules.extend(override_cfg.custom_rules);
    }

    // Extend excludes
    if !override_cfg.exclude.is_empty() {
        base.exclude.extend(override_cfg.exclude);
    }

    base.default_enabled = override_cfg.default_enabled;
    base.fix = override_cfg.fix;

    // Override front_matter if set
    if override_cfg.front_matter.is_some() {
        base.front_matter = override_cfg.front_matter;
    }

    // Override gitignore setting
    if !override_cfg.gitignore {
        base.gitignore = false;
    }

    // Override no_inline_config if set
    if override_cfg.no_inline_config {
        base.no_inline_config = true;
    }

    // Merge rule configurations
    for (rule_name, rule_config) in override_cfg.rules {
        base.rules.insert(rule_name, rule_config);
    }

    base
}

pub fn merge_rule_configs(
    base: &HashMap<String, RuleConfig>,
    override_cfg: &HashMap<String, RuleConfig>,
) -> HashMap<String, RuleConfig> {
    let mut merged = base.clone();

    for (rule_name, rule_config) in override_cfg {
        merged.insert(rule_name.clone(), rule_config.clone());
    }

    merged
}

pub fn merge_many_configs(configs: Vec<Config>) -> Config {
    configs.into_iter().fold(Config::default(), merge_configs)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config::types::{Config, RuleConfig};

    #[test]
    fn test_merge_configs_default_enabled() {
        // Child config explicitly opting out overrides the default true
        let base = Config::default();
        let override_cfg = Config {
            default_enabled: false,
            ..Default::default()
        };

        let merged = merge_configs(base, override_cfg);
        assert!(!merged.default_enabled);
    }

    #[test]
    fn test_merge_configs_gitignore() {
        let base = Config {
            gitignore: true,
            ..Default::default()
        };

        let override_cfg = Config {
            gitignore: false,
            ..Default::default()
        };

        let merged = merge_configs(base, override_cfg);
        assert!(!merged.gitignore);
    }

    #[test]
    fn test_merge_configs_rules() {
        let mut base = Config::default();
        base.rules
            .insert("MD001".to_string(), RuleConfig::Enabled(true));

        let mut override_cfg = Config::default();
        override_cfg
            .rules
            .insert("MD002".to_string(), RuleConfig::Enabled(false));

        let merged = merge_configs(base, override_cfg);
        assert_eq!(merged.rules.len(), 2);
    }

    #[test]
    fn test_merge_many_configs() {
        let mut config1 = Config::default();
        config1
            .rules
            .insert("MD001".to_string(), RuleConfig::Enabled(true));

        let config2 = Config {
            default_enabled: true,
            gitignore: true, // Explicitly set to test merge
            ..Default::default()
        };

        let config3 = Config {
            no_inline_config: true,
            gitignore: true, // Keep gitignore enabled
            ..Default::default()
        };

        let merged = merge_many_configs(vec![config1, config2, config3]);
        assert!(merged.gitignore);
        assert!(merged.default_enabled);
        assert!(merged.no_inline_config);
        assert_eq!(merged.rules.len(), 1);
    }
}