feat: add LSP server for IDE integration

omarabid · omarabid · commit 8b6c2edbed2a · 2026-03-01T15:54:38.000+08:00
Add tower-lsp based Language Server Protocol implementation to provide
CODEOWNERS information directly in supported editors. Includes optional
'lsp' feature flag and new `ci lsp` command to start the server.
diff --git a/Cargo.toml b/Cargo.toml
@@ -31,6 +31,9 @@ tabled = "0.20.0"
 terminal_size = "0.4.2"
 clap = { version = "4.5.40", features = ["cargo", "derive"] }
 chrono = { version = "0.4.41", features = ["serde"] }
+tower-lsp = "0.20"
+tokio = { version = "1", features = ["full"] }
+url = "2.5"
 
 # Dev dependencies
 assert_cmd = "2.0.17"
diff --git a/ci/Cargo.toml b/ci/Cargo.toml
@@ -21,6 +21,7 @@ default = ["termlog"]
 termlog = ["codeinput/termlog"]
 journald = ["codeinput/journald"]
 syslog = ["codeinput/syslog"]
+lsp = ["codeinput/tower-lsp", "codeinput/tokio", "tokio"]
 
 [dependencies]
 codeinput = { version = "0.0.4", path = "../codeinput" }
@@ -34,6 +35,7 @@ thiserror = { workspace = true }
 tabled = { workspace = true }
 terminal_size = { workspace = true }
 clap = { workspace = true }
+tokio = { workspace = true, optional = true }
 
 [dev-dependencies]
 assert_cmd = { workspace = true }
diff --git a/ci/src/cli/mod.rs b/ci/src/cli/mod.rs
@@ -16,6 +16,9 @@ use codeinput::utils::app_config::AppConfig;
 use codeinput::utils::error::Result;
 use codeinput::utils::types::LogLevel;
 
+#[cfg(feature = "lsp")]
+use codeinput::lsp::server::run_lsp_server;
+
 #[derive(Parser, Debug)]
 #[command(
     name = "codeinput",
@@ -76,6 +79,17 @@ enum Commands {
         long_about = None,
     )]
     Config,
+    #[cfg(feature = "lsp")]
+    #[clap(
+        name = "lsp",
+        about = "Start LSP server for IDE integration",
+        long_about = "Starts a Language Server Protocol (LSP) server that provides CODEOWNERS information to supported editors"
+    )]
+    Lsp {
+        /// Use stdio for LSP communication (passed by VS Code)
+        #[arg(long, hide = true)]
+        stdio: bool,
+    },
 }
 
 #[derive(Subcommand, PartialEq, Debug)]
@@ -279,6 +293,13 @@ pub fn cli_match() -> Result<()> {
             }
         }
         Commands::Config => commands::config::run()?,
+        #[cfg(feature = "lsp")]
+        Commands::Lsp { stdio: _ } => {
+            let rt = tokio::runtime::Runtime::new()?;
+            rt.block_on(async {
+                run_lsp_server().await
+            })?;
+        }
     }
 
     Ok(())
diff --git a/codeinput/Cargo.toml b/codeinput/Cargo.toml
@@ -57,6 +57,9 @@ full = [
 	"clap",
 	"chrono",
 	"utoipa",
+	"tower-lsp",
+	"tokio",
+	"url",
 ]
 nightly = []
 termlog = ["slog-term"]
@@ -93,6 +96,9 @@ tabled = { workspace = true, optional = true }
 terminal_size = { workspace = true, optional = true }
 clap = { workspace = true, optional = true }
 chrono = { version = "0.4.41", features = ["serde"], optional = true }
+tower-lsp = { workspace = true, optional = true }
+tokio = { workspace = true, optional = true }
+url = { workspace = true, optional = true }
 
 [target.'cfg(target_os = "linux")'.dependencies]
 slog-journald = { version = "2.2.0", optional = true }
diff --git a/codeinput/src/core/cache.rs b/codeinput/src/core/cache.rs
@@ -18,7 +18,7 @@ use std::{
 
 /// Create a cache from parsed CODEOWNERS entries and files
 pub fn build_cache(
-    entries: Vec<CodeownersEntry>, files: Vec<PathBuf>, hash: [u8; 32],
+    entries: Vec<CodeownersEntry>, files: Vec<PathBuf>, hash: [u8; 32], quiet: bool,
 ) -> Result<CodeownersCache> {
     let mut owners_map = std::collections::HashMap::new();
     let mut tags_map = std::collections::HashMap::new();
@@ -42,18 +42,20 @@ pub fn build_cache(
                         processed_count.fetch_add(1, std::sync::atomic::Ordering::Relaxed) + 1;
 
                     // Limit filename display length and clear the line properly
-                    let file_display = file_path.display().to_string();
-                    let truncated_file = if file_display.len() > 60 {
-                        format!("...{}", &file_display[file_display.len() - 57..])
-                    } else {
-                        file_display
-                    };
-
-                    print!(
-                        "\r\x1b[K📁 Processing [{}/{}] {}",
-                        current, total_files, truncated_file
-                    );
-                    std::io::stdout().flush().unwrap();
+                    if !quiet {
+                        let file_display = file_path.display().to_string();
+                        let truncated_file = if file_display.len() > 60 {
+                            format!("...{}", &file_display[file_display.len() - 57..])
+                        } else {
+                            file_display
+                        };
+
+                        print!(
+                            "\r\x1b[K📁 Processing [{}/{}] {}",
+                            current, total_files, truncated_file
+                        );
+                        std::io::stdout().flush().unwrap();
+                    }
 
                     let (owners, tags) =
                         find_owners_and_tags_for_file(file_path, &matched_entries).unwrap();
@@ -70,7 +72,9 @@ pub fn build_cache(
         .collect();
 
     // Print newline after processing is complete
-    println!("\r\x1b[K✅ Processed {} files successfully", total_files);
+    if !quiet {
+        println!("\r\x1b[K✅ Processed {} files successfully", total_files);
+    }
 
     // Process each owner
     let owners = collect_owners(&entries);
@@ -175,7 +179,7 @@ pub fn load_cache(path: &Path) -> Result<CodeownersCache> {
 }
 
 pub fn sync_cache(
-    repo: &std::path::Path, cache_file: Option<&std::path::Path>,
+    repo: &std::path::Path, cache_file: Option<&std::path::Path>, quiet: bool,
 ) -> Result<CodeownersCache> {
     let config_cache_file = crate::utils::app_config::AppConfig::fetch()?
         .cache_file
@@ -189,7 +193,7 @@ pub fn sync_cache(
     // Verify that the cache file exists
     if !repo.join(cache_file).exists() {
         // parse the codeowners files and build the cache
-        return parse_repo(&repo, &cache_file);
+        return parse_repo(&repo, &cache_file, quiet);
     }
 
     // Load the cache from the specified file
@@ -207,7 +211,7 @@ pub fn sync_cache(
 
     if cache_hash != current_hash {
         // parse the codeowners files and build the cache
-        return parse_repo(&repo, &cache_file);
+        return parse_repo(&repo, &cache_file, quiet);
     } else {
         return Ok(cache);
     }
diff --git a/codeinput/src/core/commands/inspect.rs b/codeinput/src/core/commands/inspect.rs
@@ -16,7 +16,7 @@ pub fn run(
     let repo = repo.unwrap_or_else(|| std::path::Path::new("."));
 
     // Load the cache
-    let cache = sync_cache(repo, cache_file)?;
+    let cache = sync_cache(repo, cache_file, false)?;
 
     // Normalize the file path to be relative to the repo
     let normalized_file_path = if file_path.is_absolute() {
diff --git a/codeinput/src/core/commands/list_files.rs b/codeinput/src/core/commands/list_files.rs
@@ -28,7 +28,7 @@ pub fn run(
     let repo = repo.unwrap_or_else(|| std::path::Path::new("."));
 
     // Load the cache
-    let cache = sync_cache(repo, cache_file)?;
+    let cache = sync_cache(repo, cache_file, false)?;
 
     // Filter files based on criteria
     let filtered_files = cache
diff --git a/codeinput/src/core/commands/list_owners.rs b/codeinput/src/core/commands/list_owners.rs
@@ -25,7 +25,7 @@ pub fn run(
     let repo = repo.unwrap_or_else(|| std::path::Path::new("."));
 
     // Load the cache
-    let cache = sync_cache(repo, cache_file)?;
+    let cache = sync_cache(repo, cache_file, false)?;
 
     // Sort owners by number of files they own (descending)
     let mut owners_with_counts: Vec<_> = cache.owners_map.iter().collect();
diff --git a/codeinput/src/core/commands/list_rules.rs b/codeinput/src/core/commands/list_rules.rs
@@ -22,7 +22,7 @@ struct RuleDisplay {
 /// Display CODEOWNERS rules from the cache
 pub fn run(format: &OutputFormat, cache_file: Option<&std::path::Path>) -> Result<()> {
     // Load the cache
-    let cache = sync_cache(std::path::Path::new("."), cache_file)?;
+    let cache = sync_cache(std::path::Path::new("."), cache_file, false)?;
 
     // Process the rules from the cache
     match format {
diff --git a/codeinput/src/core/commands/list_tags.rs b/codeinput/src/core/commands/list_tags.rs
@@ -23,7 +23,7 @@ pub fn run(
     let repo = repo.unwrap_or_else(|| std::path::Path::new("."));
 
     // Load the cache
-    let cache = sync_cache(repo, cache_file)?;
+    let cache = sync_cache(repo, cache_file, false)?;
 
     // Sort tags by number of files they're associated with (descending)
     let mut tags_with_counts: Vec<_> = cache.tags_map.iter().collect();
diff --git a/codeinput/src/core/commands/parse.rs b/codeinput/src/core/commands/parse.rs
@@ -41,7 +41,7 @@ pub fn run(
     // Build the cache from the parsed CODEOWNERS entries and the files
     let hash = get_repo_hash(path)?;
 
-    let cache = build_cache(parsed_codeowners, files, hash)?;
+    let cache = build_cache(parsed_codeowners, files, hash, false)?;
 
     // Store the cache in the specified file
     store_cache(&cache, &cache_file, encoding)?;
diff --git a/codeinput/src/core/mod.rs b/codeinput/src/core/mod.rs
@@ -1,4 +1,4 @@
-pub(crate) mod cache;
+pub mod cache;
 pub mod commands;
 pub(crate) mod common;
 pub(crate) mod display;
diff --git a/codeinput/src/core/parse.rs b/codeinput/src/core/parse.rs
@@ -7,8 +7,10 @@ use super::{
     types::{CacheEncoding, CodeownersCache, CodeownersEntry},
 };
 
-pub fn parse_repo(repo: &std::path::Path, cache_file: &std::path::Path) -> Result<CodeownersCache> {
-    println!("Parsing CODEOWNERS files at {}", repo.display());
+pub fn parse_repo(repo: &std::path::Path, cache_file: &std::path::Path, quiet: bool) -> Result<CodeownersCache> {
+    if !quiet {
+        println!("Parsing CODEOWNERS files at {}", repo.display());
+    }
 
     // Collect all CODEOWNERS files in the specified path
     let codeowners_files = find_codeowners_files(repo)?;
@@ -30,12 +32,14 @@ pub fn parse_repo(repo: &std::path::Path, cache_file: &std::path::Path) -> Resul
     let hash = get_repo_hash(repo)?;
 
     // Build the cache from the parsed CODEOWNERS entries and the files
-    let cache = build_cache(parsed_codeowners, files, hash)?;
+    let cache = build_cache(parsed_codeowners, files, hash, quiet)?;
 
     // Store the cache in the specified file
     store_cache(&cache, &repo.join(cache_file), CacheEncoding::Bincode)?;
 
-    println!("CODEOWNERS parsing completed successfully");
+    if !quiet {
+        println!("CODEOWNERS parsing completed successfully");
+    }
 
     Ok(cache)
 }
diff --git a/codeinput/src/lib.rs b/codeinput/src/lib.rs
@@ -10,3 +10,7 @@ pub use core::types::*;
 pub mod core;
 #[cfg(not(feature = "types"))]
 pub mod utils;
+
+// LSP server module (requires full features - not just types)
+#[cfg(all(not(feature = "types"), feature = "tokio", feature = "tower-lsp"))]
+pub mod lsp;
diff --git a/codeinput/src/lsp/mod.rs b/codeinput/src/lsp/mod.rs
@@ -0,0 +1,8 @@
+//! Language Server Protocol (LSP) implementation for CODEOWNERS integration
+//!
+//! This module provides an LSP server that integrates with the codeinput CLI
+//! to provide real-time CODEOWNERS information in editors like VS Code, Neovim, etc.
+
+pub mod server;
+
+pub use server::LspServer;
diff --git a/codeinput/src/lsp/server.rs b/codeinput/src/lsp/server.rs
