elint 0.0.1

Erlang code 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

#[derive(Debug)]
pub struct ExpectRules {
    pub rules: Vec<ExpectRule>,
}

impl ExpectRules {
    pub fn new(parser: &crate::parse::Parser) -> Result<Self, crate::Error> {
        let mut rules = Vec::new();

        for comment in &parser.comments {
            let text = comment.text(&parser.text);
            let Some(text) = text.strip_prefix("%%").and_then(|t| t.lines().next()) else {
                continue;
            };
            let text = text.trim();

            let Some(text) = text.strip_prefix("ELINT_EXPECT:") else {
                continue;
            };
            let text = text.trim();

            let Some(target_span) = parser
                .items
                .binary_search_by_key(&comment.span, |t| t.span)
                .err()
                .and_then(|i| parser.items.get(i).map(|t| t.span))
            else {
                continue;
            };

            for name in text.split(',') {
                let name = name.trim();
                let Some(rule) = crate::RULES.iter().find(|v| v.name == name) else {
                    return Err(crate::Error::new(
                        comment.span,
                        format!("unknown rule: {name}"),
                    ));
                };

                rules.push(ExpectRule {
                    name: rule.name,
                    comment_span: comment.span,
                    target_span,
                    matched: false,
                });
            }
        }

        Ok(Self { rules })
    }

    pub fn handle_error(&mut self, lint_name: &'static str, span: crate::Span) -> bool {
        let mut expected = false;
        for rule in &mut self.rules {
            if rule.name == lint_name && rule.target_span.contains(span) {
                rule.matched = true;
                expected = true;
            }
        }
        expected
    }

    pub fn unmatched_expectations(&self) -> impl Iterator<Item = (&'static str, crate::Span)> {
        self.rules
            .iter()
            .filter(|r| !r.matched)
            .map(|r| (r.name, r.comment_span))
    }
}

#[derive(Debug)]
pub struct ExpectRule {
    pub name: &'static str,
    pub comment_span: crate::Span,
    pub target_span: crate::Span,
    pub matched: bool,
}