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

//! Configuration for natlint rules.
//!
//! This module provides configuration for natlint rules, including loading default
//! rules and applying them to parsed Solidity items.
use std::{fs, iter, path::Path};

use serde::{Deserialize, Serialize};
use thiserror::Error;
use toml;

use crate::rules::{
    contract::ContractRulesConfig, error::ErrorRulesConfig, event::EventRulesConfig,
    function::FunctionRulesConfig, r#enum::EnumRulesConfig, r#struct::StructRulesConfig,
    variable::VariableRulesConfig, DynRule,
};

/// Errors that can occur during configuration processing.
#[derive(Error, Debug)]
pub enum ConfigError {
    /// Error reading the configuration file.
    #[error("Failed to read config file: {0}")]
    FileRead(#[from] std::io::Error),
    /// Error parsing the TOML configuration.
    #[error("Failed to parse TOML config: {0}")]
    TomlParse(#[from] toml::de::Error),
}

/// Configuration for natlint rules
#[derive(Serialize, Deserialize, Default, Debug)]
#[allow(missing_docs)]
pub struct Config {
    #[serde(default)]
    pub contract_rules: ContractRulesConfig,
    #[serde(default)]
    pub error_rules: ErrorRulesConfig,
    #[serde(default)]
    pub function_rules: FunctionRulesConfig,
    #[serde(default)]
    pub enum_rules: EnumRulesConfig,
    #[serde(default)]
    pub struct_rules: StructRulesConfig,
    #[serde(default)]
    pub variable_rules: VariableRulesConfig,
    #[serde(default)]
    pub event_rules: EventRulesConfig,
}

impl Config {
    /// Returns an iterator over the rules in the configuration.
    #[must_use]
    pub fn rules(&self) -> Vec<Box<dyn DynRule>> {
        iter::empty()
            .chain(self.contract_rules.rule_set())
            .chain(self.error_rules.rule_set())
            .chain(self.function_rules.rule_set())
            .chain(self.enum_rules.rule_set())
            .chain(self.struct_rules.rule_set())
            .chain(self.variable_rules.rule_set())
            .chain(self.event_rules.rule_set())
            .collect()
    }

    /// Load configuration from a TOML file.
    /// # Errors
    /// Returns `ConfigError` if the file cannot be read or parsed.
    pub fn from_file(path: &Path) -> Result<Self, ConfigError> {
        let content = fs::read_to_string(path)?;
        Ok(toml::from_str(&content)?)
    }
}