feat(forge): Forge Lint

Cargo.toml

@@ -23,6 +23,8 @@ members = [
     "crates/script-sequence/",
     "crates/macros/",
     "crates/test-utils/",
+    "crates/lint/",
+
 ]
 resolver = "2"
 
@@ -147,6 +149,7 @@ forge = { path = "crates/forge" }
 
 forge-doc = { path = "crates/doc" }
 forge-fmt = { path = "crates/fmt" }
+forge-lint = { path = "crates/lint" }
 forge-verify = { path = "crates/verify" }
 forge-script = { path = "crates/script" }
 forge-sol-macro-gen = { path = "crates/sol-macro-gen" }
@@ -174,7 +177,9 @@ foundry-block-explorers = { version = "0.9.0", default-features = false }
 foundry-compilers = { version = "0.12.9", default-features = false }
 foundry-fork-db = "0.10.0"
 solang-parser = "=0.3.3"
+solar-ast = { version = "=0.1.1", default-features = false }
 solar-parse = { version = "=0.1.1", default-features = false }
+solar-interface = { version = "=0.1.1", default-features = false }
 
 ## revm
 revm = { version = "19.0.0", default-features = false }

crates/forge/Cargo.toml

@@ -50,6 +50,7 @@ chrono.workspace = true
 # bin
 forge-doc.workspace = true
 forge-fmt.workspace = true
+forge-lint.workspace = true
 forge-verify.workspace = true
 forge-script.workspace = true
 forge-sol-macro-gen.workspace = true
@@ -88,6 +89,7 @@ serde_json.workspace = true
 similar = { version = "2", features = ["inline"] }
 solang-parser.workspace = true
 solar-parse.workspace = true
+solar-interface.workspace = true
 strum = { workspace = true, features = ["derive"] }
 thiserror.workspace = true
 tokio = { workspace = true, features = ["time"] }

crates/forge/bin/cmd/lint.rs

@@ -0,0 +1,76 @@
+use clap::{Parser, ValueHint};
+use eyre::Result;
+use forge_lint::{
+    linter::{ProjectLinter, Severity},
+    sol::SolidityLinter,
+};
+use foundry_cli::utils::LoadConfig;
+use foundry_config::impl_figment_convert_basic;
+use std::{collections::HashSet, path::PathBuf};
+
+/// CLI arguments for `forge lint`.
+#[derive(Clone, Debug, Parser)]
+pub struct LintArgs {
+    /// The project's root path.
+    ///
+    /// By default root of the Git repository, if in one,
+    /// or the current working directory.
+    #[arg(long, value_hint = ValueHint::DirPath, value_name = "PATH")]
+    root: Option<PathBuf>,
+
+    /// Include only the specified files when linting.
+    #[arg(long, value_hint = ValueHint::FilePath, value_name = "FILES", num_args(1..))]
+    include: Option<Vec<PathBuf>>,
+
+    /// Exclude the specified files when linting.
+    #[arg(long, value_hint = ValueHint::FilePath, value_name = "FILES", num_args(1..))]
+    exclude: Option<Vec<PathBuf>>,
+
+    /// Specifies which lints to run based on severity.
+    ///
+    /// Supported values: `high`, `med`, `low`, `info`, `gas`.
+    #[arg(long, value_name = "SEVERITY", num_args(1..))]
+    severity: Option<Vec<Severity>>,
+}
+
+impl_figment_convert_basic!(LintArgs);
+
+impl LintArgs {
+    pub fn run(self) -> Result<()> {
+        let config = self.try_load_config_emit_warnings()?;
+        let project = config.project()?;
+
+        // Get all source files from the project
+        let mut sources =
+            project.paths.read_input_files()?.keys().cloned().collect::<Vec<PathBuf>>();
+
+        // Add included paths to sources
+        if let Some(include_paths) = &self.include {
+            let included =
+                include_paths.iter().filter(|path| path.exists()).cloned().collect::<Vec<_>>();
+            sources.extend(included);
+        }
+
+        // Remove excluded files from sources
+        if let Some(exclude_paths) = &self.exclude {
+            let excluded = exclude_paths.iter().cloned().collect::<HashSet<_>>();
+            sources.retain(|path| !excluded.contains(path));
+        }
+
+        if sources.is_empty() {
+            sh_println!("Nothing to lint")?;
+            std::process::exit(0);
+        }
+
+        let linter = if project.compiler.solc.is_some() {
+            SolidityLinter::new().with_severity(self.severity)
+        } else {
+            todo!("Linting not supported for this language");
+        };
+
+        let output = ProjectLinter::new(linter).lint(&sources)?;
+        sh_println!("{}", &output)?;
+
+        Ok(())
+    }
+}

crates/forge/bin/cmd/mod.rs

@@ -57,6 +57,7 @@ pub mod generate;
 pub mod init;
 pub mod inspect;
 pub mod install;
+pub mod lint;
 pub mod remappings;
 pub mod remove;
 pub mod selectors;

crates/forge/bin/main.rs

@@ -99,6 +99,7 @@ fn run() -> Result<()> {
             }
         }
         ForgeSubcommand::Fmt(cmd) => cmd.run(),
+        ForgeSubcommand::Lint(cmd) => cmd.run(),
         ForgeSubcommand::Config(cmd) => cmd.run(),
         ForgeSubcommand::Flatten(cmd) => cmd.run(),
         ForgeSubcommand::Inspect(cmd) => cmd.run(),

crates/forge/bin/opts.rs

@@ -1,7 +1,7 @@
 use crate::cmd::{
     bind::BindArgs, bind_json, build::BuildArgs, cache::CacheArgs, clone::CloneArgs,
     compiler::CompilerArgs, config, coverage, create::CreateArgs, doc::DocArgs, eip712, flatten,
-    fmt::FmtArgs, geiger, generate, init::InitArgs, inspect, install::InstallArgs,
+    fmt::FmtArgs, geiger, generate, init::InitArgs, inspect, install::InstallArgs, lint::LintArgs,
     remappings::RemappingArgs, remove::RemoveArgs, selectors::SelectorsSubcommands, snapshot,
     soldeer, test, tree, update,
 };
@@ -140,6 +140,10 @@ pub enum ForgeSubcommand {
     /// Format Solidity source files.
     Fmt(FmtArgs),
 
+    /// Lint Solidity source files
+    #[command(visible_alias = "l")]
+    Lint(LintArgs),
+
     /// Get specialized information about a smart contract.
     #[command(visible_alias = "in")]
     Inspect(inspect::InspectArgs),

crates/lint/Cargo.toml

@@ -0,0 +1,33 @@
+
+[package]
+name = "forge-lint"
+
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+authors.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+
+[lints]
+workspace = true
+
+[dependencies]
+# lib
+foundry-common.workspace = true
+foundry-compilers.workspace = true
+
+solar-parse.workspace = true
+solar-ast.workspace = true
+solar-interface.workspace = true
+
+eyre.workspace = true
+rayon.workspace = true
+thiserror.workspace = true
+serde_json.workspace = true
+auto_impl.workspace = true
+yansi.workspace = true
+serde = { workspace = true, features = ["derive"] }
+regex = "1.11"
+clap = { version = "4", features = ["derive"] }

crates/lint/src/lib.rs

@@ -0,0 +1,5 @@
+//! # forge-lint
+//!
+//! Types, traits, and utilities for linting Solidity projects.
+pub mod linter;
+pub mod sol;