rulewright 0.1.2

Executable engineering standards for Rust workspaces
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

#[cfg(test)]
use googletest::prelude::*;

use crate::{Example, FileCtx, Fix, Violation, violation};

#[rustfmt::skip]
const EXAMPLES: &[Example] = &[
    Example {
        label: "clean file",
        code: "fn main() {}",
        pass: true,
    },
    Example {
        label: "trailing whitespace",
        code: "let x = 1;   \nlet y = 2;",
        pass: false,
    },
    Example {
        label: "tab character",
        code: "\tlet x = 1;",
        pass: false,
    },
];

crate::line_rule!(
    style,
    "Enforce no trailing whitespace, no tabs, no CRLF line endings.",
    "Trailing whitespace, tabs, and CRLF endings cause noisy diffs and merge conflicts.",
    Low,
    fix_style,
);

fn check_style(ctx: &FileCtx<'_>) -> Vec<Violation> {
    let mut out = Vec::new();

    for (i, line) in ctx.lines.iter().enumerate() {
        let lineno = i + 1;

        if *line != line.trim_end() {
            out.push(violation(ctx.rel, lineno, "trailing whitespace"));
        }

        if line.contains('\t') {
            out.push(violation(ctx.rel, lineno, "tab character (use spaces)"));
        }

        if line.contains('\r') {
            out.push(violation(ctx.rel, lineno, "CR line ending (use LF)"));
        }
    }

    out
}

fn fix_style(ctx: &FileCtx<'_>, v: &Violation) -> Option<Fix> {
    let line = ctx.line(v.line)?;
    let fixed = line.replace('\t', "    ").replace('\r', "");

    Some(Fix::replace_line(v.line, fixed.trim_end()))
}

crate::rulewright_test!(check_style, {
    crate::example_tests!(EXAMPLES, check_style);
    crate::fix_tests!(EXAMPLES, line, check_style, fix_style);

    #[gtest]
    fn cr_line_ending() -> Result<()> {
        let v = run("let x = 1;\r");
        verify_false!(v.is_empty())?;
        verify_true!(v.iter().any(|v| v.message.contains("CR line ending")))?;

        Ok(())
    }

    #[gtest]
    fn multiple_violations_on_one_line() -> Result<()> {
        let v = run("\tlet x = 1;  ");
        verify_eq!(v.len(), 2)?;

        Ok(())
    }
});