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
78
79
80
81
82
83
84

pub mod command_parse;
pub mod expect;
pub mod fs;
pub mod item;
pub mod parse;
pub mod rule_element_bif;
pub mod rule_nested_cases;
pub mod token;

pub use item::Span;

#[derive(Debug)]
pub struct Error {
    pub span: item::Span,
    pub message: String,
}

impl Error {
    pub fn new(span: item::Span, message: impl Into<String>) -> Self {
        Self {
            span,
            message: message.into(),
        }
    }

    pub fn fix_span(mut self, span: item::Span) -> Self {
        self.span = span;
        self
    }
}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{} ({:?})", self.message, self.span)
    }
}

impl std::error::Error for Error {}

#[derive(Debug)]
pub struct Ast {
    pub text: String,
    pub items: Vec<item::Item>,
}

impl Ast {
    pub fn root(&self) -> item::ItemView<'_> {
        item::ItemView::new(&self.text, &self.items, 0)
    }

    pub fn text(&self, span: item::Span) -> &str {
        span.text(&self.text)
    }

    pub fn item_views(&self) -> impl Iterator<Item = item::ItemView<'_>> {
        (0..self.items.len()).map(|i| item::ItemView::new(&self.text, &self.items, i))
    }

    pub fn is_atom(&self, t: item::ItemView, name: &str) -> bool {
        t.kind() == item::ItemKind::Atom && self.text(t.span()) == name
    }

    pub fn is_tagged_tuple(&self, t: item::ItemView, tag: &str) -> bool {
        t.kind() == item::ItemKind::Tuple
            && t.children()
                .next()
                .is_some_and(|t| self.text(t.span()) == tag)
    }
}

#[derive(Debug)]
pub struct Rule {
    pub name: &'static str,
    pub text: &'static str,
    pub check: fn(&Ast) -> Vec<Span>,
}

impl Rule {
    pub const fn new(name: &'static str, text: &'static str, check: fn(&Ast) -> Vec<Span>) -> Self {
        Self { name, text, check }
    }
}

pub const RULES: &[Rule] = &[rule_nested_cases::RULE, rule_element_bif::RULE];