selene-lib 0.30.0

A library for linting Lua code. You probably want selene instead.
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

use super::*;
use crate::ast_util::range;
use std::convert::Infallible;

use full_moon::{
    ast::{self, Ast},
    visitors::Visitor,
};

pub struct MixedTableLint;

impl Lint for MixedTableLint {
    type Config = ();
    type Error = Infallible;

    const SEVERITY: Severity = Severity::Warning;
    const LINT_TYPE: LintType = LintType::Correctness;

    fn new(_: Self::Config) -> Result<Self, Self::Error> {
        Ok(MixedTableLint)
    }

    fn pass(&self, ast: &Ast, _: &Context, _: &AstContext) -> Vec<Diagnostic> {
        let mut visitor = MixedTableVisitor::default();

        visitor.visit_ast(ast);

        let mut diagnostics = Vec::new();

        for mixed_table in visitor.mixed_tables {
            diagnostics.push(Diagnostic::new_complete(
                "mixed_table",
                "mixed tables should be avoided, as they can cause confusing and hard to debug issues such as during iteration or encoding".to_owned(),
                Label::new(mixed_table.range),
                vec!["help: change this table to either an array or dictionary".to_owned()],
                Vec::new(),
            ));
        }

        diagnostics
    }
}

#[derive(Default)]
struct MixedTableVisitor {
    mixed_tables: Vec<MixedTable>,
}

struct MixedTable {
    range: (usize, usize),
}

impl Visitor for MixedTableVisitor {
    fn visit_table_constructor(&mut self, node: &ast::TableConstructor) {
        let mut last_key_field_starting_range = 0;
        let mut last_no_key_field_starting_range = 0;

        for field in node.fields() {
            if let ast::Field::NoKey(_) = field {
                if last_key_field_starting_range > 0 {
                    self.mixed_tables.push(MixedTable {
                        range: (last_key_field_starting_range, range(field).1),
                    });
                    return;
                }
                last_no_key_field_starting_range = range(field).0;
            } else {
                if last_no_key_field_starting_range > 0 {
                    self.mixed_tables.push(MixedTable {
                        range: (last_no_key_field_starting_range, range(field).1),
                    });
                    return;
                }
                last_key_field_starting_range = range(field).0;
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::{super::test_util::test_lint, *};

    #[test]
    fn test_mixed_table() {
        test_lint(
            MixedTableLint::new(()).unwrap(),
            "mixed_table",
            "mixed_table",
        );
    }
}