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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190

use solang_parser::pt::{ContractTy, VariableAttribute, VariableDefinition, Visibility};

use crate::{
    parser::{CommentTag, CommentsRef, ParseItem},
    rules::violation_error::ViolationError,
};

use super::super::{Rule, Violation};

/// This rule requires that all public variables have a inheritdoc comment.
pub struct MissingInheritdoc;

impl Rule for MissingInheritdoc {
    type Target = VariableDefinition;
    const NAME: &'static str = "MissingInheritdoc";
    const DESCRIPTION: &'static str =
        "Public and override variables must have an inheritdoc comment.";

    fn check(
        parent: Option<&ParseItem>,
        var: &VariableDefinition,
        comments: &CommentsRef,
    ) -> Option<Violation> {
        // Parent must be a contract, not an interface or library
        match parent?.as_contract()?.ty {
            ContractTy::Interface(_) | ContractTy::Library(_) => return None,
            ContractTy::Contract(_) | ContractTy::Abstract(_) => (),
        }

        // Variable must be public, external, or an override
        var.attrs.iter().find(|attr| match attr {
            VariableAttribute::Visibility(Visibility::Public(_) | Visibility::External(_))
            | VariableAttribute::Override(..) => true,
            VariableAttribute::Visibility(Visibility::Private(_) | Visibility::Internal(_))
            | VariableAttribute::Immutable(_)
            | VariableAttribute::Constant(_) => false,
        })?;

        // Variable must have an inheritdoc comment
        if comments.include_tag(CommentTag::Inheritdoc).is_empty() {
            return Some(Violation::new(
                Self::NAME,
                Self::DESCRIPTION,
                ViolationError::MissingComment(CommentTag::Inheritdoc),
                var.loc,
            ));
        }

        None
    }
}

#[cfg(test)]
mod tests {
    use super::{
        CommentTag, CommentsRef, MissingInheritdoc, Rule, VariableDefinition, Violation,
        ViolationError,
    };
    use crate::{generate_missing_comment_test_cases, parser::Parser};
    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_missinginheritdoc {
        ($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!(
                    MissingInheritdoc::check(Some(parent), var, &comments),
                    expected
                );
            }
        };
    }

    mod pub_const_test {
        use super::*;

        generate_missing_comment_test_cases!(
            Inheritdoc,
            test_missinginheritdoc,
            MissingInheritdoc,
            r#"
                bytes32 public constant SOME_CONST = keccak256("SOME_CONST");
            "#,
            "@inheritdoc",
            VariableDefinition
        );
    }

    mod pub_immutable_test {
        use super::*;

        generate_missing_comment_test_cases!(
            Inheritdoc,
            test_missinginheritdoc,
            MissingInheritdoc,
            r"
                bytes32 public immutable SOME_IMMUT;
            ",
            "@inheritdoc",
            VariableDefinition
        );
    }

    mod pub_state_test {
        use super::*;

        generate_missing_comment_test_cases!(
            Inheritdoc,
            test_missinginheritdoc,
            MissingInheritdoc,
            r"
                State public state;
            ",
            "@inheritdoc",
            VariableDefinition
        );
    }

    test_missinginheritdoc!(
        private_no_violation,
        r"
        contract Test {
            State private state;
        }
        ",
        |_| None
    );

    test_missinginheritdoc!(
        internal_no_violation,
        r"
        contract Test {
            State internal state;
        }
        ",
        |_| None
    );

    test_missinginheritdoc!(
        interface_no_violation,
        r"
        interface Test {
            State public state;
        }
        ",
        |_| None
    );

    test_missinginheritdoc!(
        library_no_violation,
        r"
        library Test {
            State public state;
        }
        ",
        |_| None
    );

    test_missinginheritdoc!(
        abstract_public_violation,
        r"
        abstract contract Test {
            State public state;
        }
        ",
        |func: &VariableDefinition| Some(Violation::new(
            MissingInheritdoc::NAME,
            MissingInheritdoc::DESCRIPTION,
            ViolationError::MissingComment(CommentTag::Inheritdoc),
            func.loc
        ))
    );
}