Enhance additionalPowerShellExes setting

Now the warning that's emitted when an additional PowerShell executable
isn't found can be suppressed with a setting. If the setting's value has
single or double quotes, it handles it. If the executable name wasn't
appended, it handles it. Smarter!

Author: andyleejordan

package.json

@@ -669,6 +669,11 @@
           "markdownDescription": "**Deprecated:** Specifies whether you should be prompted to update your version of `PackageManagement` if it's under 1.4.6.",
           "markdownDeprecationMessage": "**Deprecated:** This prompt has been removed as it's no longer strictly necessary to upgrade the `PackageManagement` module."
         },
+        "powershell.suppressAdditionalExeNotFoundWarning": {
+          "type": "boolean",
+          "default": false,
+          "markdownDescription": "Suppresses the warning message when any of `#powershell.powerShellAdditionalExePaths#` is not found."
+        },
         "powershell.startAsLoginShell.osx": {
           "type": "boolean",
           "default": true,

src/platform.ts

@@ -4,9 +4,10 @@
 import * as os from "os";
 import * as path from "path";
 import * as process from "process";
+import vscode = require("vscode");
 import { integer } from "vscode-languageserver-protocol";
 import { ILogger } from "./logging";
-import { PowerShellAdditionalExePathSettings } from "./settings";
+import { changeSetting, getSettings, PowerShellAdditionalExePathSettings } from "./settings";
 
 // This uses require so we can rewire it in unit tests!
 // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-var-requires
@@ -41,6 +42,7 @@ export interface IPowerShellExeDetails {
     readonly displayName: string;
     readonly exePath: string;
     readonly supportsProperArguments: boolean;
+    readonly suppressWarning: boolean;
 }
 
 export function getPlatformDetails(): IPlatformDetails {
@@ -149,8 +151,12 @@ export class PowerShellExeFinder {
         for (const additionalPwsh of this.enumerateAdditionalPowerShellInstallations()) {
             if (await additionalPwsh.exists()) {
                 yield additionalPwsh;
-            } else {
-                void this.logger.writeAndShowWarning(`Additional PowerShell '${additionalPwsh.displayName}' not found at '${additionalPwsh.exePath}'!`);
+            } else if (!additionalPwsh.suppressWarning
+                && !getSettings().suppressAdditionalExeNotFoundWarning) {
+                const selection = await vscode.window.showWarningMessage(`Additional PowerShell '${additionalPwsh.displayName}' not found at '${additionalPwsh.exePath}'!`, "Don't Show Again");
+                if (selection !== undefined) {
+                    await changeSetting("suppressAdditionalExeNotFoundWarning", true, true, this.logger);
+                }
             }
         }
     }
@@ -223,9 +229,39 @@ export class PowerShellExeFinder {
     private *enumerateAdditionalPowerShellInstallations(): Iterable<IPossiblePowerShellExe> {
         for (const versionName in this.additionalPowerShellExes) {
             if (Object.prototype.hasOwnProperty.call(this.additionalPowerShellExes, versionName)) {
-                const exePath = this.additionalPowerShellExes[versionName];
-                if (exePath) {
-                    yield new PossiblePowerShellExe(exePath, versionName);
+                let exePath = this.additionalPowerShellExes[versionName];
+                if (!exePath) {
+                    continue;
+                }
+
+                // Remove surrounding quotes from path (without regex)
+                if (exePath.startsWith("'") && exePath.endsWith("'")
+                    || exePath.startsWith("\"") && exePath.endsWith("\"")) {
+                    exePath = exePath.slice(1, -1);
+                }
+
+                // Always search for what the user gave us first
+                yield new PossiblePowerShellExe(exePath, versionName);
+
+                // Also search for `pwsh[.exe]` and `powershell[.exe]` if missing
+                const args: [string, undefined, boolean, boolean]
+                    // Must be a tuple type and is suppressing the warning
+                    = [versionName, undefined, true, true];
+
+                // Handle Windows where '.exe' and 'powershell' are things
+                if (this.platformDetails.operatingSystem === OperatingSystem.Windows) {
+                    if (!exePath.endsWith("pwsh.exe") && !exePath.endsWith("powershell.exe")) {
+                        if (exePath.endsWith("pwsh") || exePath.endsWith("powershell")) {
+                            // Add extension if that was missing
+                            yield new PossiblePowerShellExe(exePath + ".exe", ...args);
+                        }
+                        // Also add full exe names (this isn't an else just in case
+                        // the folder was named "pwsh" or "powershell")
+                        yield new PossiblePowerShellExe(exePath + "\\pwsh.exe", ...args);
+                        yield new PossiblePowerShellExe(exePath + "\\powershell.exe", ...args);
+                    }
+                } else if (!exePath.endsWith("pwsh")) { // Always just 'pwsh' on non-Windows
+                    yield new PossiblePowerShellExe(exePath + "/pwsh", ...args);
                 }
             }
         }
@@ -536,7 +572,8 @@ class PossiblePowerShellExe implements IPossiblePowerShellExe {
         public readonly exePath: string,
         public readonly displayName: string,
         private knownToExist?: boolean,
-        public readonly supportsProperArguments = true) { }
+        public readonly supportsProperArguments = true,
+        public readonly suppressWarning = false) { }
 
     public async exists(): Promise<boolean> {
         if (this.knownToExist === undefined) {

src/session.ts

@@ -952,6 +952,7 @@ Type 'help' to get help.
             this.platformDetails,
             // We don't pull from session settings because we want them fresh!
             getSettings().powerShellAdditionalExePaths,
+            true, // Only show warning on initialization.
             this.logger);
         const availablePowerShellExes = await powershellExeFinder.getAllAvailablePowerShellInstallations();
 

src/settings.ts

@@ -23,6 +23,7 @@ export class Settings extends PartialSettings {
     // This setting is no longer used but is here to assist in cleaning up the users settings.
     powerShellExePath = "";
     promptToUpdatePowerShell = true;
+    suppressAdditionalExeNotFoundWarning = false;
     startAsLoginShell = new StartAsLoginShellSettings();
     startAutomatically = true;
     enableProfileLoading = true;