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

//! This module defines the rules for the natlint linter.

use std::any::{Any, TypeId};

use solang_parser::pt::Loc;
use violation_error::ViolationError;

use crate::parser::{CommentsRef, ParseItem};

pub mod macros;
pub mod violation_error;

pub mod contract;
pub mod r#enum;
pub mod error;
pub mod event;
pub mod function;
pub mod r#struct;
pub mod r#type;
pub mod variable;

/// A lint diagnostic.
#[derive(Debug, PartialEq, Eq)]
pub struct Violation {
    /// The rule that was violated.
    pub rule_name: &'static str,
    /// The description of the rule that was violated.
    pub rule_description: &'static str,
    /// A message describing the violation.
    pub error: ViolationError,
    /// The location of the violation.
    pub loc: Loc,
}

/// A trait for defining a rule that checks a specific Solidity construct.
/// The rule should return a diagnostic if the construct violates the rule.
pub trait Rule {
    /// The type of the construct that this rule checks.
    type Target: Any;
    /// The name of the rule.
    const NAME: &'static str;
    /// A description of the rule.
    const DESCRIPTION: &'static str;

    /// Check the construct for violations of this rule.
    fn check(
        parent: Option<&ParseItem>,
        item: &Self::Target,
        comments: &CommentsRef,
    ) -> Option<Violation>;
}

/// A dynamic version of the [`Rule`] trait.
pub trait DynRule {
    /// The name of the rule.
    fn name(&self) -> &'static str;
    /// A description of the rule.
    fn description(&self) -> &'static str;
    /// The `TypeId` of the construct this rule checks.
    fn target_type_id(&self) -> TypeId;
    /// Check the construct for violations of this rule.
    fn check_dyn(
        &self,
        parent: Option<&ParseItem>,
        item: &dyn Any,
        comments: &CommentsRef,
    ) -> Option<Violation>;
}

impl Violation {
    /// Create a new violation.
    #[must_use]
    pub const fn new(
        rule_name: &'static str,
        rule_description: &'static str,
        error: ViolationError,
        loc: Loc,
    ) -> Self {
        Self {
            rule_name,
            rule_description,
            error,
            loc,
        }
    }
}

impl<R: Rule> DynRule for R
where
    R::Target: Any,
{
    fn name(&self) -> &'static str {
        R::NAME
    }

    fn description(&self) -> &'static str {
        R::DESCRIPTION
    }

    fn target_type_id(&self) -> TypeId {
        TypeId::of::<R::Target>()
    }

    fn check_dyn(
        &self,
        parent: Option<&ParseItem>,
        item: &dyn Any,
        comments: &CommentsRef,
    ) -> Option<Violation> {
        let item = item
            .downcast_ref::<R::Target>()
            .expect("Item type mismatch");
        R::check(parent, item, comments)
    }
}