Move workspace folder functions to separate file

Author: koesie10

extensions/ql-vscode/src/common/vscode/workspace-folders.ts

@@ -0,0 +1,64 @@
+import { dirname, join } from "path";
+import { workspace, WorkspaceFolder } from "vscode";
+
+/** Returns true if the specified workspace folder is on the file system. */
+export function isWorkspaceFolderOnDisk(
+  workspaceFolder: WorkspaceFolder,
+): boolean {
+  return workspaceFolder.uri.scheme === "file";
+}
+
+/** Gets all active workspace folders that are on the filesystem. */
+export function getOnDiskWorkspaceFoldersObjects() {
+  const workspaceFolders = workspace.workspaceFolders ?? [];
+  return workspaceFolders.filter(isWorkspaceFolderOnDisk);
+}
+
+/** Gets all active workspace folders that are on the filesystem. */
+export function getOnDiskWorkspaceFolders() {
+  return getOnDiskWorkspaceFoldersObjects().map((folder) => folder.uri.fsPath);
+}
+
+/** Check if folder is already present in workspace */
+export function isFolderAlreadyInWorkspace(folderName: string) {
+  const workspaceFolders = workspace.workspaceFolders || [];
+
+  return !!workspaceFolders.find(
+    (workspaceFolder) => workspaceFolder.name === folderName,
+  );
+}
+
+/**
+ * Returns the path of the first folder in the workspace.
+ * This is used to decide where to create skeleton QL packs.
+ *
+ * If the first folder is a QL pack, then the parent folder is returned.
+ * This is because the vscode-codeql-starter repo contains a ql pack in
+ * the first folder.
+ *
+ * This is a temporary workaround until we can retire the
+ * vscode-codeql-starter repo.
+ */
+export function getFirstWorkspaceFolder() {
+  const workspaceFolders = getOnDiskWorkspaceFolders();
+
+  if (!workspaceFolders || workspaceFolders.length === 0) {
+    throw new Error("No workspace folders found");
+  }
+
+  const firstFolderFsPath = workspaceFolders[0];
+
+  // For the vscode-codeql-starter repo, the first folder will be a ql pack
+  // so we need to get the parent folder
+  if (
+    firstFolderFsPath.includes(
+      join("vscode-codeql-starter", "codeql-custom-queries"),
+    )
+  ) {
+    // return the parent folder
+    return dirname(firstFolderFsPath);
+  } else {
+    // if the first folder is not a ql pack, then we are in a normal workspace
+    return firstFolderFsPath;
+  }
+}

extensions/ql-vscode/src/data-extensions-editor/extension-pack-picker.ts

@@ -4,11 +4,11 @@ import { dump as dumpYaml, load as loadYaml } from "js-yaml";
 import { minimatch } from "minimatch";
 import { CancellationToken, window } from "vscode";
 import { CodeQLCliServer } from "../codeql-cli/cli";
+import { showAndLogErrorMessage } from "../helpers";
 import {
   getOnDiskWorkspaceFolders,
   getOnDiskWorkspaceFoldersObjects,
-  showAndLogErrorMessage,
-} from "../helpers";
+} from "../common/vscode/workspace-folders";
 import { ProgressCallback } from "../common/vscode/progress";
 import { DatabaseItem } from "../databases/local-databases";
 import { getQlPackPath, QLPACK_FILENAMES } from "../pure/ql";

extensions/ql-vscode/src/data-extensions-editor/external-api-usage-query.ts

@@ -2,10 +2,8 @@ import { CoreCompletedQuery, QueryRunner } from "../query-server";
 import { dir } from "tmp-promise";
 import { writeFile } from "fs-extra";
 import { dump as dumpYaml } from "js-yaml";
-import {
-  getOnDiskWorkspaceFolders,
-  showAndLogExceptionWithTelemetry,
-} from "../helpers";
+import { showAndLogExceptionWithTelemetry } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import { TeeLogger } from "../common";
 import { isQueryLanguage } from "../common/query-language";
 import { CancellationToken } from "vscode";

extensions/ql-vscode/src/data-extensions-editor/generate-flow-model.ts

@@ -6,10 +6,8 @@ import { CodeQLCliServer } from "../codeql-cli/cli";
 import { TeeLogger } from "../common";
 import { extensiblePredicateDefinitions } from "./predicates";
 import { ProgressCallback } from "../common/vscode/progress";
-import {
-  getOnDiskWorkspaceFolders,
-  showAndLogExceptionWithTelemetry,
-} from "../helpers";
+import { showAndLogExceptionWithTelemetry } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import {
   ModeledMethodType,
   ModeledMethodWithSignature,

extensions/ql-vscode/src/databases/local-databases/database-manager.ts

@@ -14,11 +14,13 @@ import { join } from "path";
 import { FullDatabaseOptions } from "./database-options";
 import { DatabaseItemImpl } from "./database-item-impl";
 import {
-  getFirstWorkspaceFolder,
-  isFolderAlreadyInWorkspace,
   showAndLogExceptionWithTelemetry,
   showNeverAskAgainDialog,
 } from "../../helpers";
+import {
+  getFirstWorkspaceFolder,
+  isFolderAlreadyInWorkspace,
+} from "../../common/vscode/workspace-folders";
 import { isQueryLanguage } from "../../common/query-language";
 import { existsSync } from "fs";
 import { QlPackGenerator } from "../../qlpack-generator";

extensions/ql-vscode/src/databases/qlpack.ts

@@ -6,7 +6,7 @@ import { readFile } from "fs-extra";
 import { getQlPackPath } from "../pure/ql";
 import { CodeQLCliServer, QlpacksInfo } from "../codeql-cli/cli";
 import { extLogger } from "../common";
-import { getOnDiskWorkspaceFolders } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 
 export interface QlPacksForLanguage {
   /** The name of the pack containing the dbscheme. */

extensions/ql-vscode/src/debugger/debug-configuration.ts

@@ -4,7 +4,8 @@ import {
   DebugConfigurationProvider,
   WorkspaceFolder,
 } from "vscode";
-import { getOnDiskWorkspaceFolders, showAndLogErrorMessage } from "../helpers";
+import { showAndLogErrorMessage } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import { LocalQueries } from "../local-queries";
 import { getQuickEvalContext, validateQueryPath } from "../run-queries-shared";
 import * as CodeQLProtocol from "./debug-protocol";

extensions/ql-vscode/src/helpers.ts

@@ -1,7 +1,7 @@
 import { ensureDirSync, pathExists, ensureDir, writeFile } from "fs-extra";
-import { join, dirname } from "path";
+import { join } from "path";
 import { dirSync } from "tmp-promise";
-import { Uri, window as Window, workspace, env, WorkspaceFolder } from "vscode";
+import { Uri, window as Window, workspace, env } from "vscode";
 import { CodeQLCliServer } from "./codeql-cli/cli";
 import { UserCancellationException } from "./common/vscode/progress";
 import { extLogger, OutputChannelLogger } from "./common";
@@ -11,6 +11,7 @@ import { RedactableError } from "./pure/errors";
 import { isQueryLanguage, QueryLanguage } from "./common/query-language";
 import { isCodespacesTemplate } from "./config";
 import { AppCommandManager } from "./common/commands";
+import { getOnDiskWorkspaceFolders } from "./common/vscode/workspace-folders";
 
 // Shared temporary folder for the extension.
 export const tmpDir = dirSync({
@@ -232,13 +233,6 @@ export async function showInformationMessageWithAction(
   return chosenItem === actionItem;
 }
 
-/** Returns true if the specified workspace folder is on the file system. */
-export function isWorkspaceFolderOnDisk(
-  workspaceFolder: WorkspaceFolder,
-): boolean {
-  return workspaceFolder.uri.scheme === "file";
-}
-
 /**
  * Opens a modal dialog for the user to make a choice between yes/no/never be asked again.
  *
@@ -279,26 +273,6 @@ export async function showNeverAskAgainDialog(
   return chosenItem?.title;
 }
 
-/** Gets all active workspace folders that are on the filesystem. */
-export function getOnDiskWorkspaceFoldersObjects() {
-  const workspaceFolders = workspace.workspaceFolders ?? [];
-  return workspaceFolders.filter(isWorkspaceFolderOnDisk);
-}
-
-/** Gets all active workspace folders that are on the filesystem. */
-export function getOnDiskWorkspaceFolders() {
-  return getOnDiskWorkspaceFoldersObjects().map((folder) => folder.uri.fsPath);
-}
-
-/** Check if folder is already present in workspace */
-export function isFolderAlreadyInWorkspace(folderName: string) {
-  const workspaceFolders = workspace.workspaceFolders || [];
-
-  return !!workspaceFolders.find(
-    (workspaceFolder) => workspaceFolder.name === folderName,
-  );
-}
-
 /** Check if the current workspace is the CodeTour and open the workspace folder.
  * Without this, we can't run the code tour correctly.
  **/
@@ -448,39 +422,3 @@ export async function createTimestampFile(storagePath: string) {
   await ensureDir(storagePath);
   await writeFile(timestampPath, Date.now().toString(), "utf8");
 }
-
-/**
- * Returns the path of the first folder in the workspace.
- * This is used to decide where to create skeleton QL packs.
- *
- * If the first folder is a QL pack, then the parent folder is returned.
- * This is because the vscode-codeql-starter repo contains a ql pack in
- * the first folder.
- *
- * This is a temporary workaround until we can retire the
- * vscode-codeql-starter repo.
- */
-
-export function getFirstWorkspaceFolder() {
-  const workspaceFolders = getOnDiskWorkspaceFolders();
-
-  if (!workspaceFolders || workspaceFolders.length === 0) {
-    throw new Error("No workspace folders found");
-  }
-
-  const firstFolderFsPath = workspaceFolders[0];
-
-  // For the vscode-codeql-starter repo, the first folder will be a ql pack
-  // so we need to get the parent folder
-  if (
-    firstFolderFsPath.includes(
-      join("vscode-codeql-starter", "codeql-custom-queries"),
-    )
-  ) {
-    // return the parent folder
-    return dirname(firstFolderFsPath);
-  } else {
-    // if the first folder is not a ql pack, then we are in a normal workspace
-    return firstFolderFsPath;
-  }
-}

extensions/ql-vscode/src/language-support/contextual/query-resolver.ts

@@ -3,10 +3,8 @@ import { dump } from "js-yaml";
 import { file } from "tmp-promise";
 import { basename, dirname, resolve } from "path";
 
-import {
-  getOnDiskWorkspaceFolders,
-  showAndLogExceptionWithTelemetry,
-} from "../../helpers";
+import { showAndLogExceptionWithTelemetry } from "../../helpers";
+import { getOnDiskWorkspaceFolders } from "../../common/vscode/workspace-folders";
 import {
   getPrimaryDbscheme,
   getQlPackForDbscheme,

extensions/ql-vscode/src/local-queries/local-queries.ts

@@ -19,11 +19,11 @@ import { basename } from "path";
 import {
   createTimestampFile,
   findLanguage,
-  getOnDiskWorkspaceFolders,
   showAndLogErrorMessage,
   showAndLogWarningMessage,
   showBinaryChoiceDialog,
 } from "../helpers";
+import { getOnDiskWorkspaceFolders } from "../common/vscode/workspace-folders";
 import { displayQuickQuery } from "./quick-query";
 import { CoreCompletedQuery, QueryRunner } from "../query-server";
 import { QueryHistoryManager } from "../query-history/query-history-manager";