src/tests/runCode.js (5)

62-69: Synchronize command determination logic

There's duplication in determining the command based on the language in both lines 62-69 and 91-96. To enhance maintainability, consider extracting this logic into a separate function to avoid inconsistencies and make future updates easier.

Apply this diff to extract the logic:

+      function getCommandFromLanguage(language) {
+        const lang = language.toLowerCase();
+        if (lang === "python" || lang === "py") return "python";
+        if (lang === "javascript" || lang === "js" || lang === "node") return "node";
+        if (lang === "bash") return "bash";
+        throw new Error(`Unsupported language: ${language}`);
+      }

       // Determine command if not specified
       if (!step.command) {
-        step.command =
-          step.language.toLowerCase() === "python"
-            ? "python"
-            : step.language.toLowerCase() === "javascript"
-            ? "node"
-            : "bash";
+        step.command = getCommandFromLanguage(step.language);
       }

       // Prepare shell command based on language
       const command = step.command;
+      // Use the same function here
       const shellStep = {
         ...step,
         action: "runShell",
-        command:
-          step.language.toLowerCase() === "python"
-            ? "python"
-            : step.language.toLowerCase() === "javascript"
-            ? "node"
-            : "bash",
+        command: getCommandFromLanguage(step.language),
         args: [scriptPath, ...(step.args || [])],
       };

This refactoring reduces code duplication and centralizes the command determination logic.

---

98-101: Avoid using the delete operator for better performance

Using the delete operator can negatively impact performance because it forces the JavaScript engine to reoptimize the object structure. Instead of deleting properties, consider setting them to undefined or restructuring your code to avoid the need to remove properties.

Apply this diff to set properties to undefined:

       if (step.code) delete shellStep.code;
       if (step.language) delete shellStep.language;
       if (step.file) delete shellStep.file;
       if (step.group) delete shellStep.group;
+      // Set properties to undefined instead
+      if (step.code) shellStep.code = undefined;
+      if (step.language) shellStep.language = undefined;
+      if (step.file) shellStep.file = undefined;
+      if (step.group) shellStep.group = undefined;

Alternatively, you could create a new object excluding these properties to avoid mutation:

       // Create a new object without certain properties
       const { code, language, file, group, ...shellStep } = step;

This approach prevents side effects and maintains performance.

🧰 Tools

🪛 Biome (1.9.4)

[error] 98-98: Avoid the delete operator which can impact performance.

Unsafe fix: Use an undefined assignment instead.

(lint/performance/noDelete)

---

[error] 99-99: Avoid the delete operator which can impact performance.

Unsafe fix: Use an undefined assignment instead.

(lint/performance/noDelete)

---

[error] 100-100: Avoid the delete operator which can impact performance.

Unsafe fix: Use an undefined assignment instead.

(lint/performance/noDelete)

---

[error] 101-101: Avoid the delete operator which can impact performance.

Unsafe fix: Use an undefined assignment instead.

(lint/performance/noDelete)

---

103-103: Use consistent logging mechanisms

The console.log statement on line 103 might not align with your application's logging strategy. Consider using the log function provided in your utilities for consistent logging practices.

Apply this diff to use the log function:

-    console.log("shellStep", shellStep);
+    log(config, "debug", `shellStep: ${JSON.stringify(shellStep)}`);

This ensures that logging respects the configured log level and format.

---

80-84: Extend Windows support for Bash scripts

The current implementation restricts running Bash scripts on Windows platforms. Since Windows 10, it's possible to run Bash scripts using environments like Git Bash or the Windows Subsystem for Linux (WSL). Consider detecting these environments to provide broader support.

You might adjust the code to check for available Bash environments:

         if (os.platform() === "win32" && command === "bash") {
-          result.status = "FAIL";
-          result.description = `runCode currently doesn't support bash on Windows. Use a different command, a different language, or a runShell step.`;
-          return result;
+          // Check if Bash is available on Windows
+          const bashAvailable = await spawnCommand("bash", ["--version"]);
+          if (bashAvailable.exitCode !== 0) {
+            result.status = "FAIL";
+            result.description = `Bash is not available on this Windows system. Install Git Bash or WSL, or use a different language.`;
+            return result;
+          }
         }

This enhancement allows users with Bash installed to run scripts on Windows platforms.

---

15-37: Consider handling more languages and extensions

The createTempScript function currently supports Python, JavaScript, and Bash. If there's a need to support additional languages in the future, it might be useful to design the function to be more extensible.

Consider using a mapping for languages to extensions:

       function createTempScript(code, language) {
-        let extension;
-        switch (language) {
-          case "python":
-          case "py":
-            extension = ".py";
-            break;
-          case "javascript":
-          case "js":
-          case "node":
-            extension = ".js";
-            break;
-          case "bash":
-            extension = ".sh";
-            break;
-          default:
-            extension = "";
-        }
+        const extensionMap = {
+          python: ".py",
+          py: ".py",
+          javascript: ".js",
+          js: ".js",
+          node: ".js",
+          bash: ".sh",
+          sh: ".sh",
+        };
+        const extension = extensionMap[language.toLowerCase()];
+        if (!extension) {
+          throw new Error(`Unsupported language: ${language}`);
+        }
         const tmpDir = os.tmpdir();
         const tmpFile = path.join(tmpDir, `doc-detective-${Date.now()}${extension}`);
         fs.writeFileSync(tmpFile, code);
         return tmpFile;
       }

This refactoring makes it easier to add support for new languages by updating the extensionMap.

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro