Add support for Windows .cmd and .bat files

src/common/server.ts

@@ -1,5 +1,6 @@
 import * as fsapi from "fs-extra";
 import * as vscode from "vscode";
+import { platform } from "os";
 import { Disposable, l10n, LanguageStatusSeverity, LogOutputChannel } from "vscode";
 import { State } from "vscode-languageclient";
 import {
@@ -44,18 +45,45 @@ export type IInitializationOptions = {
   globalSettings: ISettings;
 };
 
+/**
+ * Check if shell mode is required for execFile.
+ * Note: This is only the case for Windows OS when using .cmd instead of .exe extension to start the interpreter.
+ * @param file
+ * @returns
+ */
+export function execFileShellModeRequired(file: string) {
+  return platform() === "win32" && file.toLowerCase().endsWith(".cmd");
+}
+
+/**
+ * Quote given file if shell mode is required
+ * @param file
+ * @returns
+ */
+function quoteFilename(file: string) {
+  if (execFileShellModeRequired(file)) {
+    return `"${file}"`;
+  }
+  return file;
+}
+
 /**
  * Function to execute a command and return the stdout.
  */
 function executeFile(file: string, args: string[] = []): Promise<string> {
   return new Promise((resolve, reject) => {
-    execFile(file, args, (error, stdout, stderr) => {
-      if (error) {
-        reject(new Error(stderr || error.message));
-      } else {
-        resolve(stdout);
-      }
-    });
+    execFile(
+      quoteFilename(file),
+      args,
+      { shell: execFileShellModeRequired(file) },
+      (error, stdout, stderr) => {
+        if (error) {
+          reject(new Error(stderr || error.message));
+        } else {
+          resolve(stdout);
+        }
+      },
+    );
   });
 }
 

src/test/helper.ts

@@ -1,5 +1,6 @@
 import * as vscode from "vscode";
 import * as path from "path";
+import { platform } from "os";
 
 const EXTENSION_ID = "charliermarsh.ruff";
 
@@ -26,3 +27,7 @@ export const getDocumentPath = (p: string) => {
 export const getDocumentUri = (p: string) => {
   return vscode.Uri.file(getDocumentPath(p));
 };
+
+export const isWindows = () => {
+  return platform() === "win32";
+};

src/test/utils.test.ts

@@ -0,0 +1,23 @@
+import * as assert from "assert";
+import { execFileShellModeRequired } from "../common/server";
+import { isWindows } from "./helper";
+
+suite("Utils tests", () => {
+  test("Check execFile shell mode", () => {
+    assert.strictEqual(
+      execFileShellModeRequired("/use/random/python"),
+      false,
+      "Shell mode should not be required for unix paths",
+    );
+    assert.strictEqual(
+      execFileShellModeRequired("C:\\random\\python.exe"),
+      false,
+      "Shell mode should not be required for .exe files",
+    );
+    assert.strictEqual(
+      execFileShellModeRequired("C:\\random\\python.cmd"),
+      isWindows() ? true : false,
+      "Shell mode should be required for .cmd files",
+    );
+  });
+});