rumdl 0.0.12

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
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187

use crate::rule::{Fix, LintError, LintResult, LintWarning, Rule};

#[derive(Debug)]
pub struct MD007ULIndent {
    pub indent: usize,
}

impl Default for MD007ULIndent {
    fn default() -> Self {
        Self { indent: 2 }
    }
}

impl MD007ULIndent {
    pub fn new(indent: usize) -> Self {
        Self { indent }
    }

    fn is_list_item(line: &str) -> Option<(usize, char)> {
        let indentation = line.len() - line.trim_start().len();
        let trimmed = line.trim_start();
        
        if let Some(c) = trimmed.chars().next() {
            if (c == '*' || c == '-' || c == '+') && 
               (trimmed.len() == 1 || trimmed.chars().nth(1).map_or(false, |c| c.is_whitespace())) {
                return Some((indentation, c));
            }
        }
        None
    }

    fn is_list_continuation(line: &str) -> bool {
        let indent = line.len() - line.trim_start().len();
        indent > 0 && !line.trim().is_empty() && Self::is_list_item(line).is_none()
    }

    fn get_expected_indent(&self, level: usize) -> usize {
        level * self.indent
    }
}

impl Rule for MD007ULIndent {
    fn name(&self) -> &'static str {
        "MD007"
    }

    fn description(&self) -> &'static str {
        "Unordered list indentation"
    }

    fn check(&self, content: &str) -> LintResult {
        let mut warnings = Vec::new();
        let mut current_level = 0;
        let mut level_indents = vec![0];
        let mut in_list = false;

        for (line_num, line) in content.lines().enumerate() {
            if line.trim().is_empty() {
                continue;
            }

            if let Some((indent, marker)) = Self::is_list_item(line) {
                if indent > level_indents[current_level] {
                    // Going deeper
                    current_level += 1;
                    let expected_indent = self.get_expected_indent(current_level);
                    if current_level >= level_indents.len() {
                        level_indents.push(expected_indent);
                    }
                    if indent != expected_indent {
                        warnings.push(LintWarning {
                            line: line_num + 1,
                            column: indent + 1,
                            message: format!(
                                "List item with marker '{}' should be indented {} spaces (found {})",
                                marker, expected_indent, indent
                            ),
                            fix: Some(Fix {
                                line: line_num + 1,
                                column: 1,
                                replacement: format!("{}{}", " ".repeat(expected_indent), line.trim_start()),
                            }),
                        });
                    }
                } else {
                    // Same level or going back
                    while current_level > 0 && indent <= level_indents[current_level - 1] {
                        current_level -= 1;
                    }
                    let expected_indent = self.get_expected_indent(current_level);
                    if indent != expected_indent {
                        warnings.push(LintWarning {
                            line: line_num + 1,
                            column: indent + 1,
                            message: format!(
                                "List item with marker '{}' should be indented {} spaces (found {})",
                                marker, expected_indent, indent
                            ),
                            fix: Some(Fix {
                                line: line_num + 1,
                                column: 1,
                                replacement: format!("{}{}", " ".repeat(expected_indent), line.trim_start()),
                            }),
                        });
                    }
                }
                in_list = true;
            } else if Self::is_list_continuation(line) {
                if in_list {
                    let indent = line.len() - line.trim_start().len();
                    let expected_indent = self.get_expected_indent(current_level);
                    if indent != expected_indent {
                        warnings.push(LintWarning {
                            line: line_num + 1,
                            column: indent + 1,
                            message: format!(
                                "List continuation should be indented {} spaces (found {})",
                                expected_indent, indent
                            ),
                            fix: Some(Fix {
                                line: line_num + 1,
                                column: 1,
                                replacement: format!("{}{}", " ".repeat(expected_indent), line.trim_start()),
                            }),
                        });
                    }
                }
            } else {
                in_list = false;
                current_level = 0;
                level_indents.truncate(1);
            }
        }

        Ok(warnings)
    }

    fn fix(&self, content: &str) -> Result<String, LintError> {
        let mut result = String::new();
        let mut current_level = 0;
        let mut level_indents = vec![0];
        let mut in_list = false;

        for line in content.lines() {
            if line.trim().is_empty() {
                result.push_str(line);
                result.push('\n');
                continue;
            }

            if let Some((indent, _)) = Self::is_list_item(line) {
                if indent > level_indents[current_level] {
                    // Going deeper
                    current_level += 1;
                    let expected_indent = self.get_expected_indent(current_level);
                    if current_level >= level_indents.len() {
                        level_indents.push(expected_indent);
                    }
                    result.push_str(&format!("{}{}\n", " ".repeat(expected_indent), line.trim_start()));
                } else {
                    // Same level or going back
                    while current_level > 0 && indent <= level_indents[current_level - 1] {
                        current_level -= 1;
                    }
                    let expected_indent = self.get_expected_indent(current_level);
                    result.push_str(&format!("{}{}\n", " ".repeat(expected_indent), line.trim_start()));
                }
                in_list = true;
            } else if Self::is_list_continuation(line) && in_list {
                let expected_indent = self.get_expected_indent(current_level);
                result.push_str(&format!("{}{}\n", " ".repeat(expected_indent), line.trim_start()));
            } else {
                in_list = false;
                current_level = 0;
                level_indents.truncate(1);
                result.push_str(line);
                result.push('\n');
            }
        }

        if !content.ends_with('\n') {
            result.pop();
        }

        Ok(result)
    }
}