fix: add config for warning on transaction flag #816

Author: polarmutex

README.md

@@ -220,7 +220,8 @@ The language server accepts configuration via LSP initialization options:
     "currency_column": 60,
     "account_amount_spacing": 2,
     "number_currency_spacing": 1
-  }
+  },
+  "diagnostic_flags": ["!"]  // Optional: flags that generate warnings (default: ["!"])
 }
 ```
 
@@ -368,6 +369,46 @@ If the PyO3 embedded checker is not working:
 
    Check your configuration if you need to explicitly set a method.
 
+### Diagnostic Flags Configuration
+
+By default, the language server generates warnings for all flagged transactions (entries with flags like `!`, `P`, etc.). You can configure which flags should generate diagnostics to reduce noise from intentional flags.
+
+| Option             | Type     | Description                                                      | Default |
+| ------------------ | -------- | ---------------------------------------------------------------- | ------- |
+| `diagnostic_flags` | string[] | List of transaction flags that should generate warning diagnostics | `["!"]` |
+
+**Default behavior** (only `!` flag generates warnings):
+
+```json
+{
+  "diagnostic_flags": ["!"]
+}
+```
+
+This means padding transactions with `P` flag, or other custom flags, won't generate warnings.
+
+**Include multiple flags:**
+
+```json
+{
+  "diagnostic_flags": ["!", "P"]
+}
+```
+
+This generates warnings for both `!` (needs attention) and `P` (padding) flags.
+
+**Disable all flag diagnostics:**
+
+```json
+{
+  "diagnostic_flags": []
+}
+```
+
+This completely disables warnings for flagged transactions.
+
+**Use case**: Some users intentionally use flags like `P` for padding transactions that will persist forever in the ledger. With the default configuration, these won't generate noise in your diagnostics panel, while `!` flags (which typically indicate transactions needing review) will still show warnings.
+
 ### Formatting Options
 
 | Option                    | Type   | Description                                                 | Default            | Bean-format Equivalent     |
@@ -465,7 +506,9 @@ This controls the whitespace between numbers and currency codes:
        "prefix_width": 30,
        "currency_column": 60,
        "number_currency_spacing": 1
-     }
+     },
+     // Optional: flags that generate warnings (default: ["!"])
+     "beancountLangServer.diagnosticFlags": ["!"]
    }
    ```
 
@@ -493,6 +536,8 @@ return {
     init_options = {
         -- Optional: Only needed for multi-file projects with include directives
         journal_file = "main.bean",
+        -- Optional: flags that generate warnings (default: ["!"])
+        diagnostic_flags = { "!" },
     },
     settings = {
         beancount = {
@@ -521,6 +566,8 @@ lspconfig.beancount.setup({
       currency_column = 60,
       number_currency_spacing = 1,
     },
+    -- Optional: flags that generate warnings (default: {"!"})
+    diagnostic_flags = { "!" },
   },
 })
 

crates/lsp/src/beancount_data.rs

@@ -95,14 +95,9 @@ fn get_note_query() -> &'static tree_sitter::Query {
 pub struct FlaggedEntry {
     _file: String,
     pub line: u32,
+    pub flag: String,
 }
 
-//impl FlaggedEntry {
-//    pub fn new(file: String, line: u32) -> Self {
-//        Self { file, line }
-//    }
-//}
-
 #[derive(Clone, Debug)]
 pub struct BeancountData {
     accounts: Arc<Vec<String>>,
@@ -170,10 +165,16 @@ impl BeancountData {
                         links_set.insert(text_for_tree_sitter_node(content, &capture.node));
                     }
                     idx if idx == flag_idx => {
-                        tracing::debug!("adding flag entry: {:?}", capture.node);
+                        let flag_text = text_for_tree_sitter_node(content, &capture.node);
+                        tracing::debug!(
+                            "adding flag entry: {:?} with flag '{}'",
+                            capture.node,
+                            flag_text
+                        );
                         flagged_entries.push(FlaggedEntry {
                             _file: "".to_string(),
                             line: capture.node.start_position().row as u32,
+                            flag: flag_text,
                         });
                     }
                     idx if idx == account_idx => {

crates/lsp/src/config.rs

@@ -12,6 +12,8 @@ pub struct Config {
     pub journal_root: Option<PathBuf>,
     pub formatting: FormattingConfig,
     pub bean_check: BeancountCheckConfig,
+    /// Flags that should generate diagnostics (e.g., ["!"] for only exclamation mark)
+    pub diagnostic_flags: Vec<String>,
 }
 
 #[derive(Debug, Clone)]
@@ -62,6 +64,7 @@ impl Config {
             journal_root: None,
             formatting: FormattingConfig::default(),
             bean_check: BeancountCheckConfig::new(),
+            diagnostic_flags: vec!["!".to_string()],
         }
     }
     pub fn update(&mut self, json: serde_json::Value) -> Result<()> {
@@ -126,6 +129,11 @@ impl Config {
             }
         }
 
+        // Update diagnostic_flags configuration
+        if let Some(diagnostic_flags) = beancount_lsp_settings.diagnostic_flags {
+            self.diagnostic_flags = diagnostic_flags;
+        }
+
         Ok(())
     }
 }
@@ -135,6 +143,8 @@ pub struct BeancountLspOptions {
     pub journal_file: Option<String>,
     pub formatting: Option<FormattingOptions>,
     pub bean_check: Option<BeancountCheckOptions>,
+    /// Flags that should generate diagnostics (e.g., ["!"] for only exclamation mark)
+    pub diagnostic_flags: Option<Vec<String>>,
 }
 
 #[derive(Debug, Clone, Default, Deserialize, Serialize)]
@@ -489,4 +499,31 @@ mod tests {
             Some(PathBuf::from("/usr/bin/python3"))
         );
     }
+
+    #[test]
+    fn test_diagnostic_flags_default() {
+        let config = Config::new(PathBuf::new());
+        assert_eq!(config.diagnostic_flags, vec!["!".to_string()]);
+    }
+
+    #[test]
+    fn test_diagnostic_flags_custom() {
+        let mut config = Config::new(PathBuf::new());
+        config
+            .update(serde_json::from_str(r#"{"diagnostic_flags": ["!", "P"]}"#).unwrap())
+            .unwrap();
+        assert_eq!(
+            config.diagnostic_flags,
+            vec!["!".to_string(), "P".to_string()]
+        );
+    }
+
+    #[test]
+    fn test_diagnostic_flags_empty() {
+        let mut config = Config::new(PathBuf::new());
+        config
+            .update(serde_json::from_str(r#"{"diagnostic_flags": []}"#).unwrap())
+            .unwrap();
+        assert_eq!(config.diagnostic_flags, Vec::<String>::new());
+    }
 }