markdownlint-rs 0.1.0

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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

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

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

    if override_cfg.fix {
        base.fix = true;
    }

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

    if !override_cfg.gitignore {
        base.gitignore = false;
    }

    if !override_cfg.globs.is_empty() {
        base.globs.extend(override_cfg.globs);
    }

    if !override_cfg.ignores.is_empty() {
        base.ignores.extend(override_cfg.ignores);
    }

    if !override_cfg.markdown_it_plugins.is_empty() {
        base.markdown_it_plugins
            .extend(override_cfg.markdown_it_plugins);
    }

    if override_cfg.no_banner {
        base.no_banner = true;
    }

    if override_cfg.no_progress {
        base.no_progress = true;
    }

    if override_cfg.no_inline_config {
        base.no_inline_config = true;
    }

    if !override_cfg.output_formatters.is_empty() {
        base.output_formatters
            .extend(override_cfg.output_formatters);
    }

    for (rule_name, rule_config) in override_cfg.config {
        base.config.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::*;

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

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

    #[test]
    fn test_merge_configs_globs() {
        let base = Config {
            globs: vec!["*.md".to_string()],
            ..Default::default()
        };

        let override_cfg = Config {
            globs: vec!["**/*.markdown".to_string()],
            ..Default::default()
        };

        let merged = merge_configs(base, override_cfg);
        assert_eq!(merged.globs.len(), 2);
        assert!(merged.globs.contains(&"*.md".to_string()));
        assert!(merged.globs.contains(&"**/*.markdown".to_string()));
    }

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

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

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

    #[test]
    fn test_merge_many_configs() {
        let config1 = Config {
            globs: vec!["*.md".to_string()],
            ..Default::default()
        };

        let config2 = Config {
            globs: vec!["*.markdown".to_string()],
            fix: true,
            ..Default::default()
        };

        let config3 = Config {
            no_banner: true,
            ..Default::default()
        };

        let merged = merge_many_configs(vec![config1, config2, config3]);
        assert_eq!(merged.globs.len(), 2);
        assert!(merged.fix);
        assert!(merged.no_banner);
    }
}