Fix: Fixing an issue where webhint was not being loaded

package.json

@@ -683,7 +683,7 @@
         "utf-8-validate": "6.0.4",
         "vscode-chrome-debug-core": "6.8.11",
         "vscode-extension-telemetry": "0.4.1",
-        "vscode-webhint": "2.1.11",
+        "vscode-webhint": "2.1.15",
         "ws": "8.18.0",
         "xmlhttprequest": "1.8.0"
     },
@@ -712,7 +712,7 @@
         "uglify-js": "3.19.3",
         "unzipper": "0.12.3",
         "jest-environment-jsdom": "^28.1.3",
-        "vscode-languageclient": "7.0.0",
+        "vscode-languageclient": "9.0.1",
         "vscode-test": "1.6.1",
         "webpack": "5.94.0",
         "webpack-cli": "5.1.4"

src/extension.ts

@@ -40,10 +40,12 @@ import {
 import { LaunchConfigManager, providedHeadlessDebugConfig, providedLaunchDevToolsConfig } from './launchConfigManager';
 import { ErrorReporter } from './errorReporter';
 import { ErrorCodes } from './common/errorCodes';
-import {
-    LanguageClient,
+import type {
     LanguageClientOptions,
     ServerOptions,
+} from 'vscode-languageclient/node';
+import {
+    LanguageClient,
     TransportKind,
 } from 'vscode-languageclient/node';
 import type { installFailed, showOutput } from 'vscode-webhint/dist/src/utils/notifications';
@@ -257,12 +259,12 @@ export function activate(context: vscode.ExtensionContext): void {
 
     const settingsConfig = vscode.workspace.getConfiguration(SETTINGS_STORE_NAME);
     if (settingsConfig.get('webhint')) {
-        startWebhint(context);
+        void startWebhint(context);
     }
     vscode.workspace.onDidChangeConfiguration(event => {
         if (event.affectsConfiguration(`${SETTINGS_STORE_NAME}.webhint`)) {
             if (vscode.workspace.getConfiguration(SETTINGS_STORE_NAME).get('webhint')) {
-                startWebhint(context);
+                void startWebhint(context);
             } else {
                 void stopWebhint();
             }
@@ -303,7 +305,7 @@ export async function launchScreencast(context: vscode.ExtensionContext, fileUri
     }
 }
 
-function startWebhint(context: vscode.ExtensionContext): void {
+async function startWebhint(context: vscode.ExtensionContext): Promise<void> {
     const args = [context.globalStoragePath, languageServerName];
     const module = context.asAbsolutePath('node_modules/vscode-webhint/dist/src/server.js');
     const transport = TransportKind.ipc;
@@ -370,37 +372,34 @@ function startWebhint(context: vscode.ExtensionContext): void {
 
     // Create and start the client (also starts the server).
     client = new LanguageClient('Microsoft Edge Tools', serverOptions, clientOptions);
-
-    void client.onReady().then(() => {
-        // Listen for notification that the webhint install failed.
-        const installFailedNotification: typeof installFailed = 'vscode-webhint/install-failed';
-        const disableInstallFailedNotification = vscode.workspace.getConfiguration(SETTINGS_STORE_NAME).get('webhintInstallNotification');
-        client.onNotification(installFailedNotification, () => {
-            if (!telemetryReporter) {
-                telemetryReporter = createTelemetryReporter(context);
-            }
-            telemetryReporter.sendTelemetryEvent('user/webhint/install-failed');
-            if (!disableInstallFailedNotification) {
-                const message = 'Ensure `node` and `npm` are installed to enable automatically reporting issues in source files pertaining to accessibility, compatibility, security, and more.';
-                void vscode.window.showInformationMessage(message, 'Remind me Later', 'Don\'t show again', 'Disable Extension').then(button => {
-                    if (button === 'Disable Extension') {
-                        void vscode.workspace.getConfiguration(SETTINGS_STORE_NAME).update('webhint', false, vscode.ConfigurationTarget.Global);
-                    }
-                    if (button === 'Don\'t show again') {
-                        void vscode.workspace.getConfiguration(SETTINGS_STORE_NAME).update('webhintInstallNotification', true, vscode.ConfigurationTarget.Global);
-                    }
-                });
-            }
-        });
-        // Listen for requests to show the output panel for this extension.
-        const showOutputNotification: typeof showOutput = 'vscode-webhint/show-output';
-        client.onNotification(showOutputNotification, () => {
-            client.outputChannel.clear();
-            client.outputChannel.show(true);
-        });
+    // Listen for notification that the webhint install failed.
+    const installFailedNotification: typeof installFailed = 'vscode-webhint/install-failed';
+    const disableInstallFailedNotification = vscode.workspace.getConfiguration(SETTINGS_STORE_NAME).get('webhintInstallNotification');
+    client.onNotification(installFailedNotification, () => {
+        if (!telemetryReporter) {
+            telemetryReporter = createTelemetryReporter(context);
+        }
+        telemetryReporter.sendTelemetryEvent('user/webhint/install-failed');
+        if (!disableInstallFailedNotification) {
+            const message = 'Ensure `node` and `npm` are installed to enable automatically reporting issues in source files pertaining to accessibility, compatibility, security, and more.';
+            void vscode.window.showInformationMessage(message, 'Remind me Later', 'Don\'t show again', 'Disable Extension').then(button => {
+                if (button === 'Disable Extension') {
+                    void vscode.workspace.getConfiguration(SETTINGS_STORE_NAME).update('webhint', false, vscode.ConfigurationTarget.Global);
+                }
+                if (button === 'Don\'t show again') {
+                    void vscode.workspace.getConfiguration(SETTINGS_STORE_NAME).update('webhintInstallNotification', true, vscode.ConfigurationTarget.Global);
+                }
+            });
+        }
     });
 
-    client.start();
+    // Listen for requests to show the output panel for this extension.
+    const showOutputNotification: typeof showOutput = 'vscode-webhint/show-output';
+    client.onNotification(showOutputNotification, () => {
+        client.outputChannel.clear();
+        client.outputChannel.show(true);
+    });
+    await client.start();
 }
 
 async function stopWebhint(): Promise<void> {

test/extension.test.ts

@@ -3,7 +3,7 @@
 
 import { ExtensionContext, Uri} from "vscode";
 import TelemetryReporter from "vscode-extension-telemetry";
-import { createFakeExtensionContext, createFakeTelemetryReporter, createFakeVSCode, Mocked } from "./helpers/helpers";
+import { createFakeExtensionContext, createFakeTelemetryReporter, createFakeVSCode, createFakeLanguageClient, Mocked } from "./helpers/helpers";
 import {
     buttonCode,
     IRemoteTargetJson,
@@ -14,6 +14,7 @@ import {
 } from "../src/utils";
 
 jest.mock("vscode", () => createFakeVSCode(), { virtual: true });
+jest.mock("vscode-languageclient/node", () => createFakeLanguageClient(), { virtual: true });
 
 describe("extension", () => {
     const fakeRuntimeConfig: Partial<IRuntimeConfig> = {};
@@ -60,6 +61,9 @@ describe("extension", () => {
                 };
             });
 
+            const mockLanguageClient = createFakeLanguageClient()
+            jest.doMock("vscode-languageclient/node", () => mockLanguageClient, { virtual: true });
+
             // Mock out vscode command registration
             const mockVSCode = createFakeVSCode();
             commandMock = mockVSCode.commands.registerCommand;

test/helpers/helpers.ts

@@ -212,3 +212,19 @@ export function getFirstCallback(mock: jest.Mock, callbackArgIndex: number = 0):
     { callback: Function, thisObj: object } {
     return { callback: mock.mock.calls[0][callbackArgIndex], thisObj: mock.mock.instances[0] };
 }
+
+export function createFakeLanguageClient() {
+    const createFakeLanguageClient = jest.fn().mockImplementation(() => {
+        return {
+            LanguageClient: function LanguageClient() { /* constructor */ }
+        }
+    });
+    const createFakeLTransportKind = jest.fn().mockImplementation(() => {
+        return {
+            TransportKind: function TransportKind() { /* constructor */ }
+        }
+    });
+    return { LanguageClient: createFakeLanguageClient,
+            TransportKind: createFakeLTransportKind
+     }
+}