feat(cli): add lsp bases

from: carthage-software#74
Co-Authored-By: Saif Eddin Gmati <[email protected]>

Author: JungoQuentin

.gitignore

@@ -2,3 +2,5 @@
 /target
 
 /vendor/
+
+/editors

Cargo.lock

@@ -89,6 +89,7 @@ memchr = "2.7.4"
 parking_lot = "0.12.3"
 dialoguer = "0.11.0"
 unicode-width = { version = "0.2.0", default-features = false }
+tower-lsp = "0.20.0"
 
 [dependencies]
 mago-syntax = { workspace = true }
@@ -104,8 +105,9 @@ mago-fixer = { workspace = true }
 mago-php-version = { workspace = true }
 mago-reference = { workspace = true }
 mago-composer = { workspace = true }
+mago-span = { workspace = true }
 serde = { workspace = true }
-tokio = { workspace = true, features = ["rt", "rt-multi-thread", "time"] }
+tokio = { workspace = true, features = ["rt", "rt-multi-thread", "time", "io-std"] }
 clap = { workspace = true }
 ahash = { workspace = true }
 termtree = { workspace = true }
@@ -125,6 +127,7 @@ tracing-subscriber = { workspace = true }
 indicatif = { workspace = true }
 colored = { workspace = true }
 dialoguer = { workspace = true }
+tower-lsp = { workspace = true }
 
 [target.'cfg(target_os = "linux")'.dependencies]
 openssl = { workspace = true }

Cargo.toml

@@ -0,0 +1,42 @@
+use std::process::ExitCode;
+
+use clap::Parser;
+use tower_lsp::LspService;
+use tower_lsp::Server;
+
+use mago_interner::ThreadedInterner;
+
+use crate::error::Error;
+use crate::lsp::MagoLanguageServer;
+
+/// Represents the `lsp` command, which starts the Language Server Protocol (LSP) server.
+#[derive(Parser, Debug)]
+#[command(
+    name = "lsp",
+    about = "Starts the Language Server Protocol (LSP) server.",
+    long_about = r#"
+The `lsp` command starts the Language Server Protocol (LSP) server, which can be used to provide
+editor support for PHP files. The server will listen for incoming connections on stdin and stdout.
+"#
+)]
+pub struct LspCommand {}
+
+/// Executes the LSP command with the provided options.
+///
+/// # Arguments
+///
+/// * `command` - The `LspCommand` structure containing user-specified options.
+///
+/// # Returns
+///
+/// An `ExitCode` indicating the success or failure of the command.
+pub async fn execute(_command: LspCommand) -> Result<ExitCode, Error> {
+    let interner = ThreadedInterner::new();
+
+    let (stdin, stdout) = (tokio::io::stdin(), tokio::io::stdout());
+
+    let (service, socket) = LspService::new(|client| MagoLanguageServer::new(interner, client));
+    Server::new(stdin, stdout, socket).serve(service).await;
+
+    Ok(ExitCode::SUCCESS)
+}

src/commands/lsp.rs

@@ -13,6 +13,7 @@ use crate::commands::find::FindCommand;
 use crate::commands::format::FormatCommand;
 use crate::commands::init::InitCommand;
 use crate::commands::lint::LintCommand;
+use crate::commands::lsp::LspCommand;
 use crate::commands::self_update::SelfUpdateCommand;
 use crate::error::Error;
 
@@ -21,6 +22,7 @@ pub mod find;
 pub mod format;
 pub mod init;
 pub mod lint;
+pub mod lsp;
 pub mod self_update;
 
 /// Styling for the Mago CLI.
@@ -51,6 +53,9 @@ pub enum MagoCommand {
     /// Find references to symbols in PHP code.
     #[command(name = "find")]
     Find(FindCommand),
+    /// Start the language server
+    #[command(name = "lsp")]
+    Lsp(LspCommand),
     /// Update Mago to the latest version.
     #[command(name = "self-update")]
     SelfUpdate(SelfUpdateCommand),