breaking: refactor config to be simpler (#64)

closes #63

Author: asharkhan3101

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "protols"
 description = "Language server for proto3 files"
-version = "0.10.0"
+version = "0.2.0"
 edition = "2024"
 license = "MIT"
 homepage = "https://github.com/coder3101/protols"

Cargo.toml

@@ -3,16 +3,12 @@
 [![Crates.io](https://img.shields.io/crates/v/protols.svg)](https://crates.io/crates/protols)  
 [![Build and Test](https://github.com/coder3101/protols/actions/workflows/ci.yml/badge.svg)](https://github.com/coder3101/protols/actions/workflows/ci.yml)
 
-**WARNING** : Master branch is undergoing a massive refactoring, please use last relesed tag instead.
-
 **Protols** is an open-source, feature-rich [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) for **Protocol Buffers (proto)** files. Powered by the efficient [tree-sitter](https://tree-sitter.github.io/tree-sitter/) parser, Protols offers intelligent code assistance for protobuf development, including features like auto-completion, diagnostics, formatting, and more.
 
-![Protols Demo](./assets/protols.mov)
-
 ## ✨ Features
 
 - ✅ **Code Completion**: Auto-complete messages, enums, and keywords in your `.proto` files.
-- ✅ **Diagnostics**: Syntax errors and import error detected with the tree-sitter parser.
+- ✅ **Diagnostics**: Syntax errors, import error detected with the tree-sitter and advanced diagnostics from `protoc` parser.
 - ✅ **Document Symbols**: Navigate and view all symbols, including messages and enums.
 - ✅ **Code Formatting**: Format `.proto` files using `clang-format` for a consistent style.
 - ✅ **Go to Definition**: Jump to the definition of symbols like messages or enums and imports.
@@ -29,9 +25,7 @@
   - [For Visual Studio Code](#for-visual-studio-code)
 - [Configuration](#configuration)
   - [Basic Configuration](#basic-configuration)
-  - [Experimental Configuration](#experimental-configuration)
-  - [Formatter Configuration](#formatter-configuration)
-  - [Multiple Configuration Files](#multiple-configuration-files)
+  - [Path Configuration](#path-configuration)
 - [Usage](#usage)
   - [Code Completion](#code-completion)
   - [Diagnostics](#diagnostics)
@@ -78,16 +72,12 @@ Protols is configured using a `protols.toml` file, which you can place in any di
 ### Sample `protols.toml`
 
 ```toml
-[config] # Base configuration; these are considered stable and should not change
+[config]
 include_paths = ["foobar", "bazbaaz"] # Include paths to look for protofiles during parsing
-disable_parse_diagnostics = true # Disable diagnostics for parsing
-
-[config.experimental] # experimental configuration; this should be considered unsafe and not fully tested
-use_protoc_diagnostics = true # use diagnostics from protoc
-protoc_path = "protoc" # Path to proto compiler (protoc)
 
-[formatter] # Formatter specific configuration
-clang_format_path = "/usr/bin/clang-format" # clang-format binary to execute in formatting
+[config.path]
+clang_format = "clang-format"
+protoc = "protoc"
 ```
 
 ### Configuration Sections
@@ -96,21 +86,14 @@ 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. Absolute or relative to LSP workspace root.
-- `disable_parse_diagnostics`: Set to `true` to disable tree-sitter parse diagnostics during parsing.
-
-#### Experimental Configuration
-
-The `[config.experimental]` section contains settings that are in development or not fully tested.
-
-- `use_protoc_diagnostics`: Enable diagnostics from the `protoc` compiler when set to `true`.
-- `protoc_path`: Uses protoc from this path for diagnostics
+- `include_paths`: Directories to search for `.proto` files. Absolute or relative to LSP workspace root. Worspace root is already included in include_paths
 
-#### Formatter Configuration
+#### Path Configuration
 
-The `[formatter]` section allows configuration for code formatting.
+The `[config.path]` section contains path for various tools used by LSP.
 
-- `clang_format_path`: Specify the path to the `clang-format` binary.
+- `clang_format`: Uses clang_format from this path for formatting
+- `protoc`: Uses protoc from this path for diagnostics
 
 ---
 
@@ -124,7 +107,7 @@ Protols offers a rich set of features to enhance your `.proto` file editing expe
 
 ### Diagnostics
 
-Syntax errors are caught by the tree-sitter parser, which highlights issues directly in your editor. For more advanced error reporting, the LSP can be configured to use `protoc` diagnostics.
+Syntax errors are caught by the tree-sitter parser, which highlights issues directly in your editor. More advanced error reporting, is done by `protoc` which runs after a file saved. You must have `protoc` installed and added to your path or you can specify its path in the configuration above
 
 ### Code Formatting
 

README.md

@@ -1,9 +1,6 @@
 [config]
 include_paths = ["foobar", "bazbaaz"]
-disable_parse_diagnostics = true
 
-[config.experimental]
-use_protoc_diagnostics = true
-
-[formatter]
-clang_format_path = "/usr/bin/clang-format"
+[config.path]
+protoc = "/usr/bin/protoc"
+clang_format = "/usr/bin/clang-format"

src/config/input/protols-valid.toml

@@ -14,44 +14,31 @@ fn default_protoc_path() -> String {
 #[serde(default)]
 pub struct ProtolsConfig {
     pub config: Config,
-    pub formatter: FormatterConfig,
 }
 
 #[derive(Serialize, Deserialize, Debug, Clone)]
 pub struct FormatterConfig {
-    #[serde(default = "default_clang_format_path")]
-    pub clang_format_path: String,
 }
 
 #[derive(Serialize, Deserialize, Debug, Clone, Default)]
 #[serde(default)]
 pub struct Config {
     pub include_paths: Vec<String>,
-    pub single_file_mode: bool,
-    pub disable_parse_diagnostics: bool,
-    pub experimental: ExperimentalConfig,
+    pub path: PathConfig,
 }
 
 #[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(default)]
-pub struct ExperimentalConfig {
-    pub use_protoc_diagnostics: bool,
-    pub protoc_path: String,
+pub struct PathConfig {
+    pub clang_format: String,
+    pub protoc: String,
 }
 
-impl Default for FormatterConfig {
+impl Default for PathConfig {
     fn default() -> Self {
         Self {
-            clang_format_path: default_clang_format_path(),
-        }
-    }
-}
-
-impl Default for ExperimentalConfig {
-    fn default() -> Self {
-        Self {
-            protoc_path: default_protoc_path(),
-            use_protoc_diagnostics: false,
+            clang_format: default_clang_format_path(),
+            protoc: default_protoc_path()
         }
     }
 }

src/config/mod.rs

@@ -4,10 +4,6 @@ expression: ws.get_config_for_uri(&inworkspace2).unwrap()
 ---
 config:
   include_paths: []
-  single_file_mode: false
-  disable_parse_diagnostics: false
-  experimental:
-    use_protoc_diagnostics: false
-    protoc_path: protoc
-formatter:
-  clang_format_path: clang-format
+  path:
+    clang_format: clang-format
+    protoc: protoc

src/config/snapshots/protols__config__workspace__test__get_for_workspace-2.snap

@@ -6,10 +6,6 @@ config:
   include_paths:
     - foobar
     - bazbaaz
-  single_file_mode: false
-  disable_parse_diagnostics: true
-  experimental:
-    use_protoc_diagnostics: true
-    protoc_path: protoc
-formatter:
-  clang_format_path: /usr/bin/clang-format
+  path:
+    clang_format: /usr/bin/clang-format
+    protoc: /usr/bin/protoc

src/config/snapshots/protols__config__workspace__test__get_for_workspace.snap

@@ -57,7 +57,7 @@ impl WorkspaceProtoConfigs {
 
         let wr: ProtolsConfig = basic_toml::from_str(&content).unwrap_or_default();
         let fmt = ClangFormatter::new(
-            &wr.formatter.clang_format_path,
+            &wr.config.path.clang_format,
             wpath.to_str().expect("non-utf8 path"),
         );
 

src/config/workspace.rs

@@ -406,7 +406,7 @@ impl LanguageServer for ProtoLanguageServer {
 
         if let Some(diagnostics) = self
             .state
-            .upsert_file(&uri, content, &ipath, 8, &pconf.config)
+            .upsert_file(&uri, content, &ipath, 8, &pconf.config, true)
         {
             if let Err(e) = self.client.publish_diagnostics(diagnostics) {
                 error!(error=%e, "failed to publish diagnostics")
@@ -433,7 +433,7 @@ impl LanguageServer for ProtoLanguageServer {
 
         if let Some(diagnostics) = self
             .state
-            .upsert_file(&uri, content, &ipath, 8, &pconf.config)
+            .upsert_file(&uri, content, &ipath, 8, &pconf.config, true)
         {
             if let Err(e) = self.client.publish_diagnostics(diagnostics) {
                 error!(error=%e, "failed to publish diagnostics")
@@ -454,10 +454,7 @@ impl LanguageServer for ProtoLanguageServer {
             return ControlFlow::Continue(());
         };
 
-        // override config to disable protoc diagnostics during change
-        let mut pconf = pconf.config.clone();
-        pconf.experimental.use_protoc_diagnostics = false;
-        if let Some(diagnostics) = self.state.upsert_file(&uri, content, &ipath, 8, &pconf) {
+        if let Some(diagnostics) = self.state.upsert_file(&uri, content, &ipath, 8, &pconf.config, false) {
             if let Err(e) = self.client.publish_diagnostics(diagnostics) {
                 error!(error=%e, "failed to publish diagnostics")
             }

src/lsp.rs

@@ -223,22 +223,21 @@ impl ProtoLanguageState {
         ipath: &[PathBuf],
         depth: usize,
         config: &Config,
+        protoc_diagnostics: bool,
     ) -> Option<PublishDiagnosticsParams> {
         info!(%uri, %depth, "upserting file");
         let diag = self.upsert_content(uri, content.clone(), ipath, depth);
         self.get_tree(uri).map(|tree| {
             let mut d = vec![];
-            if !config.disable_parse_diagnostics {
-                d.extend(tree.collect_parse_diagnostics());
-            }
+            d.extend(tree.collect_parse_diagnostics());
             d.extend(tree.collect_import_diagnostics(content.as_ref(), diag));
 
             // Add protoc diagnostics if enabled
-            if config.experimental.use_protoc_diagnostics {
+            if protoc_diagnostics {
                 if let Ok(protoc_diagnostics) = self.protoc_diagnostics.lock() {
                     if let Ok(file_path) = uri.to_file_path() {
                         let protoc_diags = protoc_diagnostics.collect_diagnostics(
-                            &config.experimental.protoc_path,
+                            &config.path.protoc,
                             file_path.to_str().unwrap_or_default(),
                             &ipath
                                 .iter()

src/state.rs

@@ -66,9 +66,9 @@ mod test {
         let c = include_str!("input/c.proto");
 
         let mut state: ProtoLanguageState = ProtoLanguageState::new();
-        state.upsert_file(&a_uri, a.to_owned(), &ipath, 2, &Config::default());
-        state.upsert_file(&b_uri, b.to_owned(), &ipath, 2, &Config::default());
-        state.upsert_file(&c_uri, c.to_owned(), &ipath, 2, &Config::default());
+        state.upsert_file(&a_uri, a.to_owned(), &ipath, 2, &Config::default(), false);
+        state.upsert_file(&b_uri, b.to_owned(), &ipath, 2, &Config::default(), false);
+        state.upsert_file(&c_uri, c.to_owned(), &ipath, 2, &Config::default(), false);
 
         assert_yaml_snapshot!(state.definition(
             &ipath,

src/workspace/definition.rs

@@ -679,9 +679,9 @@ mod test {
         let c = include_str!("input/c.proto");
 
         let mut state: ProtoLanguageState = ProtoLanguageState::new();
-        state.upsert_file(&a_uri, a.to_owned(), &ipath, 3, &Config::default());
-        state.upsert_file(&b_uri, b.to_owned(), &ipath, 2, &Config::default());
-        state.upsert_file(&c_uri, c.to_owned(), &ipath, 2, &Config::default());
+        state.upsert_file(&a_uri, a.to_owned(), &ipath, 3, &Config::default(), false);
+        state.upsert_file(&b_uri, b.to_owned(), &ipath, 2, &Config::default(), false);
+        state.upsert_file(&c_uri, c.to_owned(), &ipath, 2, &Config::default(), false);
 
         assert_yaml_snapshot!(state.hover(
             &ipath,

src/workspace/hover.rs

@@ -85,9 +85,9 @@ mod test {
         let c = include_str!("input/c.proto");
 
         let mut state: ProtoLanguageState = ProtoLanguageState::new();
-        state.upsert_file(&a_uri, a.to_owned(), &ipath, 2, &Config::default());
-        state.upsert_file(&b_uri, b.to_owned(), &ipath, 2, &Config::default());
-        state.upsert_file(&c_uri, c.to_owned(), &ipath, 2, &Config::default());
+        state.upsert_file(&a_uri, a.to_owned(), &ipath, 2, &Config::default(), false);
+        state.upsert_file(&b_uri, b.to_owned(), &ipath, 2, &Config::default(), false);
+        state.upsert_file(&c_uri, c.to_owned(), &ipath, 2, &Config::default(), false);
 
         assert_yaml_snapshot!(state.rename_fields(
             "com.workspace",
@@ -124,9 +124,9 @@ mod test {
         let c = include_str!("input/c.proto");
 
         let mut state: ProtoLanguageState = ProtoLanguageState::new();
-        state.upsert_file(&a_uri, a.to_owned(), &ipath, 2, &Config::default());
-        state.upsert_file(&b_uri, b.to_owned(), &ipath, 2, &Config::default());
-        state.upsert_file(&c_uri, c.to_owned(), &ipath, 2, &Config::default());
+        state.upsert_file(&a_uri, a.to_owned(), &ipath, 2, &Config::default(), false);
+        state.upsert_file(&b_uri, b.to_owned(), &ipath, 2, &Config::default(), false);
+        state.upsert_file(&c_uri, c.to_owned(), &ipath, 2, &Config::default(), false);
 
         assert_yaml_snapshot!(state.reference_fields(
             "com.workspace",