Use common implementation for R package detection

lionel- · lionel- · commit ac6e441270f4 · 2025-07-10T16:03:09.000+02:00
diff --git a/apps/lsp/src/r-utils.ts b/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);
+}
diff --git a/apps/lsp/src/service/providers/workspace-symbols.ts b/apps/lsp/src/service/providers/workspace-symbols.ts
@@ -14,8 +14,6 @@
  *
  */
 
-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';
@@ -24,6 +22,7 @@ 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;
@@ -52,7 +51,7 @@ export class MdWorkspaceSymbolProvider extends Disposable {
 
     switch (this.#config.exportSymbolsToWorkspace) {
       case 'all': break;
-      case 'default': if (shouldExportSymbolsToWorkspace(this.#workspace)) return []; else break;
+      case 'default': if (await shouldExportSymbolsToWorkspace(this.#workspace)) return []; else break;
       case 'none': return [];
     }
 
@@ -88,16 +87,6 @@ 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);
+async function shouldExportSymbolsToWorkspace(workspace: IWorkspace): Promise<boolean> {
+  return await isRPackage(workspace);
 }
diff --git a/apps/lsp/tsconfig.json b/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",
diff --git a/apps/utils/r-utils.ts b/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 [''];
+  }
+}
diff --git a/apps/vscode/src/lsp/client.ts b/apps/vscode/src/lsp/client.ts
@@ -13,7 +13,6 @@
  *
  */
 
-import * as fs from "fs";
 import * as path from "path";
 import {
   ExtensionContext,
diff --git a/apps/vscode/src/providers/preview/preview-util.ts b/apps/vscode/src/providers/preview/preview-util.ts
@@ -60,34 +60,6 @@ export function isQuartoShinyKnitrDoc(
 
 }
 
-export async function isRPackage(): Promise<boolean> {
-  const descriptionLines = await parseRPackageDescription();
-  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(): Promise<string[]> {
-  if (vscode.workspace.workspaceFolders !== undefined) {
-    const folderUri = vscode.workspace.workspaceFolders[0].uri;
-    const fileUri = vscode.Uri.joinPath(folderUri, 'DESCRIPTION');
-    try {
-      const bytes = await vscode.workspace.fs.readFile(fileUri);
-      const descriptionText = Buffer.from(bytes).toString('utf8');
-      const descriptionLines = descriptionText.split(/(\r?\n)/);
-      return descriptionLines;
-    } catch { }
-  }
-  return [''];
-}
-
 export async function renderOnSave(engine: MarkdownEngine, document: TextDocument) {
   // if its a notebook and we don't have a save hook for notebooks then don't
   // allow renderOnSave (b/c we can't detect the saves)
diff --git a/apps/vscode/src/providers/preview/preview.ts b/apps/vscode/src/providers/preview/preview.ts
@@ -74,7 +74,6 @@ import {
   haveNotebookSaveEvents,
   isQuartoShinyDoc,
   isQuartoShinyKnitrDoc,
-  isRPackage,
   renderOnSave,
 } from "./preview-util";
 
@@ -88,6 +87,7 @@ import {
   yamlErrorLocation,
 } from "./preview-errors";
 import { ExtensionHost } from "../../host";
+import { isRPackage } from "../../r-utils";
 
 tmp.setGracefulCleanup();
 
diff --git a/apps/vscode/src/r-utils.ts b/apps/vscode/src/r-utils.ts
@@ -0,0 +1,29 @@
+/*
+ * 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 vscode from 'vscode';
+import { isRPackage as isRPackageImpl } from "@utils/r-utils";
+
+// Version that selects workspace folder
+export async function isRPackage(): Promise<boolean> {
+  if (vscode.workspace.workspaceFolders === undefined) {
+    return false;
+  }
+
+  // Pick first workspace
+  const workspaceFolder = vscode.workspace.workspaceFolders[0];
+
+  return isRPackageImpl(workspaceFolder.uri);
+}
diff --git a/apps/vscode/tsconfig.json b/apps/vscode/tsconfig.json
@@ -5,7 +5,11 @@
     "outDir": "out",
     "lib": ["ES2021"],
     "sourceMap": true,
-    "strict": true /* enable all strict type-checking options */
+    "strict": true,
+    "paths": {
+      "@utils/*": ["../utils/*"]
+    }
+    /* enable all strict type-checking options */
     /* Additional Checks */
     // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
     // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,6 @@`
`13`	`13`	`*`
`14`	`14`	`*/`
`15`	`15`
`16`		`-import * as fs from "fs";`
`17`	`16`	`import * as path from "path";`
`18`	`17`	`import {`
`19`	`18`	`ExtensionContext,`