Exclude section headers from workspace symbols in R packages (#858)

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
         }
       }
     };
@@ -225,12 +234,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/r-utils.ts

@@ -0,0 +1,27 @@
+/*
+ * r-utils.ts
+ *
+ * Copyright (C) 2025 by Posit Software, PBC
+ *
+ * Unless you have received this program directly from Posit Software pursuant
+ * to the terms of a commercial license agreement with Posit Software, then
+ * this program is licensed to you under the terms of version 3 of the
+ * GNU Affero General Public License. This program is distributed WITHOUT
+ * ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
+ * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
+ * AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.
+ *
+ */
+
+import { isRPackage as isRPackageImpl } from "@utils/r-utils";
+import { IWorkspace } from './service';
+
+// Version that selects workspace folder
+export async function isRPackage(workspace: IWorkspace): Promise<boolean> {
+  if (workspace.workspaceFolders === undefined) {
+    return false;
+  }
+
+  const folderUri = workspace.workspaceFolders[0];
+  return isRPackageImpl(folderUri);
+}

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

@@ -21,17 +21,24 @@ import { Document } from 'quarto-core';
 import { IWorkspace } from '../workspace';
 import { MdWorkspaceInfoCache } from '../workspace-cache';
 import { MdDocumentSymbolProvider } from './document-symbols';
+import { LsConfiguration } from '../config';
+import { isRPackage } from '../../r-utils';
 
 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 +49,12 @@ export class MdWorkspaceSymbolProvider extends Disposable {
       return [];
     }
 
+    switch (this.#config.exportSymbolsToWorkspace) {
+      case 'all': break;
+      case 'default': if (await shouldExportSymbolsToWorkspace(this.#workspace)) return []; else break;
+      case 'none': return [];
+    }
+
     const allSymbols = await this.#cache.values();
 
     if (token.isCancellationRequested) {
@@ -73,3 +86,7 @@ export class MdWorkspaceSymbolProvider extends Disposable {
     }
   }
 }
+
+async function shouldExportSymbolsToWorkspace(workspace: IWorkspace): Promise<boolean> {
+  return await isRPackage(workspace);
+}

apps/lsp/tsconfig.json

@@ -3,9 +3,11 @@
     "lib": ["ES2020"],
     "module": "CommonJS",
     "outDir": "./dist",
-    "rootDir": "./src",
     "sourceMap": true,
     "resolveJsonModule": true,
+    "paths": {
+      "@utils/*": ["../utils/*"]
+    }
   },
   "exclude": ["node_modules"],
   "extends": "tsconfig/base.json",

apps/utils/r-utils.ts

@@ -0,0 +1,63 @@
+/*
+ * r-utils.ts
+ *
+ * Copyright (C) 2025 by Posit Software, PBC
+ *
+ * Unless you have received this program directly from Posit Software pursuant
+ * to the terms of a commercial license agreement with Posit Software, then
+ * this program is licensed to you under the terms of version 3 of the
+ * GNU Affero General Public License. This program is distributed WITHOUT
+ * ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
+ * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
+ * AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.
+ *
+ */
+
+import * as fs from "fs/promises";
+import * as path from "path";
+import { URI } from 'vscode-uri';
+
+/**
+ * Checks if the given folder contains an R package.
+ *
+ * Determined by:
+ * - Presence of a `DESCRIPTION` file.
+ * - Presence of `Package:` field.
+ * - Presence of `Type: package` field and value.
+ *
+ * The fields are checked to disambiguate real packages from book repositories using a `DESCRIPTION` file.
+ *
+ * @param folderPath Folder to check for a `DESCRIPTION` file.
+ */
+export async function isRPackage(folderUri: URI): Promise<boolean> {
+  // We don't currently support non-file schemes
+  if (folderUri.scheme !== 'file') {
+    return false;
+  }
+
+  const descriptionLines = await parseRPackageDescription(folderUri.fsPath);
+  if (!descriptionLines) {
+    return false;
+  }
+
+  const packageLines = descriptionLines.filter(line => line.startsWith('Package:'));
+  const typeLines = descriptionLines.filter(line => line.startsWith('Type:'));
+
+  const typeIsPackage = (typeLines.length > 0
+    ? typeLines[0].toLowerCase().includes('package')
+    : false);
+  const typeIsPackageOrMissing = typeLines.length === 0 || typeIsPackage;
+
+  return packageLines.length > 0 && typeIsPackageOrMissing;
+}
+
+async function parseRPackageDescription(folderPath: string): Promise<string[]> {
+  const filePath = path.join(folderPath, 'DESCRIPTION');
+
+  try {
+    const descriptionText = await fs.readFile(filePath, 'utf8');
+    return descriptionText.split(/\r?\n/);
+  } catch {
+    return [''];
+  }
+}

apps/vscode/.vscode-test.mjs

@@ -8,4 +8,13 @@ export default defineConfig([
       timeout: 5000,
     },
   },
+  // R project workspace
+  {
+    label: 'r-project',
+    files: 'test-out/r-project.test.js',
+    workspaceFolder: 'src/test/examples/r-project',
+    mocha: {
+      timeout: 5000,
+    },
+  },
 ]);

apps/vscode/.vscode/launch.json

@@ -13,13 +13,18 @@
       "outFiles": ["${workspaceFolder}/out/**/*.js"],
       "preLaunchTask": "${defaultBuildTask}"
     },
-    {
-      "type": "node",
-      "request": "attach",
-      "name": "Attach to Server",
-      "port": 6009,
-      "restart": true,
-      "outFiles": ["${workspaceRoot}/out/**/*.js"]
-    }
+		{
+			"name": "Extension Tests",
+			"type": "extensionHost",
+			"request": "launch",
+			"runtimeExecutable": "${execPath}",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}",
+				"--extensionTestsPath=${workspaceFolder}/test-out",
+				"${workspaceFolder}/src/test/examples"
+			],
+			"outFiles": ["${workspaceFolder}/test-out/**/*.js"],
+      "preLaunchTask": "yarn: build-test"
+		}
   ]
 }

apps/vscode/.vscode/tasks.json

@@ -15,6 +15,13 @@
         "kind": "build",
         "isDefault": true
       }
+    },
+    {
+      "label": "yarn: build-test",
+      "type": "shell",
+      "command": "yarn",
+      "args": ["build-test"],
+      "problemMatcher": []
     }
   ]
 }