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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use solang_parser::pt::VariableDefinition;

crate::too_many_comments_rule!(
    TooManyNotice,
    VariableDefinition,
    Notice,
    "Variables must not have more than one notice comment."
);

#[cfg(test)]
mod tests {
    use super::{TooManyNotice, VariableDefinition};
    use crate::{
        generate_too_many_comment_test_cases,
        parser::{CommentTag, CommentsRef, Parser},
        rules::{Rule, Violation, ViolationError},
    };
    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_too_many_notice {
        ($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 var = child.as_variable().unwrap();
                let comments = CommentsRef::from(&child.comments);

                let expected = $expected(var);

                assert_eq!(TooManyNotice::check(Some(parent), var, &comments), expected);
            }
        };
    }

    pub mod pub_const_test {
        use super::*;

        generate_too_many_comment_test_cases!(
            Notice,
            test_too_many_notice,
            TooManyNotice,
            r#"
                bytes32 public constant SOME_CONST = keccak256("SOME_CONST");
            "#,
            "@notice",
            VariableDefinition
        );

        test_too_many_notice!(
            no_tag_violation,
            r#"
            contract Test {
                /// Some notice
                /// @notice Some other
                bytes32 public constant SOME_CONST = keccak256("SOME_CONST");
            }
            "#,
            |sct: &VariableDefinition| Some(Violation::new(
                TooManyNotice::NAME,
                TooManyNotice::DESCRIPTION,
                ViolationError::TooManyComments(CommentTag::Notice),
                sct.loc
            )) // WARNING: solang parser and the natspec docs interpret no tags as a notice
        );
    }

    pub mod pub_immutable_test {
        use super::*;

        generate_too_many_comment_test_cases!(
            Notice,
            test_too_many_notice,
            TooManyNotice,
            r"
                bytes32 public immutable SOME_IMMUT;
            ",
            "@notice",
            VariableDefinition
        );

        test_too_many_notice!(
            no_tag_violation,
            r"
            contract Test {
                /// Some notice
                /// @notice Some other
                bytes32 public immutable SOME_IMMUT;
            }
            ",
            |sct: &VariableDefinition| Some(Violation::new(
                TooManyNotice::NAME,
                TooManyNotice::DESCRIPTION,
                ViolationError::TooManyComments(CommentTag::Notice),
                sct.loc
            )) // WARNING: solang parser and the natspec docs interpret no tags as a notice
        );
    }

    pub mod priv_state_test {
        use super::*;

        generate_too_many_comment_test_cases!(
            Notice,
            test_too_many_notice,
            TooManyNotice,
            r"
                State private state;
            ",
            "@notice",
            VariableDefinition
        );

        test_too_many_notice!(
            no_tag_violation,
            r"
            contract Test {
                /// Some notice
                /// @notice Some other
                State private state;
            }
            ",
            |sct: &VariableDefinition| Some(Violation::new(
                TooManyNotice::NAME,
                TooManyNotice::DESCRIPTION,
                ViolationError::TooManyComments(CommentTag::Notice),
                sct.loc
            )) // WARNING: solang parser and the natspec docs interpret no tags as a notice
        );
    }
}