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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

use crate::lint::rule::Rule;
use crate::markdown::MarkdownParser;
use crate::types::Violation;
use pulldown_cmark::{CodeBlockKind, Event, Tag};
use serde_json::Value;

pub struct MD046;

impl Rule for MD046 {
    fn name(&self) -> &str {
        "MD046"
    }

    fn description(&self) -> &str {
        "Code block style"
    }

    fn tags(&self) -> &[&str] {
        &["code"]
    }

    fn check(&self, parser: &MarkdownParser, config: Option<&Value>) -> Vec<Violation> {
        let style = config
            .and_then(|c| c.get("style"))
            .and_then(|v| v.as_str())
            .unwrap_or("fenced");

        let mut violations = Vec::new();
        let mut first_style: Option<&str> = None;

        for (event, range) in parser.parse_with_offsets() {
            let line = parser.offset_to_line(range.start);

            match event {
                Event::Start(Tag::CodeBlock(CodeBlockKind::Fenced(_))) => {
                    let current_style = "fenced";

                    if style == "consistent" {
                        if let Some(first) = first_style {
                            if current_style != first {
                                violations.push(Violation {
                                    line,
                                    column: Some(1),
                                    rule: self.name().to_string(),
                                    message: format!(
                                        "Code block style should be consistent: expected {}, found {}",
                                        first, current_style
                                    ),
                                    fix: None,
                                });
                            }
                        } else {
                            first_style = Some(current_style);
                        }
                    } else if style == "indented" {
                        violations.push(Violation {
                            line,
                            column: Some(1),
                            rule: self.name().to_string(),
                            message: "Code block style should be 'indented', found 'fenced'"
                                .to_string(),
                            fix: None,
                        });
                    }
                }
                Event::Start(Tag::CodeBlock(CodeBlockKind::Indented)) => {
                    let current_style = "indented";

                    if style == "consistent" {
                        if let Some(first) = first_style {
                            if current_style != first {
                                violations.push(Violation {
                                    line,
                                    column: Some(1),
                                    rule: self.name().to_string(),
                                    message: format!(
                                        "Code block style should be consistent: expected {}, found {}",
                                        first, current_style
                                    ),
                                    fix: None,
                                });
                            }
                        } else {
                            first_style = Some(current_style);
                        }
                    } else if style == "fenced" {
                        violations.push(Violation {
                            line,
                            column: Some(1),
                            rule: self.name().to_string(),
                            message: "Code block style should be 'fenced', found 'indented'"
                                .to_string(),
                            fix: None,
                        });
                    }
                }
                _ => {}
            }
        }

        violations
    }

    fn fixable(&self) -> bool {
        false
    }
}

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

    #[test]
    fn test_consistent_fenced() {
        let content = "```\ncode1\n```\n\n```\ncode2\n```";
        let parser = MarkdownParser::new(content);
        let rule = MD046;
        let violations = rule.check(&parser, None);

        assert_eq!(violations.len(), 0);
    }

    #[test]
    fn test_consistent_indented() {
        let content = "    code1\n\n    code2";
        let parser = MarkdownParser::new(content);
        let rule = MD046;
        let config = serde_json::json!({ "style": "consistent" });
        let violations = rule.check(&parser, Some(&config));

        assert_eq!(violations.len(), 0);
    }

    #[test]
    fn test_inconsistent() {
        let content = "```\ncode1\n```\n\n    code2";
        let parser = MarkdownParser::new(content);
        let rule = MD046;
        let violations = rule.check(&parser, None);

        assert_eq!(violations.len(), 1);
    }

    #[test]
    fn test_enforced_fenced() {
        let content = "    code";
        let parser = MarkdownParser::new(content);
        let rule = MD046;
        let config = serde_json::json!({ "style": "fenced" });
        let violations = rule.check(&parser, Some(&config));

        assert_eq!(violations.len(), 1);
    }
}