feat: add the ability to define env variables for use when debugging (#697)

* feat: add the ability to define debug env variables

* fix: missing updated settings.json for test

Author: Alanoll

README.md

@@ -99,6 +99,7 @@ These options are resolved relative to the [workspace file](https://code.visuals
 - `vitest.vitestPackagePath`: The path to a `package.json` file of a Vitest executable (it's usually inside `node_modules`) in case the extension cannot find it. It will be used to resolve Vitest API paths. This should be used as a last resort fix.
 - `vitest.nodeEnv`: Environment passed to the runner process in addition to
   `process.env`
+- `vitest.debugNodeEnv`: Environment passed to the runner process in addition to `process.env` and `vitest.nodeEnv` when debugging tests
 - `vitest.debugExclude`: Excludes files matching specified glob patterns from debugging. Default:
   `["<node_internals>/**"]`
 - `vitest.debugOutFiles`: If source maps are enabled, these glob patterns specify the generated JavaScript files. If a pattern starts with `!` the files are excluded. If not specified, the generated code is expected in the same directory as its source. Default: `["${workspaceFolder}/**/*.(m|c|)js", "!**/node_modules/**"]`

package.json

@@ -207,6 +207,15 @@
           "type": "array",
           "scope": "resource"
         },
+        "vitest.debugNodeEnv": {
+          "markdownDescription": "The env passed to runner process in addition to `process.env` and `vitest.nodeEnv` when debugging tests",
+          "type": [
+            "object",
+            "null"
+          ],
+          "default": null,
+          "scope": "window"
+        },
         "vitest.nodeEnv": {
           "markdownDescription": "The env passed to runner process in addition to `process.env`",
           "type": [

packages/extension/src/config.ts

@@ -76,6 +76,7 @@ export function getConfig(workspaceFolder?: WorkspaceFolder) {
 
   return {
     env: get<null | Record<string, string>>('nodeEnv', null),
+    debugEnv: get<null | Record<string, string>>('debugNodeEnv', null),
     debugExclude: get<string[]>('debugExclude'),
     debugOutFiles,
     filesWatcherInclude,

packages/extension/src/debug.ts

@@ -43,6 +43,7 @@ export async function debugTests(
 
   const { runtimeArgs, runtimeExecutable } = await getRuntimeOptions(pkg)
   const env = config.env || {}
+  const debugEnv = config.debugEnv || {}
   const logLevel = config.logLevel
 
   log.info('[DEBUG]', 'Starting debugging session', runtimeExecutable, ...(runtimeArgs || []))
@@ -84,6 +85,7 @@ export async function debugTests(
     env: {
       ...process.env,
       ...env,
+      ...debugEnv,
       VITEST_VSCODE_LOG: env.VITEST_VSCODE_LOG ?? process.env.VITEST_VSCODE_LOG ?? logLevel,
       VITEST_VSCODE: 'true',
       VITEST_WS_ADDRESS: wsAddress,

samples/basic-v4/.vscode/settings.json

@@ -5,5 +5,9 @@
   "vitest.experimentalStaticAstCollect": true,
   "[typescript]": {
     "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "vitest.debugNodeEnv": {
+    "TEST_CUSTOM_ENV": "hello new",
+    "TEST_CUSTOM_ENV_2": "world"
   }
 }

samples/basic-v4/test/env.test.ts

@@ -1,9 +1,16 @@
-import { test, expect } from "vitest";
+import { expect, test } from "vitest";
 
 test('process.env', () => {
   expect(process.env.TEST).toBe('true');
   expect(process.env.VITEST).toBe('true');
   expect(process.env.NODE_ENV).toBe('test');
   expect(process.env.VITEST_VSCODE).toBe('true');
-  expect(process.env.TEST_CUSTOM_ENV).toBe('hello');
+
+  if(process.env.TEST_CUSTOM_ENV_2 === undefined) {
+    expect(process.env.TEST_CUSTOM_ENV).toBe('hello');
+  }
+  else {
+    expect(process.env.TEST_CUSTOM_ENV).toBe('hello new');
+    expect(process.env.TEST_CUSTOM_ENV_2).toBe('world');
+  }
 });