Refactor classes that do not need a language client to not inherit from IFeature

Author: Christoph Bergmeister

src/features/CodeActions.ts

@@ -3,15 +3,12 @@
  *--------------------------------------------------------*/
 
 import vscode = require("vscode");
-import { LanguageClient } from "vscode-languageclient";
 import Window = vscode.window;
-import { IFeature } from "../feature";
 import { ILogger } from "../logging";
 
-export class CodeActionsFeature implements IFeature {
+export class CodeActionsFeature implements vscode.Disposable {
     private applyEditsCommand: vscode.Disposable;
     private showDocumentationCommand: vscode.Disposable;
-    private languageClient: LanguageClient;
 
     constructor(private log: ILogger) {
         this.applyEditsCommand = vscode.commands.registerCommand("PowerShell.ApplyCodeActionEdits", (edit: any) => {
@@ -37,10 +34,6 @@ export class CodeActionsFeature implements IFeature {
         this.showDocumentationCommand.dispose();
     }
 
-    public setLanguageClient(languageclient: LanguageClient) {
-        this.languageClient = languageclient;
-    }
-
     public showRuleDocumentation(ruleId: string) {
         const pssaDocBaseURL = "https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation";
 

src/features/CustomViews.ts

@@ -10,7 +10,6 @@ import { IFeature } from "../feature";
 export class CustomViewsFeature implements IFeature {
 
     private commands: vscode.Disposable[] = [];
-    private languageClient: LanguageClient;
     private contentProvider: PowerShellContentProvider;
 
     constructor() {
@@ -65,8 +64,6 @@ export class CustomViewsFeature implements IFeature {
                     args.id,
                     args.appendedHtmlBodyContent);
             });
-
-        this.languageClient = languageClient;
     }
 }
 

src/features/DebugSession.ts

@@ -325,10 +325,9 @@ export class DebugSessionFeature implements IFeature, DebugConfigurationProvider
     }
 }
 
-export class SpecifyScriptArgsFeature implements IFeature {
+export class SpecifyScriptArgsFeature implements vscode.Disposable {
 
     private command: vscode.Disposable;
-    private languageClient: LanguageClient;
     private context: vscode.ExtensionContext;
 
     constructor(context: vscode.ExtensionContext) {
@@ -340,10 +339,6 @@ export class SpecifyScriptArgsFeature implements IFeature {
             });
     }
 
-    public setLanguageClient(languageclient: LanguageClient) {
-        this.languageClient = languageclient;
-    }
-
     public dispose() {
         this.command.dispose();
     }

src/features/Examples.ts

@@ -4,10 +4,8 @@
 
 import path = require("path");
 import vscode = require("vscode");
-import { LanguageClient } from "vscode-languageclient";
-import { IFeature } from "../feature";
 
-export class ExamplesFeature implements IFeature {
+export class ExamplesFeature implements vscode.Disposable {
     private command: vscode.Disposable;
     private examplesPath: string;
 
@@ -21,10 +19,6 @@ export class ExamplesFeature implements IFeature {
         });
     }
 
-    public setLanguageClient(languageclient: LanguageClient) {
-        // Eliminate tslint warning
-    }
-
     public dispose() {
         this.command.dispose();
     }

src/features/GenerateBugReport.ts

@@ -5,7 +5,6 @@
 import cp = require("child_process");
 import os = require("os");
 import vscode = require("vscode");
-import { IFeature, LanguageClient } from "../feature";
 import { SessionManager } from "../session";
 import Settings = require("../settings");
 
@@ -27,7 +26,7 @@ const extensions =
             return 0;
         });
 
-export class GenerateBugReportFeature implements IFeature {
+export class GenerateBugReportFeature implements vscode.Disposable {
 
     private command: vscode.Disposable;
     private powerShellProcess: cp.ChildProcess;
@@ -83,10 +82,6 @@ ${this.generateExtensionTable(extensions)}
         this.command.dispose();
     }
 
-    public setLanguageClient(languageclient: LanguageClient) {
-        // Eliminate tslint warning.
-    }
-
     private generateExtensionTable(installedExtensions): string {
         if (!installedExtensions.length) {
             return "none";

src/features/ISECompatibility.ts

@@ -2,8 +2,6 @@
  * Copyright (C) Microsoft Corporation. All rights reserved.
  *--------------------------------------------------------*/
 import * as vscode from "vscode";
-import { LanguageClient } from "vscode-languageclient";
-import { IFeature } from "../feature";
 import * as Settings from "../settings";
 
 interface ISetting {
@@ -15,7 +13,7 @@ interface ISetting {
 /**
  * A feature to implement commands to make code like the ISE and reset the settings.
  */
-export class ISECompatibilityFeature implements IFeature {
+export class ISECompatibilityFeature implements vscode.Disposable {
     // Marking settings as public so we can use it within the tests without needing to duplicate the list of settings.
     public static settings: ISetting[] = [
         { path: "workbench.activityBar", name: "visible", value: false },
@@ -27,7 +25,6 @@ export class ISECompatibilityFeature implements IFeature {
     ];
     private iseCommandRegistration: vscode.Disposable;
     private defaultCommandRegistration: vscode.Disposable;
-    private languageClient: LanguageClient;
 
     constructor() {
         this.iseCommandRegistration = vscode.commands.registerCommand(
@@ -41,10 +38,6 @@ export class ISECompatibilityFeature implements IFeature {
         this.defaultCommandRegistration.dispose();
     }
 
-    public setLanguageClient(languageclient: LanguageClient) {
-        this.languageClient = languageclient;
-    }
-
     private async EnableISEMode() {
         for (const iseSetting of ISECompatibilityFeature.settings) {
             await vscode.workspace.getConfiguration(iseSetting.path).update(iseSetting.name, iseSetting.value, true);

src/features/OpenInISE.ts

@@ -4,9 +4,8 @@
 
 import ChildProcess = require("child_process");
 import vscode = require("vscode");
-import { IFeature, LanguageClient } from "../feature";
 
-export class OpenInISEFeature implements IFeature {
+export class OpenInISEFeature implements vscode.Disposable {
     private command: vscode.Disposable;
 
     constructor() {
@@ -33,8 +32,4 @@ export class OpenInISEFeature implements IFeature {
     public dispose() {
         this.command.dispose();
     }
-
-    public setLanguageClient(languageClient: LanguageClient) {
-        // Not needed for this feature.
-    }
 }

src/features/PesterTests.ts

@@ -4,7 +4,6 @@
 
 import * as path from "path";
 import vscode = require("vscode");
-import { IFeature, LanguageClient } from "../feature";
 import { SessionManager } from "../session";
 import Settings = require("../settings");
 import utils = require("../utils");
@@ -14,10 +13,9 @@ enum LaunchType {
     Run,
 }
 
-export class PesterTestsFeature implements IFeature {
+export class PesterTestsFeature implements vscode.Disposable {
 
     private command: vscode.Disposable;
-    private languageClient: LanguageClient;
     private invokePesterStubScriptPath: string;
 
     constructor(private sessionManager: SessionManager) {
@@ -47,10 +45,6 @@ export class PesterTestsFeature implements IFeature {
         this.command.dispose();
     }
 
-    public setLanguageClient(languageClient: LanguageClient) {
-        this.languageClient = languageClient;
-    }
-
     private launchAllTestsInActiveEditor(launchType: LaunchType, fileUri: vscode.Uri) {
         const uriString = fileUri.toString();
         const launchConfig = this.createLaunchConfig(uriString, launchType);

src/features/RunCode.ts

@@ -14,10 +14,9 @@ enum LaunchType {
     Run,
 }
 
-export class RunCodeFeature implements IFeature {
+export class RunCodeFeature implements vscode.Disposable {
 
     private command: vscode.Disposable;
-    private languageClient: LanguageClient;
 
     constructor(private sessionManager: SessionManager) {
         this.command = vscode.commands.registerCommand(
@@ -31,10 +30,6 @@ export class RunCodeFeature implements IFeature {
         this.command.dispose();
     }
 
-    public setLanguageClient(languageClient: LanguageClient) {
-        this.languageClient = languageClient;
-    }
-
     private async launchTask(
         runInDebugger: boolean,
         scriptToRun: string,

src/main.ts

@@ -50,6 +50,7 @@ const AI_KEY: string = "AIF-d9b70cd4-b9f9-4d70-929b-a071c400b217";
 let logger: Logger;
 let sessionManager: SessionManager;
 let extensionFeatures: IFeature[] = [];
+let commandRegistrations: vscode.Disposable[] = [];
 let telemetryReporter: TelemetryReporter;
 
 const documentSelector: DocumentSelector = [
@@ -139,26 +140,30 @@ export function activate(context: vscode.ExtensionContext): void {
             PackageJSON.version,
             telemetryReporter);
 
-    // Create features
-    extensionFeatures = [
-        new ConsoleFeature(logger),
+    // Register commands that do not require Language client
+    commandRegistrations = [
         new ExamplesFeature(),
-        new OpenInISEFeature(),
         new GenerateBugReportFeature(sessionManager),
+        new ISECompatibilityFeature(),
+        new OpenInISEFeature(),
+        new PesterTestsFeature(sessionManager),
+        new RunCodeFeature(sessionManager),
+        new CodeActionsFeature(logger),
+        new SpecifyScriptArgsFeature(context),
+    ]
+
+    // Create features that require language client
+    extensionFeatures = [
+        new ConsoleFeature(logger),
         new ExpandAliasFeature(logger),
         new GetCommandsFeature(logger),
-        new ISECompatibilityFeature(),
         new ShowHelpFeature(logger),
         new FindModuleFeature(),
-        new PesterTestsFeature(sessionManager),
-        new RunCodeFeature(sessionManager),
         new ExtensionCommandsFeature(logger),
-        new CodeActionsFeature(logger),
         new NewFileOrProjectFeature(),
         new RemoteFilesFeature(),
         new DebugSessionFeature(context, sessionManager, logger),
         new PickPSHostProcessFeature(),
-        new SpecifyScriptArgsFeature(context),
         new HelpCompletionFeature(logger),
         new CustomViewsFeature(),
         new PickRunspaceFeature(),
@@ -206,6 +211,10 @@ export function deactivate(): void {
        feature.dispose();
     });
 
+    commandRegistrations.forEach((commandRegistration) => {
+        commandRegistration.dispose();
+    });
+
     // Dispose of the current session
     sessionManager.dispose();