natlint 0.1.0

A linter for Solidity natspec comments.
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

use solang_parser::pt::StructDefinition;

crate::missing_comment_rule!(
    MissingNotice,
    StructDefinition,
    Notice,
    "Structs must have a notice comment."
);

#[cfg(test)]
mod tests {
    use super::{MissingNotice, StructDefinition};
    use crate::{
        generate_missing_comment_test_cases,
        parser::{CommentTag, CommentsRef, Parser},
        rules::{violation_error::ViolationError, Rule, Violation},
    };
    use forge_fmt::Visitable;
    use solang_parser::parse;

    fn parse_source(src: &str) -> Parser {
        let (mut source, comments) = parse(src, 0).expect("failed to parse source");
        let mut doc = Parser::new(comments, src.to_owned());
        source.visit(&mut doc).expect("failed to visit source");
        doc
    }

    macro_rules! test_missingnotice {
        ($name:ident, $source:expr, $expected:expr) => {
            #[test]
            fn $name() {
                let src = parse_source($source);

                let parent = src.items_ref().first().unwrap();
                let child = parent.children.first().unwrap();
                let item = child.as_struct().unwrap();
                let comments = CommentsRef::from(&child.comments);

                let expected = $expected(item);

                assert_eq!(
                    MissingNotice::check(Some(parent), item, &comments),
                    expected
                );
            }
        };
    }

    generate_missing_comment_test_cases!(
        Notice,
        test_missingnotice,
        MissingNotice,
        r"
            struct TestStruct {
                uint256 a;
            }
        ",
        "@notice",
        StructDefinition
    );

    test_missingnotice!(
        no_tag_no_violation,
        r"
        contract Test {
            /// Some notice
            struct TestStruct {
                uint256 a;
            }
        }
        ",
        |_| None // WARNING: solang parser and the natspec docs interpret no tags as a notice
    );

    test_missingnotice!(
        multiline_no_tag_no_violation,
        r"
        contract Test {
            /**
             * Some comment
             */
            struct TestStruct {
                uint256 a;
            }
        }
        ",
        |_| None // WARNING: solang parser and the natspec docs interpret no tags as a notice
    );
}