feat: remove wsl specific npm dependencies

Author: AgustinSilverfin

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.51.0] (08/01/2026)
+
+Replace unnecessary external Windows-specific dependencies with built-in functionality to improve cross-platform compatibility and reduce risk of dependency-related issues. This update should not have any user impact.
+
 ## [1.50.0] (07/01/2026)
 
 We introduce a new command `silverfin generate-export-file` which enables the creation of export files (XBRLs, iXBRLs, CSV, etc.) with the CLI. This could be used as part of your development process, for example, after updating an export file template to quickly generate a new export without the need to go to Silverfin's website. It should display any validation errors in the terminal and open the generated file in the default application (browser, text editor, etc.). See more details on how to use it by running `silverfin generate-export-file --help`.

lib/exportFileInstanceGenerator.js

@@ -86,7 +86,7 @@ class ExportFileInstanceGenerator {
   }
 
   #logValidationErrors(response) {
-    if (response && response.validation_errors) {
+    if (response && response.validation_errors && response.validation_errors.length > 0) {
       consola.warn(`Validation errors: ${response.validation_errors}`);
     }
   }

lib/liquidTestRunner.js

@@ -1,10 +1,4 @@
 const yaml = require("yaml");
-const axios = require("axios");
-const open = require("open");
-const path = require("path");
-const { exec, execSync } = require("child_process");
-const isWsl = require("is-wsl");
-const commandExistsSync = require("command-exists").sync;
 const fs = require("fs");
 const chalk = require("chalk");
 const errorUtils = require("./utils/errorUtils");
@@ -13,6 +7,7 @@ const SF = require("./api/sfApi");
 const fsUtils = require("./utils/fsUtils");
 const runTestUtils = require("./utils/runTestUtils");
 const { consola } = require("consola");
+const { UrlHandler } = require("./utils/urlHandler");
 
 const { ReconciliationText } = require("./templates/reconciliationText");
 const { AccountTemplate } = require("./templates/accountTemplate");
@@ -147,9 +142,7 @@ function buildTestParams(firmId, templateType, handle, testName = "", renderMode
 
     finalTests = filteredContent;
     lineAdjustments = patternLineAdjustments;
-    consola.info(
-      `Running ${matchingTests.length} test${matchingTests.length === 1 ? "" : "s"} matching pattern "${pattern}":`
-    );
+    consola.info(`Running ${matchingTests.length} test${matchingTests.length === 1 ? "" : "s"} matching pattern "${pattern}":`);
     matchingTests.forEach((testName) => {
       consola.log(`  • ${testName}`);
     });
@@ -384,53 +377,11 @@ function processTestRunResponse(testRun, previewOnly, lineAdjustments = {}) {
   }
 }
 
-// Path to store HTML exports
-function resolveHTMLPath(fileName) {
-  const homedir = require("os").homedir();
-  const folderPath = path.resolve(homedir, ".silverfin/html_exports");
-  const filePath = path.resolve(folderPath, `${fileName}.html`);
-  fsUtils.createFolder(folderPath);
-  return filePath;
-}
-
-// Retrieve HTML, store it and open it in the default browser if needed
+// Retrieve HTML and open it in the default browser if needed
 async function getHTML(url, testName, openBrowser = false, htmlMode) {
-  const filePath = resolveHTMLPath(`${testName}_${htmlMode}`);
-  const htmlResponse = await axios.get(url);
-  if (htmlResponse.status === 200) {
-    fs.writeFileSync(filePath, htmlResponse.data);
-    if (openBrowser) {
-      if (isWsl) {
-        if (commandExistsSync("wsl-open")) {
-          exec(`wsl-open ${filePath}`);
-        } else {
-          consola.info("In order to automatically open HTML files on WSL, we need to install the wsl-open script.");
-          consola.log("You might be prompted for your password in order for us to install 'sudo npm install -g wsl-open'");
-          execSync("sudo npm install -g wsl-open");
-          consola.log("Installed wsl-open script");
-          exec(`wsl-open ${filePath}`);
-        }
-      } else {
-        await open(filePath);
-      }
-    }
-  }
-}
-
-async function deleteExistingHTMLs() {
-  try {
-    const homedir = require("os").homedir();
-    const folderPath = path.resolve(homedir, ".silverfin/html_exports");
-    if (!fs.existsSync(folderPath)) {
-      return;
-    }
-    const files = fs.readdirSync(folderPath);
-    files.forEach((fileName) => {
-      const filePath = path.resolve(folderPath, fileName);
-      fs.unlinkSync(filePath);
-    });
-  } catch (err) {
-    consola.debug(`Error while deleting existing HTML files`);
+  if (openBrowser) {
+    const filename = `${testName}_${htmlMode}`;
+    await new UrlHandler(url, filename).openFile();
   }
 }
 
@@ -447,7 +398,6 @@ async function getHTMLrenders(renderMode, testName, testRun, openBrowser) {
 }
 
 async function handleHTMLfiles(testName = "", testRun, renderMode) {
-  deleteExistingHTMLs();
   if (testName) {
     // Only one test
     getHTMLrenders(renderMode, testName, testRun, true);
@@ -496,16 +446,7 @@ async function runTests(firmId, templateType, handle, testName = "", previewOnly
   }
 }
 
-async function runTestsWithOutput(
-  firmId,
-  templateType,
-  handle,
-  testName = "",
-  previewOnly = false,
-  htmlInput = false,
-  htmlPreview = false,
-  pattern = ""
-) {
+async function runTestsWithOutput(firmId, templateType, handle, testName = "", previewOnly = false, htmlInput = false, htmlPreview = false, pattern = "") {
   try {
     if (templateType !== "reconciliationText" && templateType !== "accountTemplate") {
       consola.error(`Template type is missing or invalid`);
@@ -562,6 +503,5 @@ module.exports = {
   runTestsWithOutput,
   runTestsStatusOnly,
   getHTML,
-  resolveHTMLPath,
   checkAllTestsErrorsPresent,
 };

lib/utils/urlHandler.js

@@ -4,16 +4,18 @@ const axios = require("axios");
 const { consola } = require("consola");
 const errorUtils = require("./errorUtils");
 const fs = require("fs");
+const { WSLHandler } = require("./wslHandler");
 
 /**
  * Class to handle URL operations such as downloading and opening files.
  */
 class UrlHandler {
-  constructor(url) {
+  constructor(url, customFilename = null) {
     if (!url) {
       throw new Error("The 'url' parameter is required.");
     }
     this.url = url;
+    this.customFilename = customFilename;
   }
 
   /** Opens the file from the URL in the default application.
@@ -22,19 +24,41 @@ class UrlHandler {
   async openFile() {
     try {
       const filePath = await this.#downloadFile();
-      await open(filePath);
+      await this.#openLocalFile(filePath);
     } catch (error) {
       consola.error(`Failed to open URL: ${this.url}`, error);
     }
   }
 
+  async #openLocalFile(filePath) {
+    if (WSLHandler.isWSL()) {
+      await WSLHandler.open(filePath);
+    } else {
+      await open(filePath);
+    }
+  }
+
   async #downloadFile() {
     try {
       const response = await axios.get(this.url, { responseType: "arraybuffer" });
       const contentDisposition = response.headers["content-disposition"];
-      const fileExtension = contentDisposition ? this.#identifyExtension(contentDisposition) : "";
-      const tempFilePath = path.resolve(require("os").tmpdir(), "silverfin", `${Date.now()}.${fileExtension}`);
-      fs.mkdirSync(path.dirname(tempFilePath), { recursive: true });
+
+      let filename;
+      const fileExtension = contentDisposition ? this.#identifyFileExtension(contentDisposition) : "html";
+
+      if (this.customFilename) {
+        // Use custom filename with inferred extension
+        filename = `${this.customFilename}.${fileExtension}`;
+      } else {
+        // Try to infer filename from response, fall back to timestamp
+        const inferredFilename = contentDisposition ? this.#identifyFilename(contentDisposition) : null;
+        filename = inferredFilename || `${Date.now()}.${fileExtension}`;
+      }
+
+      const tempDir = path.resolve(require("os").tmpdir(), "silverfin");
+      fs.mkdirSync(tempDir, { recursive: true });
+
+      const tempFilePath = this.#getUniqueFilePath(tempDir, filename);
       fs.writeFileSync(tempFilePath, response.data);
 
       return tempFilePath;
@@ -43,7 +67,31 @@ class UrlHandler {
     }
   }
 
-  #identifyExtension(string) {
+  #getUniqueFilePath(directory, filename) {
+    const ext = path.extname(filename);
+    const nameWithoutExt = path.basename(filename, ext);
+    let filePath = path.resolve(directory, filename);
+    let counter = 1;
+
+    // If file exists, append (1), (2), etc. until we find a unique name
+    while (fs.existsSync(filePath)) {
+      const uniqueFilename = `${nameWithoutExt} (${counter})${ext}`;
+      filePath = path.resolve(directory, uniqueFilename);
+      counter++;
+    }
+
+    return filePath;
+  }
+
+  #identifyFilename(string) {
+    if (!string) return null;
+    // Match full filename from content-disposition header
+    // Handles: filename="file.ext", filename*=UTF-8''file.ext, filename=file.ext
+    const match = string.match(/filename[*]?=['"]?(?:UTF-8'')?([^'";\s]+)['";\s]?/i);
+    return match ? decodeURIComponent(match[1]) : null;
+  }
+
+  #identifyFileExtension(string) {
     if (!string) return null;
     const match = string.match(/filename[*]?=['"]?(?:[^'"]*\.)?([^.'";\s]+)['"]/i);
     return match ? match[1] : null;

lib/utils/wslHandler.js

@@ -0,0 +1,62 @@
+const { execFile, execSync } = require("child_process");
+const { promisify } = require("util");
+const fs = require("fs");
+const { consola } = require("consola");
+const prompt = require("prompt-sync")({ sigint: true });
+
+const execFileAsync = promisify(execFile);
+
+class WSLHandler {
+  /**
+   * Detects if running in Windows Subsystem for Linux (WSL)
+   * @returns {boolean} true if running in WSL, false otherwise
+   */
+  static isWSL() {
+    try {
+      const version = fs.readFileSync("/proc/version", "utf8").toLowerCase();
+      return version.includes("microsoft") || version.includes("wsl");
+    } catch {
+      return false;
+    }
+  }
+
+  static async open(filePath) {
+    this.#setupWslOpen();
+
+    try {
+      await execFileAsync("wsl-open", [filePath]);
+    } catch (error) {
+      consola.error(`Failed to open file in WSL: ${filePath}`, error);
+    }
+  }
+
+  static #wslOpenInPath() {
+    try {
+      execSync(`which wsl-open`, { stdio: "ignore" });
+      return true;
+    } catch {
+      consola.log(`Command 'wsl-open' not found in PATH.`);
+      return false;
+    }
+  }
+
+  static #setupWslOpen() {
+    if (this.#wslOpenInPath()) {
+      return;
+    }
+
+    consola.info("In order to automatically open files on WSL, we need to install the wsl-open script.");
+    consola.log("You might be prompted for your password in order for us to install 'sudo npm install -g wsl-open'");
+
+    const response = prompt("Do you want to proceed? (y/N): ");
+    if (response?.toLowerCase() !== "y") {
+      consola.warn("Skipping wsl-open installation. Files will not open automatically in WSL.");
+      return;
+    }
+
+    execSync("sudo npm install -g wsl-open");
+    consola.log("Installed wsl-open script");
+  }
+}
+
+module.exports = { WSLHandler };

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "silverfin-cli",
-  "version": "1.50.0",
+  "version": "1.51.0",
   "description": "Command line tool for Silverfin template development",
   "main": "index.js",
   "license": "MIT",
@@ -25,10 +25,8 @@
     "axios": "^1.6.2",
     "chalk": "4.1.2",
     "chokidar": "^3.6.0",
-    "command-exists": "^1.2.9",
     "commander": "^9.4.0",
     "consola": "^3.2.3",
-    "is-wsl": "^2.2.0",
     "open": "^8.4.0",
     "prompt-sync": "^4.2.0",
     "yaml": "^2.2.1"