feat: Add docs about include_path and format code. (#57)

feat: Add docs about include_path and format code.

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 LSP workspace root.
 - `disable_parse_diagnostics`: Set to `true` to disable diagnostics during parsing.
 
 #### Experimental Configuration

src/config/workspace.rs

@@ -81,9 +81,10 @@ impl WorkspaceProtoConfigs {
     }
 
     pub fn get_include_paths(&self, uri: &Url) -> Option<Vec<PathBuf>> {
-        let c = self.get_config_for_uri(uri)?;
+        let cfg = 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 mut ipath: Vec<PathBuf> = cfg
             .config
             .include_paths
             .iter()

src/context/jumpable.rs

@@ -1,4 +1,4 @@
 pub enum Jumpable {
     Import(String),
-    Identifier(String)
+    Identifier(String),
 }

src/main.rs

@@ -10,6 +10,7 @@ use tower::ServiceBuilder;
 use tracing::Level;
 
 mod config;
+mod context;
 mod formatter;
 mod lsp;
 mod nodekind;
@@ -18,7 +19,6 @@ mod server;
 mod state;
 mod utils;
 mod workspace;
-mod context;
 
 #[tokio::main(flavor = "current_thread")]
 async fn main() {

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;