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

//! This module defines the `NoInheritdoc` rule
//! This rule may be removed in the future: <https://github.com/ethereum/solidity/issues/14045>

use solang_parser::pt::ContractDefinition;

crate::no_comment_rule!(
    NoInheritdoc,
    ContractDefinition,
    Inheritdoc,
    "Contracts must not have an inheritdoc comment."
);

#[cfg(test)]
mod tests {
    use super::{ContractDefinition, NoInheritdoc};
    use crate::{
        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 to define a test case for `MissingParams` rule
    macro_rules! test_no_inheritdoc {
        ($name:ident, $source:expr, $expected:expr) => {
            #[test]
            fn $name() {
                let src = parse_source($source);

                let contract_item = src.items_ref().first().unwrap();
                let comments = CommentsRef::from(&contract_item.comments);
                let contract = contract_item.as_contract().unwrap();

                let expected = $expected(contract);

                assert_eq!(NoInheritdoc::check(None, contract, &comments), expected);
            }
        };
    }

    test_no_inheritdoc!(
        empty_no_violation,
        r"
        interface Test {
        }
        ",
        |_| None
    );

    test_no_inheritdoc!(
        no_violation,
        r"
        /// @custom:test Some comment
        interface Test {
        }
        ",
        |_| None
    );

    test_no_inheritdoc!(
        multi_no_violation,
        r"
        /// @custom:test Some comment
        /// @custom:test Some other
        contract Test {
        }
        ",
        |_| None
    );

    test_no_inheritdoc!(
        multiline_no_violation,
        r"
        /**
         * @custom:test Some comment
         */
        abstract contract Test {
        }
        ",
        |_| None
    );

    test_no_inheritdoc!(
        multiline_multi_no_violation,
        r"
        /**
         * @custom:test Some comment
         * @custom:test Some other
         */
        library Test {
        }
        ",
        |_| None
    );

    test_no_inheritdoc!(
        violation,
        r"
        /// @inheritdoc Base
        interface Test {
        }
        ",
        |sct: &ContractDefinition| Some(Violation::new(
            NoInheritdoc::NAME,
            NoInheritdoc::DESCRIPTION,
            ViolationError::CommentNotAllowed(CommentTag::Inheritdoc),
            sct.loc
        ))
    );

    test_no_inheritdoc!(
        multi_violation,
        r"
        /// @inheritdoc Base
        /// @inheritdoc Base
        abstract contract Test {
        }
        ",
        |sct: &ContractDefinition| Some(Violation::new(
            NoInheritdoc::NAME,
            NoInheritdoc::DESCRIPTION,
            ViolationError::CommentNotAllowed(CommentTag::Inheritdoc),
            sct.loc
        ))
    );

    test_no_inheritdoc!(
        multiline_violation,
        r"
        /**
         * @inheritdoc Base
         */
        library Test {
        }
        ",
        |sct: &ContractDefinition| Some(Violation::new(
            NoInheritdoc::NAME,
            NoInheritdoc::DESCRIPTION,
            ViolationError::CommentNotAllowed(CommentTag::Inheritdoc),
            sct.loc
        ))
    );

    test_no_inheritdoc!(
        multiline_multi_violation,
        r"
        /**
         * @inheritdoc Base
         * @inheritdoc Base
         */
        contract Test {
        }
        ",
        |sct: &ContractDefinition| Some(Violation::new(
            NoInheritdoc::NAME,
            NoInheritdoc::DESCRIPTION,
            ViolationError::CommentNotAllowed(CommentTag::Inheritdoc),
            sct.loc
        ))
    );
}