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

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;

import { TestInterface } from "./TestInterface.sol";

contract TestContract is TestInterface {
    uint256 public value;
    
    event ValueUpdated(uint256 newValue);
    
    // natlint-disable-next-line MissingNotice,MissingParam
    error InvalidValue(uint256 value);
    
    enum Status { Active, Inactive, Pending }
    
    // natlint-disable-next-line MissingParams
    struct UserData {
        string name;
        uint256 balance;
    }
    
    type Amount is uint256;

    // natlint-disable-next-line
    function setValue(uint256 _value) public {
        if (_value == 0) {
            revert InvalidValue(_value);
        }
        value = _value;
        emit ValueUpdated(_value);
    }
}