Add quarto.symbols.exportToWorkspace LSP setting

Author: lionel-

apps/lsp/src/config.ts

@@ -43,6 +43,9 @@ export interface Settings {
       readonly scale: number;
       readonly extensions: MathjaxSupportedExtension[];
     }
+    readonly symbols: {
+      readonly exportToWorkspace: 'default' | 'all' | 'none';
+    };
   };
   readonly markdown: {
     readonly preferredMdPathExtensionStyle: 'auto' | 'includeExtension' | 'removeExtension';
@@ -88,6 +91,9 @@ function defaultSettings(): Settings {
       mathjax: {
         scale: 1,
         extensions: []
+      },
+      symbols: {
+        exportToWorkspace: 'all'
       }
     },
     markdown: {
@@ -165,6 +171,9 @@ export class ConfigurationManager extends Disposable {
         mathjax: {
           scale: settings.quarto.mathjax.scale,
           extensions: settings.quarto.mathjax.extensions
+        },
+        symbols: {
+          exportToWorkspace: settings.quarto.symbols.exportToWorkspace
         }
       }
     };
@@ -224,12 +233,13 @@ export function lsConfiguration(configManager: ConfigurationManager): LsConfigur
     },
     get mathjaxExtensions(): readonly MathjaxSupportedExtension[] {
       return configManager.getSettings().quarto.mathjax.extensions;
+    },
+    get exportSymbolsToWorkspace(): 'default' | 'all' | 'none' {
+      return configManager.getSettings().quarto.symbols.exportToWorkspace;
     }
   }
 }
 
-
-
 export function getDiagnosticsOptions(configManager: ConfigurationManager): DiagnosticOptions {
   const settings = configManager.getSettings();
   if (!settings) {

apps/lsp/src/service/config.ts

@@ -79,6 +79,7 @@ export interface LsConfiguration {
   readonly colorTheme: 'light' | 'dark';
   readonly mathjaxScale: number;
   readonly mathjaxExtensions: readonly MathjaxSupportedExtension[];
+  readonly exportSymbolsToWorkspace: 'default' | 'all' | 'none';
 }
 
 export const defaultMarkdownFileExtension = 'qmd';
@@ -109,7 +110,8 @@ const defaultConfig: LsConfiguration = {
   includeWorkspaceHeaderCompletions: 'never',
   colorTheme: 'light',
   mathjaxScale: 1,
-  mathjaxExtensions: []
+  mathjaxExtensions: [],
+  exportSymbolsToWorkspace: 'all'
 };
 
 export function defaultLsConfiguration(): LsConfiguration {

apps/lsp/src/service/index.ts

@@ -209,7 +209,7 @@ export function createLanguageService(init: LanguageServiceInitialization): IMdL
   const diagnosticOnSaveComputer = new DiagnosticOnSaveComputer(init.quarto);
   const diagnosticsComputer = new DiagnosticComputer(config, init.workspace, linkProvider, tocProvider, logger);
   const docSymbolProvider = new MdDocumentSymbolProvider(tocProvider, linkProvider, logger);
-  const workspaceSymbolProvider = new MdWorkspaceSymbolProvider(init.workspace, docSymbolProvider);
+  const workspaceSymbolProvider = new MdWorkspaceSymbolProvider(init.workspace, init.config, docSymbolProvider);
   const documentHighlightProvider = new MdDocumentHighlightProvider(config, tocProvider, linkProvider);
 
   return Object.freeze<IMdLanguageService>({

apps/lsp/src/service/providers/workspace-symbols.ts

@@ -14,24 +14,32 @@
  *
  */
 
+import * as fs from 'fs';
+import { Utils } from 'vscode-uri';
 import { CancellationToken } from 'vscode-languageserver';
 import * as lsp from 'vscode-languageserver-types';
 import { Disposable } from 'core';
 import { Document } from 'quarto-core';
 import { IWorkspace } from '../workspace';
 import { MdWorkspaceInfoCache } from '../workspace-cache';
 import { MdDocumentSymbolProvider } from './document-symbols';
+import { LsConfiguration } from '../config';
 
 export class MdWorkspaceSymbolProvider extends Disposable {
-
+  readonly #config: LsConfiguration;
   readonly #cache: MdWorkspaceInfoCache<readonly lsp.SymbolInformation[]>;
   readonly #symbolProvider: MdDocumentSymbolProvider;
+  readonly #workspace: IWorkspace;
 
   constructor(
     workspace: IWorkspace,
+    config: LsConfiguration,
     symbolProvider: MdDocumentSymbolProvider,
   ) {
     super();
+
+    this.#workspace = workspace;
+    this.#config = config;
     this.#symbolProvider = symbolProvider;
 
     this.#cache = this._register(new MdWorkspaceInfoCache(workspace, (doc, token) => this.provideDocumentSymbolInformation(doc, token)));
@@ -42,6 +50,12 @@ export class MdWorkspaceSymbolProvider extends Disposable {
       return [];
     }
 
+    switch (this.#config.exportSymbolsToWorkspace) {
+      case 'all': break;
+      case 'default': if (shouldExportSymbolsToWorkspace(this.#workspace)) return []; else break;
+      case 'none': return [];
+    }
+
     const allSymbols = await this.#cache.values();
 
     if (token.isCancellationRequested) {
@@ -73,3 +87,17 @@ export class MdWorkspaceSymbolProvider extends Disposable {
     }
   }
 }
+
+function shouldExportSymbolsToWorkspace(workspace: IWorkspace): boolean {
+  return isRPackage(workspace);
+}
+
+function isRPackage(workspace: IWorkspace): boolean {
+  if (workspace.workspaceFolders === undefined) {
+    return false;
+  }
+
+  const projectPath = workspace.workspaceFolders[0];
+  const descPath = Utils.joinPath(projectPath, 'DESCRIPTION');
+  return fs.existsSync(descPath.fsPath);
+}

apps/vscode/package.json

@@ -1319,6 +1319,17 @@
             "error"
           ],
           "markdownDescription": "Log level for the Quarto language server."
+        },
+        "quarto.symbols.exportToWorkspace": {
+          "type": "string",
+          "enum": ["default", "all", "none"],
+          "enumDescriptions": [
+            "Depends on the project type: `\"none\"` in R packages, `\"all\"` otherwise.",
+            "",
+            ""
+          ],
+          "default": "default",
+          "description": "Whether Markdown elements like section headers are included in workspace symbol search."
         }
       }
     },

apps/vscode/src/lsp/client.ts

@@ -13,6 +13,7 @@
  *
  */
 
+import * as fs from "fs";
 import * as path from "path";
 import {
   ExtensionContext,