feat: relative include path uses git root if available

Author: coder3101

README.md

@@ -95,7 +95,7 @@ clang_format_path = "/usr/bin/clang-format" # clang-format binary to execute in
 
 The `[config]` section contains stable settings that should generally remain unchanged.
 
-- `include_paths`: Directories to search for `.proto` files.
+- `include_paths`: Directories to search for `.proto` files. Absolute or relative to git root. If git root is unavailble, LSP's workspace is used.
 - `disable_parse_diagnostics`: Set to `true` to disable diagnostics during parsing.
 
 #### Experimental Configuration

src/config/workspace.rs

@@ -1,6 +1,7 @@
 use std::{
     collections::{HashMap, HashSet},
     path::{Path, PathBuf},
+    process::Command,
 };
 
 use async_lsp::lsp_types::{Url, WorkspaceFolder};
@@ -17,10 +18,22 @@ pub struct WorkspaceProtoConfigs {
     configs: HashMap<Url, ProtolsConfig>,
     formatters: HashMap<Url, ClangFormatter>,
     protoc_include_prefix: Vec<PathBuf>,
+    git_root: Option<PathBuf>,
 }
 
 impl WorkspaceProtoConfigs {
     pub fn new() -> Self {
+        let mut git_root = None;
+        if let Ok(output) = Command::new("git")
+            .args(["rev-parse", "--show-toplevel"])
+            .output()
+        {
+            if output.status.success() {
+                let p = String::from_utf8_lossy(&output.stdout).to_string();
+                git_root = Some(PathBuf::from(p))
+            }
+        }
+
         Self {
             workspaces: Default::default(),
             formatters: Default::default(),
@@ -30,6 +43,7 @@ impl WorkspaceProtoConfigs {
                 .map(|l| l.include_paths)
                 .unwrap_or_default(),
             configs: Default::default(),
+            git_root,
         }
     }
 
@@ -81,9 +95,18 @@ impl WorkspaceProtoConfigs {
     }
 
     pub fn get_include_paths(&self, uri: &Url) -> Option<Vec<PathBuf>> {
-        let c = self.get_config_for_uri(uri)?;
-        let w = self.get_workspace_for_uri(uri)?.to_file_path().ok()?;
-        let mut ipath: Vec<PathBuf> = c
+        let cfg = self.get_config_for_uri(uri)?;
+
+        // How to replace relative paths in include_paths?
+        // If there's a git root use that else the root will be LSP workspace root
+        let w = if let Some(root) = &self.git_root {
+            tracing::info!(?root, "using git root as relative path replacer");
+            root.clone()
+        } else {
+            self.get_workspace_for_uri(uri)?.to_file_path().ok()?
+        };
+
+        let mut ipath: Vec<PathBuf> = cfg
             .config
             .include_paths
             .iter()

src/workspace/hover.rs

@@ -663,8 +663,6 @@ Included from {}"#,
 
 #[cfg(test)]
 mod test {
-    use std::path::PathBuf;
-
     use insta::assert_yaml_snapshot;
 
     use crate::context::hoverable::Hoverables;