Enable ESLint explicit-function-return-type (#4500)

And fix violations.

Author: andyleejordan

.eslintrc.json

@@ -36,6 +36,9 @@
       "error",
       "always"
     ],
+    "@typescript-eslint/explicit-function-return-type": [
+      "error"
+    ],
     "@typescript-eslint/no-floating-promises": [
       "error",
       {

src/features/CodeActions.ts

@@ -30,12 +30,12 @@ export class CodeActionsFeature implements vscode.Disposable {
             });
     }
 
-    public dispose() {
+    public dispose(): void {
         this.applyEditsCommand.dispose();
         this.showDocumentationCommand.dispose();
     }
 
-    public async showRuleDocumentation(ruleId: string) {
+    public async showRuleDocumentation(ruleId: string): Promise<void> {
         const pssaDocBaseURL = "https://docs.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/";
 
         if (!ruleId) {

src/features/Console.ts

@@ -213,7 +213,7 @@ export class ConsoleFeature extends LanguageClientConsumer {
         ];
     }
 
-    public dispose() {
+    public dispose(): void {
         for (const command of this.commands) {
             command.dispose();
         }
@@ -222,7 +222,7 @@ export class ConsoleFeature extends LanguageClientConsumer {
         }
     }
 
-    public override setLanguageClient(languageClient: LanguageClient) {
+    public override setLanguageClient(languageClient: LanguageClient): void {
         this.languageClient = languageClient;
         this.handlers = [
             this.languageClient.onRequest(

src/features/CustomViews.ts

@@ -21,13 +21,13 @@ export class CustomViewsFeature extends LanguageClientConsumer {
                 this.contentProvider));
     }
 
-    public dispose() {
+    public dispose(): void {
         for (const command of this.commands) {
             command.dispose();
         }
     }
 
-    public override setLanguageClient(languageClient: LanguageClient) {
+    public override setLanguageClient(languageClient: LanguageClient): void {
 
         languageClient.onRequest(
             NewCustomViewRequestType,
@@ -81,7 +81,7 @@ class PowerShellContentProvider implements vscode.TextDocumentContentProvider {
         return this.viewIndex[uri.toString()].getContent();
     }
 
-    public createView(id: string, title: string, viewType: CustomViewType) {
+    public createView(id: string, title: string, viewType: CustomViewType): void {
         let view;
         switch (viewType) {
         case CustomViewType.HtmlContent:
@@ -91,12 +91,12 @@ class PowerShellContentProvider implements vscode.TextDocumentContentProvider {
         this.viewIndex[this.getUri(view.id)] = view;
     }
 
-    public showView(id: string, viewColumn: vscode.ViewColumn) {
+    public showView(id: string, viewColumn: vscode.ViewColumn): void {
         const uriString = this.getUri(id);
         (this.viewIndex[uriString] as HtmlContentView).showContent(viewColumn);
     }
 
-    public closeView(id: string) {
+    public closeView(id: string): void {
         const uriString = this.getUri(id);
 
         vscode.workspace.textDocuments.some((doc) => {
@@ -110,23 +110,23 @@ class PowerShellContentProvider implements vscode.TextDocumentContentProvider {
         });
     }
 
-    public setHtmlContentView(id: string, content: IHtmlContent) {
+    public setHtmlContentView(id: string, content: IHtmlContent): void {
         const uriString = this.getUri(id);
         const view: CustomView = this.viewIndex[uriString];
 
         (view as HtmlContentView).setContent(content);
         this.didChangeEvent.fire(vscode.Uri.parse(uriString));
     }
 
-    public appendHtmlOutputView(id: string, content: string) {
+    public appendHtmlOutputView(id: string, content: string): void {
         const uriString = this.getUri(id);
         const view: CustomView = this.viewIndex[uriString];
 
         (view as HtmlContentView).appendContent(content);
         this.didChangeEvent.fire(vscode.Uri.parse(uriString));
     }
 
-    private getUri(id: string) {
+    private getUri(id: string): string {
         return `powershell://views/${id}`;
     }
 }
@@ -158,11 +158,11 @@ class HtmlContentView extends CustomView {
         super(id, title, CustomViewType.HtmlContent);
     }
 
-    public setContent(htmlContent: IHtmlContent) {
+    public setContent(htmlContent: IHtmlContent): void {
         this.htmlContent = htmlContent;
     }
 
-    public appendContent(content: string) {
+    public appendContent(content: string): void {
         this.htmlContent.bodyContent += content;
     }
 

src/features/DebugSession.ts

@@ -91,13 +91,13 @@ export class DebugSessionFeature extends LanguageClientConsumer
         return new vscode.DebugAdapterNamedPipeServer(sessionDetails.debugServicePipeName);
     }
 
-    public dispose() {
+    public dispose(): void {
         for (const handler of this.handlers) {
             handler.dispose();
         }
     }
 
-    public override setLanguageClient(languageClient: LanguageClient) {
+    public override setLanguageClient(languageClient: LanguageClient): void {
         this.handlers = [
             languageClient.onNotification(
                 StartDebuggerNotificationType,
@@ -308,7 +308,7 @@ export class SpecifyScriptArgsFeature implements vscode.Disposable {
         });
     }
 
-    public dispose() {
+    public dispose(): void {
         this.command.dispose();
     }
 
@@ -369,7 +369,7 @@ export class PickPSHostProcessFeature extends LanguageClientConsumer {
             });
     }
 
-    public override setLanguageClient(languageClient: LanguageClient) {
+    public override setLanguageClient(languageClient: LanguageClient): void {
         this.languageClient = languageClient;
 
         if (this.waitingForClientToken && this.getLanguageClientResolve) {
@@ -378,7 +378,7 @@ export class PickPSHostProcessFeature extends LanguageClientConsumer {
         }
     }
 
-    public dispose() {
+    public dispose(): void {
         this.command.dispose();
     }
 
@@ -456,7 +456,7 @@ export class PickPSHostProcessFeature extends LanguageClientConsumer {
         return item ? `${item.pid}` : undefined;
     }
 
-    private clearWaitingToken() {
+    private clearWaitingToken(): void {
         this.waitingForClientToken?.dispose();
         this.waitingForClientToken = undefined;
     }
@@ -494,7 +494,7 @@ export class PickRunspaceFeature extends LanguageClientConsumer {
             }, this);
     }
 
-    public override setLanguageClient(languageClient: LanguageClient) {
+    public override setLanguageClient(languageClient: LanguageClient): void {
         this.languageClient = languageClient;
 
         if (this.waitingForClientToken && this.getLanguageClientResolve) {
@@ -503,7 +503,7 @@ export class PickRunspaceFeature extends LanguageClientConsumer {
         }
     }
 
-    public dispose() {
+    public dispose(): void {
         this.command.dispose();
     }
 
@@ -572,7 +572,7 @@ export class PickRunspaceFeature extends LanguageClientConsumer {
         return item ? `${item.id}` : undefined;
     }
 
-    private clearWaitingToken() {
+    private clearWaitingToken(): void {
         this.waitingForClientToken?.dispose();
         this.waitingForClientToken = undefined;
     }

src/features/Examples.ts

@@ -19,7 +19,7 @@ export class ExamplesFeature implements vscode.Disposable {
         });
     }
 
-    public dispose() {
+    public dispose(): void {
         this.command.dispose();
     }
 }

src/features/ExpandAlias.ts

@@ -53,7 +53,7 @@ export class ExpandAliasFeature extends LanguageClientConsumer {
         });
     }
 
-    public dispose() {
+    public dispose(): void {
         this.command.dispose();
     }
 }

src/features/ExtensionCommands.ts

@@ -198,12 +198,12 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
         ];
     }
 
-    public override setLanguageClient(languageclient: LanguageClient) {
+    public override setLanguageClient(languageClient: LanguageClient): void {
         // Clear the current list of extension commands since they were
         // only relevant to the previous session
         this.extensionCommands = [];
 
-        this.languageClient = languageclient;
+        this.languageClient = languageClient;
 
         this.handlers = [
             this.languageClient.onNotification(
@@ -267,7 +267,7 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
         ];
     }
 
-    public dispose() {
+    public dispose(): void {
         for (const command of this.commands) {
             command.dispose();
         }
@@ -276,7 +276,7 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
         }
     }
 
-    private addExtensionCommand(command: IExtensionCommandAddedNotificationBody) {
+    private addExtensionCommand(command: IExtensionCommandAddedNotificationBody): void {
         this.extensionCommands.push({
             name: command.name,
             displayName: command.displayName,
@@ -311,7 +311,7 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
 
     private async onCommandSelected(
         chosenItem: IExtensionCommandQuickPickItem | undefined,
-        client: LanguageClient | undefined) {
+        client: LanguageClient | undefined): Promise<void> {
 
         if (chosenItem !== undefined) {
             await client?.sendRequest(

src/features/ExternalApi.ts

@@ -173,7 +173,7 @@ export class ExternalApiFeature extends LanguageClientConsumer implements IPower
         return this.extensionContext.globalStorageUri.with({ scheme: "file"});
     }
 
-    public dispose() {
+    public dispose(): void {
         // Nothing to dispose.
     }
 }

src/features/GenerateBugReport.ts

@@ -25,7 +25,7 @@ export class GenerateBugReportFeature implements vscode.Disposable {
         });
     }
 
-    public dispose() {
+    public dispose(): void {
         this.command.dispose();
     }
 

src/features/GetCommands.ts

@@ -50,20 +50,20 @@ export class GetCommandsFeature extends LanguageClientConsumer {
         });
     }
 
-    public dispose() {
+    public dispose(): void {
         for (const command of this.commands) {
             command.dispose();
         }
     }
 
-    public override setLanguageClient(languageclient: LanguageClient) {
-        this.languageClient = languageclient;
+    public override setLanguageClient(languageClient: LanguageClient): void {
+        this.languageClient = languageClient;
         if (this.commandsExplorerTreeView.visible) {
             void vscode.commands.executeCommand("PowerShell.RefreshCommandsExplorer");
         }
     }
 
-    private async CommandExplorerRefresh() {
+    private async CommandExplorerRefresh(): Promise<void> {
         if (this.languageClient === undefined) {
             this.logger.writeVerbose(`<${GetCommandsFeature.name}>: Unable to send getCommand request`);
             return;
@@ -77,7 +77,7 @@ export class GetCommandsFeature extends LanguageClientConsumer {
         });
     }
 
-    private async InsertCommand(item: { Name: string; }) {
+    private async InsertCommand(item: { Name: string; }): Promise<void> {
         const editor = vscode.window.activeTextEditor;
         if (editor === undefined) {
             return;

src/features/HelpCompletion.ts

@@ -39,11 +39,11 @@ export class HelpCompletionFeature extends LanguageClientConsumer {
         }
     }
 
-    public dispose() {
+    public dispose(): void {
         this.disposable?.dispose();
     }
 
-    public override setLanguageClient(languageClient: LanguageClient) {
+    public override setLanguageClient(languageClient: LanguageClient): void {
         this.languageClient = languageClient;
         if (this.helpCompletionProvider) {
             this.helpCompletionProvider.languageClient = languageClient;

src/features/ISECompatibility.ts

@@ -42,13 +42,13 @@ export class ISECompatibilityFeature implements vscode.Disposable {
         ];
     }
 
-    public dispose() {
+    public dispose(): void {
         for (const command of this._commandRegistrations) {
             command.dispose();
         }
     }
 
-    private async EnableISEMode() {
+    private async EnableISEMode(): Promise<void> {
         this._iseModeEnabled = true;
         for (const iseSetting of ISECompatibilityFeature.settings) {
             try {
@@ -73,7 +73,7 @@ export class ISECompatibilityFeature implements vscode.Disposable {
         }
     }
 
-    private async DisableISEMode() {
+    private async DisableISEMode(): Promise<void> {
         this._iseModeEnabled = false;
         for (const iseSetting of ISECompatibilityFeature.settings) {
             const config = vscode.workspace.getConfiguration(iseSetting.path);
@@ -84,7 +84,7 @@ export class ISECompatibilityFeature implements vscode.Disposable {
         }
     }
 
-    private async ToggleISEMode() {
+    private async ToggleISEMode(): Promise<void> {
         if (this._iseModeEnabled) {
             await this.DisableISEMode();
         } else {