foundry_config/

lint.rs

//! Configuration specific to the `forge lint` command and the `forge_lint` package

use clap::ValueEnum;
use core::fmt;
use serde::{Deserialize, Deserializer, Serialize};
use solar::{
    ast::{self as ast},
    interface::diagnostics::Level,
};
use std::str::FromStr;
use yansi::Paint;

/// Contains the config and rule set.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct LinterConfig {
    /// Specifies which lints to run based on severity.
    ///
    /// If uninformed, all severities are checked.
    pub severity: Vec<Severity>,

    /// Deny specific lints based on their ID (e.g. "mixed-case-function").
    pub exclude_lints: Vec<String>,

    /// Globs to ignore.
    pub ignore: Vec<String>,

    /// Whether to run linting during `forge build`.
    ///
    /// Defaults to true. Set to false to disable automatic linting during builds.
    pub lint_on_build: bool,

    /// Configuration specific to individual lints.
    pub lint_specific: LintSpecificConfig,
}

impl Default for LinterConfig {
    fn default() -> Self {
        Self {
            lint_on_build: true,
            severity: vec![Severity::High, Severity::Med, Severity::Low],
            exclude_lints: Vec::new(),
            ignore: Vec::new(),
            lint_specific: LintSpecificConfig::default(),
        }
    }
}

/// Contract types that can be exempted from the multi-contract-file lint.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ContractException {
    Interface,
    Library,
    AbstractContract,
}

/// Configuration specific to individual lints.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(default)]
pub struct LintSpecificConfig {
    /// Configurable patterns that should be excluded when performing `mixedCase` lint checks.
    ///
    /// Defaults to ["ERC", "URI"] to allow common names like `rescueERC20`, `ERC721TokenReceiver`
    /// or `tokenURI`.
    pub mixed_case_exceptions: Vec<String>,

    /// Contract types that are allowed to appear multiple times in the same file.
    ///
    /// Valid values: "interface", "library", "abstract_contract"
    ///
    /// Defaults to an empty array (all contract types are flagged when multiple exist).
    /// Note: Regular contracts cannot be exempted and will always be flagged when multiple exist.
    pub multi_contract_file_exceptions: Vec<ContractException>,
}

impl Default for LintSpecificConfig {
    fn default() -> Self {
        Self {
            mixed_case_exceptions: vec![
                "ERC".to_string(),
                "URI".to_string(),
                "ID".to_string(),
                "URL".to_string(),
                "API".to_string(),
                "JSON".to_string(),
                "XML".to_string(),
                "HTML".to_string(),
                "HTTP".to_string(),
                "HTTPS".to_string(),
            ],
            multi_contract_file_exceptions: Vec::new(),
        }
    }
}

impl LintSpecificConfig {
    /// Checks if a given contract kind is included in the list of exceptions
    pub fn is_exempted(&self, contract_kind: &ast::ContractKind) -> bool {
        let exception_to_check = match contract_kind {
            ast::ContractKind::Interface => ContractException::Interface,
            ast::ContractKind::Library => ContractException::Library,
            ast::ContractKind::AbstractContract => ContractException::AbstractContract,
            // Regular contracts are always linted
            ast::ContractKind::Contract => return false,
        };

        self.multi_contract_file_exceptions.contains(&exception_to_check)
    }
}

/// Severity of a lint.
#[derive(Debug, Clone, Copy, PartialEq, Eq, ValueEnum)]
pub enum Severity {
    High,
    Med,
    Low,
    Info,
    Gas,
    CodeSize,
}

impl Severity {
    fn to_str(self) -> &'static str {
        match self {
            Self::High => "High",
            Self::Med => "Med",
            Self::Low => "Low",
            Self::Info => "Info",
            Self::Gas => "Gas",
            Self::CodeSize => "CodeSize",
        }
    }

    fn to_str_kebab(self) -> &'static str {
        match self {
            Self::High => "high",
            Self::Med => "medium",
            Self::Low => "low",
            Self::Info => "info",
            Self::Gas => "gas",
            Self::CodeSize => "code-size",
        }
    }

    pub fn color(&self, message: &str) -> String {
        match self {
            Self::High => Paint::red(message).bold().to_string(),
            Self::Med => Paint::rgb(message, 255, 135, 61).bold().to_string(),
            Self::Low => Paint::yellow(message).bold().to_string(),
            Self::Info => Paint::cyan(message).bold().to_string(),
            Self::Gas => Paint::green(message).bold().to_string(),
            Self::CodeSize => Paint::green(message).bold().to_string(),
        }
    }
}

impl From<Severity> for Level {
    fn from(severity: Severity) -> Self {
        match severity {
            Severity::High | Severity::Med | Severity::Low => Self::Warning,
            Severity::Info | Severity::Gas | Severity::CodeSize => Self::Note,
        }
    }
}

impl fmt::Display for Severity {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.color(self.to_str()))
    }
}

impl Serialize for Severity {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        self.to_str_kebab().serialize(serializer)
    }
}

// Custom deserialization to make `Severity` parsing case-insensitive
impl<'de> Deserialize<'de> for Severity {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let s = String::deserialize(deserializer)?;
        FromStr::from_str(&s).map_err(serde::de::Error::custom)
    }
}

impl FromStr for Severity {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().as_str() {
            "high" => Ok(Self::High),
            "med" | "medium" => Ok(Self::Med),
            "low" => Ok(Self::Low),
            "info" => Ok(Self::Info),
            "gas" => Ok(Self::Gas),
            "size" | "codesize" | "code-size" => Ok(Self::CodeSize),
            _ => Err(format!(
                "unknown variant: found `{s}`, expected `one of `High`, `Med`, `Low`, `Info`, `Gas`, `CodeSize`"
            )),
        }
    }
}