feat: test runtime support (#429)

Author: Danielku15

.github/workflows/build.yml

@@ -44,10 +44,30 @@ jobs:
           nvm install $(cat test-workspaces/nvm/.nvmrc)
           nvm install lts/*
 
+      - name: Update NPM (Linux)
+        if: runner.os == 'Linux'
+        run: |
+          sudo npm uninstall -g yarn pnpm
+          sudo npm install -g npm@latest
+          sudo npm install -g corepack@latest
+      - name: Update NPM (Win/MacOS)
+        if: runner.os != 'Linux'
+        run: |
+          npm uninstall -g yarn pnpm
+          npm install -g npm@latest
+          npm install -g corepack@latest
+      - name: Uninstall old yarn (MacOS)
+        if: runner.os == 'macOS'
+        run: |
+          rm -rf "$HOME/.yarn"
+
       - name: Install dependencies
         run: |
+          corepack enable
+          corepack prepare yarn@latest --activate
           node --version
           npm --version
+          yarn --version
           npm install
 
       - name: Compile
@@ -68,7 +88,10 @@ jobs:
       - name: Pack for VSIX Tests
         run: npm run package:test
         env:
-          TEST_TEMP: ${{ runner.temp }}        
+          TEST_TEMP: ${{ runner.temp }}      
+
+      - name: Recompile-tests
+        run: npm run compile:test
 
       - name: Run VSIX Tests (Linux)
         run: xvfb-run -a npm run test:vsix

.github/workflows/publish.yml

@@ -24,8 +24,27 @@ jobs:
         with:
           node-version: lts/*
 
+      - name: Update NPM (Linux)
+        if: runner.os == 'Linux'
+        run: |
+          sudo npm uninstall -g yarn pnpm
+          sudo npm install -g npm@latest
+          sudo npm install -g corepack@latest
+      - name: Update NPM (Win/MacOS)
+        if: runner.os != 'Linux'
+        run: |
+          npm uninstall -g yarn pnpm
+          npm install -g npm@latest
+          npm install -g corepack@latest
+
       - name: Install dependencies
-        run: npm install
+        run: |
+          corepack enable
+          corepack prepare yarn@latest --activate
+          node --version
+          npm --version
+          yarn --version
+          npm install
 
       - name: Build and Package
         run: npm run package:release

README.md

@@ -29,6 +29,10 @@ This extension automatically discovers and works with the `.mocharc.js/cjs/yaml/
 
 - `mocha-vscode.env`: Additional environment variables set when executing tests. This is useful for setting things like `NODE_ENV`.
 
+- `mocha-vscode.runtime`: The runtime to use for test discovery and execution.
+
+- `mocha-vscode.custom-runtime`: The command and arguments to launch the runtime. Needs to be compatible with `node` arguments.
+
 ## Features
 
 ### Show, Running and Debugging Tests
@@ -47,6 +51,22 @@ To discover tests this extension dynamically translates your TypeScript or ESM c
 
 For execution this extension will try to call directly the Mocha executable passing the `.mocharc` and additional arguments to it. 
 
+### Test Runtime 
+
+To discover and execute tests this extension executes inline scripts via a node-compatible runtime. Via these scripts the mocha conffiguration is loaded and test execution is started.
+
+The runtime is auto-detected by default and it will use the respective commands automatically. The runtime can also be manually configured.
+
+Supported runtimes: 
+
+* Node.js using `node` commands.
+* Node Version Manager using `nvm` commands.
+* Node.js using `yarn` commands (to support strategies like [PnP](https://yarnpkg.com/features/pnp))
+* Node Version Manager using `nvm` to launch `yarn` commands 
+
+You can also configure custom commands to be used via the VS Code settings. 
+This allows using alternative runtimes which are not supported out-of-the-box. The binary needs to support the same arguments like node for launching scripts.
+
 ## Troubleshooting
 
 ### Check if Mocha itself works

biome.jsonc

@@ -1,60 +1,68 @@
 {
-    "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
-    "files": {
-        "include": ["src/**"],
-        "ignore": ["out", "test-workspaces", "node_modules", "test-results", ".vscode-test", "tmp", "typings"]
-    },
+  "$schema": "https://biomejs.dev/schemas/2.3.0/schema.json",
+  "files": {
+    "includes": [
+      "src/**",
+      "scripts/**",
+      "!out",
+      "!test-workspaces",
+      "!node_modules",
+      "!test-results",
+      "!.vscode-test",
+      "!tmp",
+      "!typings",
+      "!src/typings"
+    ]
+  },
+  "formatter": {
+    "enabled": true,
+    "formatWithErrors": true,
+    "attributePosition": "auto",
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 120,
+    "lineEnding": "lf"
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "style": {
+        "noNonNullAssertion": "off", // we use these assertions
+        "noParameterAssign": "off", // useful for default values
+        "useBlockStatements": {
+          "level": "error",
+          "fix": "safe",
+          "options": {}
+        },
+        "useEnumInitializers": "off"
+      },
+      "suspicious": {
+        "noExplicitAny": "off" // used in areas where we work with dynamic JSON data
+      },
+      "correctness": {
+        "noUnusedImports": {
+          "level": "error",
+          "fix": "safe",
+          "options": {}
+        },
+        "noSwitchDeclarations": "off"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "arrowParentheses": "asNeeded",
+      "bracketSameLine": true,
+      "bracketSpacing": true,
+      "quoteProperties": "asNeeded",
+      "semicolons": "always",
+      "trailingCommas": "none",
+      "quoteStyle": "single"
+    }
+  },
+  "json": {
     "formatter": {
-        "enabled": true,
-        "formatWithErrors": true,
-        "ignore": [],
-        "attributePosition": "auto",
-        "indentStyle": "space",
-        "indentWidth": 4,
-        "lineWidth": 120,
-        "lineEnding": "lf"
-    },
-    "linter": {
-        "enabled": true,
-        "rules": {
-            "style": {
-                "noNonNullAssertion": "off", // we use these assertions
-                "noParameterAssign": "off", // useful for default values
-                "useBlockStatements": {
-                    "level": "error",
-                    "fix": "safe"
-                },
-                "useEnumInitializers": "off"
-            },
-            "suspicious": {
-                "noExplicitAny": "off" // used in areas where we work with dynamic JSON data
-            },
-            "correctness": {
-                "noUnusedImports": {
-                    "level": "error",
-                    "fix": "safe"
-                },
-                "noSwitchDeclarations": "off"
-            }
-        }
-    },
-    "organizeImports": {
-        "enabled": true
-    },
-    "javascript": {
-        "formatter": {
-            "arrowParentheses": "asNeeded",
-            "bracketSameLine": true,
-            "bracketSpacing": true,
-            "quoteProperties": "asNeeded",
-            "semicolons": "always",
-            "trailingCommas": "none",
-            "quoteStyle": "single"
-        }
-    },
-    "json": {
-        "formatter": {
-            "trailingCommas": "none"
-        }
+      "trailingCommas": "none"
     }
+  }
 }