rumdl 0.1.51

A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)
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

use crate::rule_config_serde::RuleConfig;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct MD044Config {
    #[serde(default)]
    pub names: Vec<String>,

    #[serde(default = "default_code_blocks", rename = "code-blocks", alias = "code_blocks")]
    pub code_blocks: bool,

    #[serde(default = "default_html_elements", rename = "html-elements", alias = "html_elements")]
    pub html_elements: bool,

    #[serde(default = "default_html_comments", rename = "html-comments", alias = "html_comments")]
    pub html_comments: bool,
}

impl Default for MD044Config {
    fn default() -> Self {
        Self {
            names: Vec::new(),
            code_blocks: default_code_blocks(),
            html_elements: default_html_elements(),
            html_comments: default_html_comments(),
        }
    }
}

fn default_code_blocks() -> bool {
    false
}

fn default_html_elements() -> bool {
    true
}

fn default_html_comments() -> bool {
    true
}

impl RuleConfig for MD044Config {
    const RULE_NAME: &'static str = "MD044";
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_kebab_case_canonical_format() {
        let toml_str = r#"
            names = ["JavaScript", "TypeScript"]
            code-blocks = false
            html-comments = false
        "#;
        let config: MD044Config = toml::from_str(toml_str).unwrap();
        assert_eq!(config.names, vec!["JavaScript", "TypeScript"]);
        assert!(!config.code_blocks);
        assert!(!config.html_comments);
    }

    #[test]
    fn test_snake_case_backwards_compatibility() {
        let toml_str = r#"
            names = ["Python", "Rust"]
            code_blocks = false
            html_comments = false
        "#;
        let config: MD044Config = toml::from_str(toml_str).unwrap();
        assert_eq!(config.names, vec!["Python", "Rust"]);
        assert!(!config.code_blocks);
        assert!(!config.html_comments);
    }

    #[test]
    fn test_mixed_formats() {
        // Test that kebab-case and snake_case can be mixed
        let toml_str = r#"
            names = ["Node.js"]
            code-blocks = true
            html_comments = false
        "#;
        let config: MD044Config = toml::from_str(toml_str).unwrap();
        assert_eq!(config.names, vec!["Node.js"]);
        assert!(config.code_blocks);
        assert!(!config.html_comments);
    }

    #[test]
    fn test_default_values() {
        let config = MD044Config::default();
        assert!(config.names.is_empty());
        assert!(!config.code_blocks);
        assert!(config.html_elements);
        assert!(config.html_comments);
    }
}