Add multi-root choice experience to powershell.cwd

Author: andyleejordan

src/main.ts

@@ -52,19 +52,25 @@ const documentSelector: DocumentSelector = [
     { language: "powershell", scheme: "untitled" },
 ];
 
-export function activate(context: vscode.ExtensionContext): IPowerShellExtensionClient {
-    // create telemetry reporter on extension activation
+// NOTE: Now that this is async, we can probably improve a lot!
+export async function activate(context: vscode.ExtensionContext): Promise<IPowerShellExtensionClient> {
     telemetryReporter = new TelemetryReporter(PackageJSON.name, PackageJSON.version, AI_KEY);
 
-    // If both extensions are enabled, this will cause unexpected behavior since both register the same commands
+    // If both extensions are enabled, this will cause unexpected behavior since both register the same commands.
+    // TODO: Merge extensions and use preview channel in marketplace instead.
     if (PackageJSON.name.toLowerCase() === "powershell-preview"
         && vscode.extensions.getExtension("ms-vscode.powershell")) {
         vscode.window.showWarningMessage(
             "'PowerShell' and 'PowerShell Preview' are both enabled. Please disable one for best performance.");
     }
 
+    // This displays a popup and a changelog after an update.
     checkForUpdatedVersion(context, PackageJSON.version);
 
+    // Load and validate settings (will prompt for 'cwd' if necessary).
+    await Settings.validateCwdSetting();
+    const extensionSettings = Settings.load();
+
     vscode.languages.setLanguageConfiguration(
         PowerShellLanguageId,
         {
@@ -118,11 +124,8 @@ export function activate(context: vscode.ExtensionContext): IPowerShellExtension
             ],
         });
 
-    // Create the logger
+    // Setup the logger.
     logger = new Logger();
-
-    // Set the log level
-    const extensionSettings = Settings.load();
     logger.MinimumLogLevel = LogLevel[extensionSettings.developer.editorServicesLogLevel];
 
     sessionManager =

src/settings.ts

@@ -134,10 +134,10 @@ export interface INotebooksSettings {
     saveMarkdownCellsAs?: CommentType;
 }
 
+// TODO: This could probably be async, and call `validateCwdSetting()` directly.
 export function load(): ISettings {
     const configuration: vscode.WorkspaceConfiguration =
-        vscode.workspace.getConfiguration(
-            utils.PowerShellLanguageId);
+        vscode.workspace.getConfiguration(utils.PowerShellLanguageId);
 
     const defaultBugReportingSettings: IBugReportingSettings = {
         project: "https://github.com/PowerShell/vscode-powershell",
@@ -265,17 +265,17 @@ export function load(): ISettings {
             //   is the reason terminals on macOS typically run login shells by default which set up
             //   the environment. See http://unix.stackexchange.com/a/119675/115410"
             configuration.get<IStartAsLoginShellSettings>("startAsLoginShell", defaultStartAsLoginShellSettings),
-        cwd: // TODO: Should we resolve this path and/or default to a workspace folder?
-            configuration.get<string>("cwd", null),
+        cwd: // NOTE: This must be validated at startup via `validateCwdSetting()`. There's probably a better way to do this.
+            configuration.get<string>("cwd", undefined),
     };
 }
 
 // Get the ConfigurationTarget (read: scope) of where the *effective* setting value comes from
 export async function getEffectiveConfigurationTarget(settingName: string): Promise<vscode.ConfigurationTarget> {
     const configuration = vscode.workspace.getConfiguration(utils.PowerShellLanguageId);
-
     const detail = configuration.inspect(settingName);
     let configurationTarget = null;
+
     if (typeof detail.workspaceFolderValue !== "undefined") {
         configurationTarget = vscode.ConfigurationTarget.WorkspaceFolder;
     }
@@ -294,7 +294,6 @@ export async function change(
     configurationTarget?: vscode.ConfigurationTarget | boolean): Promise<void> {
 
     const configuration = vscode.workspace.getConfiguration(utils.PowerShellLanguageId);
-
     await configuration.update(settingName, newValue, configurationTarget);
 }
 
@@ -312,3 +311,30 @@ function getWorkspaceSettingsWithDefaults<TSettings>(
     }
     return defaultSettings;
 }
+
+export async function validateCwdSetting(): Promise<string> {
+    let cwd: string = vscode.workspace.getConfiguration(utils.PowerShellLanguageId).get<string>("cwd", null);
+
+    // Only use the cwd setting if it exists.
+    if (utils.checkIfDirectoryExists(cwd)) {
+        return cwd;
+    } else {
+        // Otherwise use a workspace folder, prompting if necessary.
+        if (vscode.workspace.workspaceFolders?.length > 1) {
+            const options: vscode.WorkspaceFolderPickOptions = {
+                placeHolder: "Select a folder to use as the PowerShell extension's working directory.",
+            }
+            cwd = (await vscode.window.showWorkspaceFolderPick(options))?.uri.fsPath;
+            // Save the picked 'cwd' to the workspace settings.
+            await change("cwd", cwd);
+        } else {
+            cwd = vscode.workspace.workspaceFolders?.[0].uri.fsPath;
+        }
+        // If there were no workspace folders, or somehow they don't exist, use
+        // the home directory.
+        if (cwd === undefined || !utils.checkIfDirectoryExists(cwd)) {
+            return process.cwd();
+        }
+        return cwd;
+    }
+}