Enable 'require-await', 'no-misused-promises' and 'no-floating-promises'

Except where we have to ignore them individually.

Author: andyleejordan

.eslintrc.json

@@ -11,7 +11,11 @@
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": "latest",
-    "sourceType": "module"
+    "sourceType": "module",
+    "tsconfigRootDir": ".",
+    "project": [
+      "./tsconfig.json"
+    ]
   },
   "plugins": [
     "@typescript-eslint",
@@ -39,6 +43,15 @@
         "argsIgnorePattern": "^_"
       }
     ],
+    "@typescript-eslint/require-await": [
+      "error"
+    ],
+    "@typescript-eslint/no-misused-promises": [
+      "error"
+    ],
+    "@typescript-eslint/no-floating-promises": [
+      "error"
+    ],
     "header/header": [
       2,
       "line",

src/features/CodeActions.ts

@@ -12,8 +12,8 @@ export class CodeActionsFeature implements vscode.Disposable {
     constructor(private log: ILogger) {
         // TODO: What type is `edit`, what uses this, and is it working?
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        this.applyEditsCommand = vscode.commands.registerCommand("PowerShell.ApplyCodeActionEdits", (edit: any) => {
-            Window.activeTextEditor?.edit((editBuilder) => {
+        this.applyEditsCommand = vscode.commands.registerCommand("PowerShell.ApplyCodeActionEdits", async (edit: any) => {
+            await Window.activeTextEditor?.edit((editBuilder) => {
                 editBuilder.replace(
                     new vscode.Range(
                         edit.StartLineNumber - 1,
@@ -25,8 +25,8 @@ export class CodeActionsFeature implements vscode.Disposable {
         });
 
         this.showDocumentationCommand =
-            vscode.commands.registerCommand("PowerShell.ShowCodeActionDocumentation", (ruleName: string) => {
-                this.showRuleDocumentation(ruleName);
+            vscode.commands.registerCommand("PowerShell.ShowCodeActionDocumentation", async (ruleName: string) => {
+                await this.showRuleDocumentation(ruleName);
             });
     }
 
@@ -35,7 +35,7 @@ export class CodeActionsFeature implements vscode.Disposable {
         this.showDocumentationCommand.dispose();
     }
 
-    public showRuleDocumentation(ruleId: string) {
+    public async showRuleDocumentation(ruleId: string) {
         const pssaDocBaseURL = "https://docs.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/";
 
         if (!ruleId) {
@@ -47,6 +47,6 @@ export class CodeActionsFeature implements vscode.Disposable {
             ruleId = ruleId.substr(2);
         }
 
-        vscode.commands.executeCommand("vscode.open", vscode.Uri.parse(pssaDocBaseURL + `${ruleId}`));
+        await vscode.commands.executeCommand("vscode.open", vscode.Uri.parse(pssaDocBaseURL + `${ruleId}`));
     }
 }

src/features/CustomViews.ts

@@ -99,12 +99,10 @@ class PowerShellContentProvider implements vscode.TextDocumentContentProvider {
     public closeView(id: string) {
         const uriString = this.getUri(id);
 
-        vscode.workspace.textDocuments.some((doc) => {
+        vscode.workspace.textDocuments.some(async (doc) => {
             if (doc.uri.toString() === uriString) {
-                vscode.window
-                    .showTextDocument(doc)
-                    .then((_) => vscode.commands.executeCommand("workbench.action.closeActiveEditor"));
-
+                await vscode.window.showTextDocument(doc);
+                await vscode.commands.executeCommand("workbench.action.closeActiveEditor");
                 return true;
             }
 

src/features/DebugSession.ts

@@ -80,6 +80,7 @@ export class DebugSessionFeature extends LanguageClientConsumer
             : this.sessionManager.getSessionDetails();
 
         if (sessionDetails === undefined) {
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
             this.logger.writeAndShowError(`No session details available for ${session.name}`);
             return;
         }
@@ -101,15 +102,17 @@ export class DebugSessionFeature extends LanguageClientConsumer
             languageClient.onNotification(
                 StartDebuggerNotificationType,
                 // TODO: Use a named debug configuration.
-                async () => await vscode.debug.startDebugging(undefined, {
+                // eslint-disable-next-line @typescript-eslint/no-misused-promises
+                () => vscode.debug.startDebugging(undefined, {
                     request: "launch",
                     type: "PowerShell",
                     name: "PowerShell: Interactive Session"
                 })),
 
             languageClient.onNotification(
                 StopDebuggerNotificationType,
-                async () => await vscode.debug.stopDebugging(undefined))
+                // eslint-disable-next-line @typescript-eslint/no-misused-promises
+                () => vscode.debug.stopDebugging(undefined))
         ];
     }
 
@@ -188,7 +191,7 @@ export class DebugSessionFeature extends LanguageClientConsumer
 
         if (config.script === "${file}" || config.script === "${relativeFile}") {
             if (vscode.window.activeTextEditor === undefined) {
-                vscode.window.showErrorMessage("To debug the 'Current File', you must first open a PowerShell script file in the editor.");
+                await vscode.window.showErrorMessage("To debug the 'Current File', you must first open a PowerShell script file in the editor.");
                 return undefined;
             }
             config.current_document = true;
@@ -214,7 +217,7 @@ export class DebugSessionFeature extends LanguageClientConsumer
         } else if (config.request === "launch") {
             resolvedConfig = await this.resolveLaunchDebugConfiguration(config);
         } else {
-            vscode.window.showErrorMessage(`The request type was invalid: '${config.request}'`);
+            await vscode.window.showErrorMessage(`The request type was invalid: '${config.request}'`);
             return null;
         }
 
@@ -235,7 +238,7 @@ export class DebugSessionFeature extends LanguageClientConsumer
         if (config.current_document) {
             const currentDocument = vscode.window.activeTextEditor?.document;
             if (currentDocument?.languageId !== "powershell") {
-                vscode.window.showErrorMessage("Please change the current document's language mode to PowerShell.");
+                await vscode.window.showErrorMessage("Please change the current document's language mode to PowerShell.");
                 return undefined;
             }
         }
@@ -244,13 +247,13 @@ export class DebugSessionFeature extends LanguageClientConsumer
         // check the document extension for everything else.
         if (config.untitled_document) {
             if (config.createTemporaryIntegratedConsole) {
-                vscode.window.showErrorMessage("Debugging untitled files in a temporary console is not supported.");
+                await vscode.window.showErrorMessage("Debugging untitled files in a temporary console is not supported.");
                 return undefined;
             }
         } else if (config.script) {
             const ext = path.extname(config.script).toLowerCase();
             if (!(ext === ".ps1" || ext === ".psm1")) {
-                vscode.window.showErrorMessage(`PowerShell does not support debugging this file type: '${path.basename(config.script)}'`);
+                await vscode.window.showErrorMessage(`PowerShell does not support debugging this file type: '${path.basename(config.script)}'`);
                 return undefined;
             }
         }
@@ -262,13 +265,13 @@ export class DebugSessionFeature extends LanguageClientConsumer
         const platformDetails = getPlatformDetails();
         const versionDetails = this.sessionManager.getPowerShellVersionDetails();
         if (versionDetails === undefined) {
-            vscode.window.showErrorMessage(`Session version details were not found for ${config.name}`);
+            await vscode.window.showErrorMessage(`Session version details were not found for ${config.name}`);
             return null;
         }
 
         // Cross-platform attach to process was added in 6.2.0-preview.4.
         if (versionDetails.version < "7.0.0" && platformDetails.operatingSystem !== OperatingSystem.Windows) {
-            vscode.window.showErrorMessage(`Attaching to a PowerShell Host Process on ${OperatingSystem[platformDetails.operatingSystem]} requires PowerShell 7.0 or higher.`);
+            await vscode.window.showErrorMessage(`Attaching to a PowerShell Host Process on ${OperatingSystem[platformDetails.operatingSystem]} requires PowerShell 7.0 or higher.`);
             return undefined;
         }
 
@@ -328,7 +331,7 @@ export class SpecifyScriptArgsFeature implements vscode.Disposable {
         // When user cancel's the input box (by pressing Esc), the text value is undefined.
         // Let's not blow away the previous setting.
         if (text !== undefined) {
-            this.context.workspaceState.update(powerShellDbgScriptArgsKey, text);
+            await this.context.workspaceState.update(powerShellDbgScriptArgsKey, text);
         }
         return text;
     }
@@ -393,6 +396,7 @@ export class PickPSHostProcessFeature extends LanguageClientConsumer {
                 (resolve, reject) => {
                     this.getLanguageClientResolve = resolve;
 
+                    // eslint-disable-next-line @typescript-eslint/no-floating-promises
                     vscode.window
                         .showQuickPick(
                             ["Cancel"],
@@ -411,6 +415,7 @@ export class PickPSHostProcessFeature extends LanguageClientConsumer {
                             this.clearWaitingToken();
                             reject();
 
+                            // eslint-disable-next-line @typescript-eslint/no-floating-promises
                             vscode.window.showErrorMessage(
                                 "Attach to PowerShell host process: PowerShell session took too long to start.");
                         }
@@ -519,6 +524,7 @@ export class PickRunspaceFeature extends LanguageClientConsumer {
                 (resolve, reject) => {
                     this.getLanguageClientResolve = resolve;
 
+                    // eslint-disable-next-line @typescript-eslint/no-floating-promises
                     vscode.window
                         .showQuickPick(
                             ["Cancel"],
@@ -537,6 +543,7 @@ export class PickRunspaceFeature extends LanguageClientConsumer {
                             this.clearWaitingToken();
                             reject();
 
+                            // eslint-disable-next-line @typescript-eslint/no-floating-promises
                             vscode.window.showErrorMessage(
                                 "Attach to PowerShell host process: PowerShell session took too long to start.");
                         }

src/features/Examples.ts

@@ -11,8 +11,8 @@ export class ExamplesFeature implements vscode.Disposable {
 
     constructor() {
         this.examplesPath = vscode.Uri.file(path.resolve(__dirname, "../examples"));
-        this.command = vscode.commands.registerCommand("PowerShell.OpenExamplesFolder", () => {
-            vscode.commands.executeCommand("vscode.openFolder", this.examplesPath, true);
+        this.command = vscode.commands.registerCommand("PowerShell.OpenExamplesFolder", async () => {
+            await vscode.commands.executeCommand("vscode.openFolder", this.examplesPath, true);
             // Return existence of the path for testing. The `vscode.openFolder`
             // command should do this, but doesn't (yet).
             return utils.checkIfFileExists(this.examplesPath);

src/features/ExpandAlias.ts

@@ -22,7 +22,7 @@ export class ExpandAliasFeature extends LanguageClientConsumer {
 
     constructor() {
         super();
-        this.command = vscode.commands.registerCommand("PowerShell.ExpandAlias", () => {
+        this.command = vscode.commands.registerCommand("PowerShell.ExpandAlias", async () => {
             const editor = Window.activeTextEditor;
             if (editor === undefined) {
                 return;
@@ -44,11 +44,12 @@ export class ExpandAliasFeature extends LanguageClientConsumer {
                 range = new vscode.Range(sls.line, sls.character, sle.line, sle.character);
             }
 
-            this.languageClient?.sendRequest(ExpandAliasRequestType, { text }).then((result) => {
-                editor.edit((editBuilder) => {
+            const result = await this.languageClient?.sendRequest(ExpandAliasRequestType, { text });
+            if (result !== undefined) {
+                await editor.edit((editBuilder) => {
                     editBuilder.replace(range, result.text);
                 });
-            });
+            }
         });
     }
 

src/features/ExtensionCommands.ts

@@ -235,6 +235,7 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
 
             this.languageClient.onRequest(
                 InsertTextRequestType,
+                // eslint-disable-next-line @typescript-eslint/no-floating-promises
                 (details) => this.insertText(details)),
 
             this.languageClient.onRequest(
@@ -280,6 +281,7 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
                     // We check to see if they have TrueClear on. If not, no-op because the
                     // overriden Clear-Host already calls [System.Console]::Clear()
                     if (Settings.load().integratedConsole.forceClearScrollbackBuffer) {
+                        // eslint-disable-next-line @typescript-eslint/no-floating-promises
                         vscode.commands.executeCommand("workbench.action.terminal.clear");
                     }
                 })
@@ -309,8 +311,7 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
     private async showExtensionCommands(client: LanguageClient): Promise<void> {
         // If no extension commands are available, show a message
         if (this.extensionCommands.length === 0) {
-            vscode.window.showInformationMessage(
-                "No extension commands have been loaded into the current session.");
+            await vscode.window.showInformationMessage("No extension commands have been loaded into the current session.");
             return;
         }
 
@@ -329,12 +330,12 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
         return this.onCommandSelected(selectedCommand, client);
     }
 
-    private onCommandSelected(
+    private async onCommandSelected(
         chosenItem: IExtensionCommandQuickPickItem | undefined,
         client: LanguageClient | undefined) {
 
         if (chosenItem !== undefined) {
-            client?.sendRequest(
+            await client?.sendRequest(
                 InvokeExtensionCommandRequestType,
                 {
                     name: chosenItem.command.name,
@@ -343,7 +344,7 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
         }
     }
 
-    private insertText(details: IInsertTextRequestArguments): EditorOperationResponse {
+    private async insertText(details: IInsertTextRequestArguments): Promise<EditorOperationResponse> {
         const edit = new vscode.WorkspaceEdit();
 
         edit.set(
@@ -359,7 +360,7 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
             ],
         );
 
-        vscode.workspace.applyEdit(edit);
+        await vscode.workspace.applyEdit(edit);
 
         return EditorOperationResponse.Completed;
     }
@@ -461,7 +462,7 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
             if (!saveFileDetails.newPath) {
                 // TODO: Create a class handle vscode warnings and errors so we can warn easily
                 //       without logging
-                this.log.writeAndShowWarning(
+                await this.log.writeAndShowWarning(
                     "Cannot save untitled file. Try SaveAs(\"path/to/file.ps1\") instead.");
                 return EditorOperationResponse.Completed;
             }
@@ -472,7 +473,7 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
             } else {
                 // In fresh contexts, workspaceFolders is not defined...
                 if (!vscode.workspace.workspaceFolders || vscode.workspace.workspaceFolders.length === 0) {
-                    this.log.writeAndShowWarning("Cannot save file to relative path: no workspaces are open. " +
+                    await this.log.writeAndShowWarning("Cannot save file to relative path: no workspaces are open. " +
                             "Try saving to an absolute path, or open a workspace.");
                     return EditorOperationResponse.Completed;
                 }
@@ -481,7 +482,7 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
                 const workspaceRootUri = vscode.workspace.workspaceFolders[0].uri;
                 // We don't support saving to a non-file URI-schemed workspace
                 if (workspaceRootUri.scheme !== "file") {
-                    this.log.writeAndShowWarning(
+                    await this.log.writeAndShowWarning(
                         "Cannot save untitled file to a relative path in an untitled workspace. " +
                             "Try saving to an absolute path or opening a workspace folder.");
                     return EditorOperationResponse.Completed;
@@ -521,15 +522,15 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
                 vscode.Uri.file(destinationAbsolutePath),
                 Buffer.from(oldDocument.getText()));
         } catch (e) {
-            this.log.writeAndShowWarning(`<${ExtensionCommandsFeature.name}>: ` +
+            await this.log.writeAndShowWarning(`<${ExtensionCommandsFeature.name}>: ` +
                 `Unable to save file to path '${destinationAbsolutePath}': ${e}`);
             return;
         }
 
         // Finally open the new document
         const newFileUri = vscode.Uri.file(destinationAbsolutePath);
         const newFile = await vscode.workspace.openTextDocument(newFileUri);
-        vscode.window.showTextDocument(newFile, { preview: true });
+        await vscode.window.showTextDocument(newFile, { preview: true });
     }
 
     private normalizeFilePath(filePath: string): string {