refactor(vscode)!: use node_module/.bin/oxlint by default, fallback to internal language server

Author: Sysix

editors/vscode/client/ConfigService.ts

@@ -91,45 +91,27 @@ export class ConfigService implements IDisposable {
     return false;
   }
 
-  public getUserServerBinPath(): string | undefined {
-    let bin = this.vsCodeConfig.binPathOxlint;
-    if (!bin) {
-      return;
-    }
-
-    // validates the given path is safe to use
-    if (validateSafeBinaryPath(bin) === false) {
-      return;
-    }
-
-    if (!path.isAbsolute(bin)) {
-      // if the path is not absolute, resolve it to the first workspace folder
-      const cwd = this.workspaceConfigs.keys().next().value;
-      if (!cwd) {
-        return;
-      }
-      bin = path.normalize(path.join(cwd, bin));
-      // strip the leading slash on Windows
-      if (process.platform === "win32" && bin.startsWith("\\")) {
-        bin = bin.slice(1);
-      }
-    }
-
-    return bin;
+  public async getOxlintServerBinPath(): Promise<string | undefined> {
+    return this.searchBinaryPath(this.vsCodeConfig.binPathOxlint, "oxlint");
   }
 
   public async getOxfmtServerBinPath(): Promise<string | undefined> {
-    let bin = this.vsCodeConfig.binPathOxfmt;
+    return this.searchBinaryPath(this.vsCodeConfig.binPathOxfmt, "oxfmt");
+  }
 
+  private async searchBinaryPath(
+    settingsBinary: string | undefined,
+    defaultPattern: string,
+  ): Promise<string | undefined> {
     const cwd = this.workspaceConfigs.keys().next().value;
     if (!cwd) {
       return undefined;
     }
 
-    if (!bin) {
-      // try to find oxfmt in node_modules/.bin, resolve to the first workspace folder
+    if (!settingsBinary) {
+      // try to find the binary in node_modules/.bin, resolve to the first workspace folder
       const files = await workspace.findFiles(
-        new RelativePattern(cwd, "**/node_modules/.bin/oxfmt"),
+        new RelativePattern(cwd, `**/node_modules/.bin/${defaultPattern}`),
         null,
         1,
       );
@@ -138,20 +120,20 @@ export class ConfigService implements IDisposable {
     }
 
     // validates the given path is safe to use
-    if (validateSafeBinaryPath(bin) === false) {
+    if (validateSafeBinaryPath(settingsBinary) === false) {
       return undefined;
     }
 
-    if (!path.isAbsolute(bin)) {
+    if (!path.isAbsolute(settingsBinary)) {
       // if the path is not absolute, resolve it to the first workspace folder
-      bin = path.normalize(path.join(cwd, bin));
+      settingsBinary = path.normalize(path.join(cwd, settingsBinary));
       // strip the leading slash on Windows
-      if (process.platform === "win32" && bin.startsWith("\\")) {
-        bin = bin.slice(1);
+      if (process.platform === "win32" && settingsBinary.startsWith("\\")) {
+        settingsBinary = settingsBinary.slice(1);
       }
     }
 
-    return bin;
+    return settingsBinary;
   }
 
   private async onVscodeConfigChange(event: ConfigurationChangeEvent): Promise<void> {

editors/vscode/client/extension.ts

@@ -1,5 +1,6 @@
 import { commands, ExtensionContext, window, workspace } from "vscode";
 
+import { join } from "node:path";
 import { OxcCommands } from "./commands";
 import { ConfigService } from "./ConfigService";
 import StatusBarItemHandler from "./StatusBarItemHandler";
@@ -75,6 +76,15 @@ export async function activate(context: ExtensionContext) {
     ),
   );
 
+  // when no oxlint binary path are provided, fallback to internal oxc_language_server
+  if (!binaryPaths[0]) {
+    const ext = process.platform === "win32" ? ".exe" : "";
+    // NOTE: The `./target/release` path is aligned with the path defined in .github/workflows/release_vscode.yml
+    binaryPaths[0] =
+      process.env.SERVER_PATH_DEV ??
+      join(context.extensionPath, `./target/release/oxc_language_server${ext}`);
+  }
+
   // remove this block, when `oxfmt` binary is always required. This will be a breaking change.
   if (
     binaryPaths.some((path) => path?.includes("oxc_language_server")) &&

editors/vscode/client/tools/linter.ts

@@ -24,7 +24,6 @@ import {
   ServerOptions,
 } from "vscode-languageclient/node";
 
-import { join } from "node:path";
 import { OxcCommands } from "../commands";
 import { ConfigService } from "../ConfigService";
 import StatusBarItemHandler from "../StatusBarItemHandler";
@@ -61,7 +60,7 @@ export default class LinterTool implements ToolInterface {
     outputChannel: LogOutputChannel,
     configService: ConfigService,
   ): Promise<string | undefined> {
-    const bin = configService.getUserServerBinPath();
+    const bin = await configService.getOxlintServerBinPath();
     if (workspace.isTrusted && bin) {
       try {
         await fsPromises.access(bin);
@@ -70,12 +69,7 @@ export default class LinterTool implements ToolInterface {
         outputChannel.error(`Invalid bin path: ${bin}`, e);
       }
     }
-    const ext = process.platform === "win32" ? ".exe" : "";
-    // NOTE: The `./target/release` path is aligned with the path defined in .github/workflows/release_vscode.yml
-    return (
-      process.env.SERVER_PATH_DEV ??
-      join(context.extensionPath, `./target/release/oxc_language_server${ext}`)
-    );
+    return process.env.SERVER_PATH_DEV;
   }
 
   async activate(

editors/vscode/tests/ConfigService.spec.ts

@@ -70,20 +70,20 @@ suite('ConfigService', () => {
     });
   });
 
-  suite('getUserServerBinPath', () => {
+  suite('getOxlintServerBinPath', () => {
     testSingleFolderMode('resolves relative server path with workspace folder', async () => {
       const service = new ConfigService();
-      const nonDefinedServerPath = service.getUserServerBinPath();
+      const nonDefinedServerPath = await service.getOxlintServerBinPath();
 
       strictEqual(nonDefinedServerPath, undefined);
 
       await conf.update('path.oxlint', '/absolute/oxlint');
-      const absoluteServerPath = service.getUserServerBinPath();
+      const absoluteServerPath = await service.getOxlintServerBinPath();
 
       strictEqual(absoluteServerPath, '/absolute/oxlint');
 
       await conf.update('path.oxlint', './relative/oxlint');
-      const relativeServerPath = service.getUserServerBinPath();
+      const relativeServerPath = await service.getOxlintServerBinPath();
 
       const workspace_path = getWorkspaceFolderPlatformSafe();
       strictEqual(relativeServerPath, `${workspace_path}/relative/oxlint`);
@@ -92,7 +92,7 @@ suite('ConfigService', () => {
     testSingleFolderMode('returns undefined for unsafe server path', async () => {
       const service = new ConfigService();
       await conf.update('path.oxlint', '../unsafe/oxlint');
-      const unsafeServerPath = service.getUserServerBinPath();
+      const unsafeServerPath = await service.getOxlintServerBinPath();
 
       strictEqual(unsafeServerPath, undefined);
     });
@@ -103,7 +103,7 @@ suite('ConfigService', () => {
       }
       const service = new ConfigService();
       await conf.update('path.oxlint', './relative/oxlint');
-      const relativeServerPath = service.getUserServerBinPath();
+      const relativeServerPath = service.getOxlintServerBinPath();
       const workspace_path = getWorkspaceFolderPlatformSafe();
 
       strictEqual(workspace_path[1], ':', 'The test workspace folder must be an absolute path with a drive letter on Windows');