Don't include comment sections in workspace symbols by default

Author: lionel-

crates/ark/src/lsp/config.rs

@@ -33,6 +33,14 @@ pub static GLOBAL_SETTINGS: &[Setting<LspConfig>] = &[
                 .unwrap_or_else(|| SymbolsConfig::default().include_assignments_in_blocks)
         },
     },
+    Setting {
+        key: "positron.r.workspaceSymbols.includeCommentSections",
+        set: |cfg, v| {
+            cfg.workspace_symbols.include_comment_sections = v
+                .as_bool()
+                .unwrap_or_else(|| WorkspaceSymbolsConfig::default().include_comment_sections)
+        },
+    },
 ];
 
 /// These document settings are updated on a URI basis. Each document has its
@@ -77,6 +85,7 @@ pub static DOCUMENT_SETTINGS: &[Setting<DocumentConfig>] = &[
 pub(crate) struct LspConfig {
     pub(crate) diagnostics: DiagnosticsConfig,
     pub(crate) symbols: SymbolsConfig,
+    pub(crate) workspace_symbols: WorkspaceSymbolsConfig,
 }
 
 #[derive(Serialize, Deserialize, Clone, Debug)]
@@ -85,6 +94,12 @@ pub struct SymbolsConfig {
     pub include_assignments_in_blocks: bool,
 }
 
+#[derive(Serialize, Deserialize, Clone, Debug)]
+pub struct WorkspaceSymbolsConfig {
+    /// Whether to include sections like `# My section ---` in workspace symbols.
+    pub include_comment_sections: bool,
+}
+
 /// Configuration of a document.
 ///
 /// The naming follows <https://editorconfig.org/> where possible.
@@ -120,6 +135,14 @@ impl Default for SymbolsConfig {
     }
 }
 
+impl Default for WorkspaceSymbolsConfig {
+    fn default() -> Self {
+        Self {
+            include_comment_sections: false,
+        }
+    }
+}
+
 impl Default for IndentationConfig {
     fn default() -> Self {
         Self {

crates/ark/src/lsp/handlers.rs

@@ -129,8 +129,9 @@ pub(crate) async fn handle_initialized(
 #[tracing::instrument(level = "info", skip_all)]
 pub(crate) fn handle_symbol(
     params: WorkspaceSymbolParams,
+    state: &WorldState,
 ) -> anyhow::Result<Option<Vec<SymbolInformation>>> {
-    symbols::symbols(&params)
+    symbols::symbols(&params, state)
         .map(|res| Some(res))
         .or_else(|err| {
             // Missing doc: Why are we not propagating errors to the frontend?

crates/ark/src/lsp/main_loop.rs

@@ -281,7 +281,7 @@ impl GlobalState {
                             respond(tx, || state_handlers::initialize(params, &mut self.lsp_state, &mut self.world), LspResponse::Initialize)?;
                         },
                         LspRequest::WorkspaceSymbol(params) => {
-                            respond(tx, || handlers::handle_symbol(params), LspResponse::WorkspaceSymbol)?;
+                            respond(tx, || handlers::handle_symbol(params, &self.world), LspResponse::WorkspaceSymbol)?;
                         },
                         LspRequest::DocumentSymbol(params) => {
                             respond(tx, || handlers::handle_document_symbol(params, &self.world), LspResponse::DocumentSymbol)?;

crates/ark/src/lsp/symbols.rs

@@ -56,7 +56,10 @@ fn new_symbol_node(
     symbol
 }
 
-pub fn symbols(params: &WorkspaceSymbolParams) -> anyhow::Result<Vec<SymbolInformation>> {
+pub(crate) fn symbols(
+    params: &WorkspaceSymbolParams,
+    state: &WorldState,
+) -> anyhow::Result<Vec<SymbolInformation>> {
     let query = &params.query;
     let mut info: Vec<SymbolInformation> = Vec::new();
 
@@ -81,17 +84,19 @@ pub fn symbols(params: &WorkspaceSymbolParams) -> anyhow::Result<Vec<SymbolInfor
             },
 
             IndexEntryData::Section { level: _, title } => {
-                info.push(SymbolInformation {
-                    name: title.to_string(),
-                    kind: SymbolKind::STRING,
-                    location: Location {
-                        uri: Url::from_file_path(path).unwrap(),
-                        range: entry.range,
-                    },
-                    tags: None,
-                    deprecated: None,
-                    container_name: None,
-                });
+                if state.config.workspace_symbols.include_comment_sections {
+                    info.push(SymbolInformation {
+                        name: title.to_string(),
+                        kind: SymbolKind::STRING,
+                        location: Location {
+                            uri: Url::from_file_path(path).unwrap(),
+                            range: entry.range,
+                        },
+                        tags: None,
+                        deprecated: None,
+                        container_name: None,
+                    });
+                }
             },
 
             IndexEntryData::Variable { name } => {