feat(lsp): Language Server Protocol (LSP)

Cargo.toml

@@ -25,6 +25,7 @@ members = [
     "crates/macros/",
     "crates/test-utils/",
     "crates/lint/",
+    "crates/lsp/",
 ]
 resolver = "2"
 
@@ -180,6 +181,7 @@ forge = { path = "crates/forge" }
 forge-doc = { path = "crates/doc" }
 forge-fmt = { path = "crates/fmt" }
 forge-lint = { path = "crates/lint" }
+forge-lsp = { path = "crates/lsp" }
 forge-verify = { path = "crates/verify" }
 forge-script = { path = "crates/script" }
 forge-sol-macro-gen = { path = "crates/sol-macro-gen" }

crates/forge/Cargo.toml

@@ -45,6 +45,7 @@ chrono.workspace = true
 forge-doc.workspace = true
 forge-fmt.workspace = true
 forge-lint.workspace = true
+forge-lsp.workspace = true
 forge-verify.workspace = true
 forge-script.workspace = true
 forge-sol-macro-gen.workspace = true
@@ -89,6 +90,7 @@ watchexec-signals = "5.0"
 clearscreen = "4.0"
 evm-disassembler.workspace = true
 path-slash.workspace = true
+tower-lsp = "0.20"
 
 # doc server
 axum = { workspace = true, features = ["ws"] }

crates/forge/src/args.rs

@@ -154,5 +154,6 @@ pub fn run_command(args: Forge) -> Result<()> {
         ForgeSubcommand::Eip712(cmd) => cmd.run(),
         ForgeSubcommand::BindJson(cmd) => cmd.run(),
         ForgeSubcommand::Lint(cmd) => cmd.run(),
+        ForgeSubcommand::Lsp(cmd) => global.block_on(cmd.run()),
     }
 }

crates/forge/src/cmd/lsp.rs

@@ -0,0 +1,31 @@
+use clap::Parser;
+use eyre::Result;
+
+use forge_lsp::lsp::ForgeLsp;
+use tower_lsp::{LspService, Server};
+use tracing::info;
+
+/// Start the Foundry Language Server Protocol (LSP) server
+#[derive(Clone, Debug, Parser)]
+pub struct LspArgs {
+    /// See: <https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#implementationConsiderations>
+    #[arg(long)]
+    pub stdio: bool,
+}
+
+impl LspArgs {
+    pub async fn run(self) -> Result<()> {
+        // Start stdio LSP server
+        info!("Starting Foundry LSP server...");
+
+        let stdin = tokio::io::stdin();
+        let stdout = tokio::io::stdout();
+        let (service, socket) = LspService::new(ForgeLsp::new);
+
+        Server::new(stdin, stdout, socket).serve(service).await;
+
+        info!("Foundry LSP server stopped");
+
+        Ok(())
+    }
+}

crates/forge/src/cmd/mod.rs

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

crates/forge/src/opts.rs

@@ -2,8 +2,8 @@ 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, lint::LintArgs,
-    remappings::RemappingArgs, remove::RemoveArgs, selectors::SelectorsSubcommands, snapshot,
-    soldeer, test, tree, update,
+    lsp::LspArgs, remappings::RemappingArgs, remove::RemoveArgs, selectors::SelectorsSubcommands,
+    snapshot, soldeer, test, tree, update,
 };
 use clap::{Parser, Subcommand, ValueHint};
 use forge_script::ScriptArgs;
@@ -136,6 +136,9 @@ pub enum ForgeSubcommand {
     #[command(visible_alias = "l")]
     Lint(LintArgs),
 
+    /// Start the Foundry Language Server Protocol (LSP) server
+    Lsp(LspArgs),
+
     /// Get specialized information about a smart contract.
     #[command(visible_alias = "in")]
     Inspect(inspect::InspectArgs),