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

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

#[derive(Debug, Default)]
pub struct MD047FileEndNewline;

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

    fn description(&self) -> &'static str {
        "Files should end with a single newline character"
    }

    fn check(&self, content: &str) -> LintResult {
        let mut warnings = Vec::new();
        let lines: Vec<&str> = content.lines().collect();

        if !lines.is_empty() {
            let has_trailing_newline = content.ends_with('\n');
            let has_multiple_newlines = content.ends_with("\n\n");

            if !has_trailing_newline || has_multiple_newlines {
                let last_line = lines.len();
                let last_column = lines.last().map_or(1, |line| line.len() + 1);
                
                warnings.push(LintWarning {
                    message: "File should end with a single newline character".to_string(),
                    line: last_line,
                    column: last_column,
                    fix: Some(Fix {
                        line: last_line,
                        column: last_column,
                        replacement: if has_trailing_newline {
                            // If there are multiple newlines, trim them and add a single one
                            content.trim_end().to_string() + "\n"
                        } else {
                            // If there's no newline, add one to the last line
                            lines.last().unwrap_or(&"").to_string() + "\n"
                        },
                    }),
                });
            }
        }

        Ok(warnings)
    }

    fn fix(&self, content: &str) -> Result<String, LintError> {
        let mut result = content.to_string();

        // If the content doesn't end with a newline, add one
        if !result.ends_with('\n') {
            result.push('\n');
            return Ok(result);
        }

        // If the content has multiple trailing newlines, remove extras
        while result.ends_with("\n\n") {
            result.pop();
        }

        Ok(result)
    }
}