You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-28Lines changed: 30 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,40 +73,42 @@ You can identify if your config is loaded by the extension with `process.env.VIT
73
73
74
74
These options are resolved relative to the [workspace file](https://code.visualstudio.com/docs/editor/workspaces#_multiroot-workspaces) if there is one. If you have a single folder open in Visual Studio Code, paths will be resolved relative to that folder. If there are multiple folders, but there is no workspace file, then paths are resolved as is (so they should be absolute) - this can happen if you change your user config to have multiple folders.
75
75
76
-
-`vitest.rootConfig`: The path to your root config file. If you have several Vitest configs, consider using a [Vitest workspace](https://vitest.dev/guide/workspace).
77
-
-`vitest.workspaceConfig`: The path to the [Vitest workspace](https://vitest.dev/guide/workspace) config file. You can only have a single workspace config per VSCode workspace.
78
-
-`vitest.ignoreWorkspace`: Ignores the workspace resolution step. The extension will only look for `vitest.config` files.
79
-
-`vitest.configSearchPatternInclude`: [Glob pattern](https://code.visualstudio.com/docs/editor/glob-patterns) that should be used when this extension looks for config files. Note that this is applied to _config_ files, not test files inside configs. Default: `**/*{vite,vitest}*.config*.{ts,js,mjs,cjs,cts,mts}`.
80
-
-`vitest.configSearchPatternExclude`: [Glob pattern](https://code.visualstudio.com/docs/editor/glob-patterns) that should be ignored when this extension looks for config files. Note that this is applied to _config_ files, not test files inside configs. Default: `{**/node_modules/**,**/vendor/**,**/.*/**,*.d.ts}`. If the extension cannot find Vitest, please open an issue.
81
-
-`vitest.runtime`: The default runtime to run tests in. Supported: `auto` (default) `node` and `deno`. If auto, the extension will looks for a `deno.enabled` config flag or a `deno.json` file in the root folder.
82
-
-`vitest.shellType`: The method the extension uses to spawn a long-running Vitest process. This is particularly useful if you are using a custom shell script to set up the environment. When using the `terminal` shell type, the websocket connection will be established. Can either be `terminal` or `child_process`. Default: `child_process`.
83
-
-`vitest.nodeExecutable`: The path to the Node.js executable. If not assigned, tries to find Node.js path via a PATH variable or a `which` command. This is applied only when `vitest.shellType` is `child_process` (the default).
84
-
-`vitest.nodeExecArgs`: The arguments to pass to the Node.js executable. This is applied only when `vitest.shellType` is `child_process` (the default).
85
-
-`vitest.terminalShellPath`: The path to the shell executable. This is applied only when `vitest.shellType` is `terminal`.
86
-
-`vitest.terminalShellArgs`: The arguments to pass to the shell executable. This is applied only when `vitest.shellType` is `terminal`.
87
-
-`vitest.debuggerPort`: Port that the debugger will be attached to. By default uses 9229 or tries to find a free port if it's not available.
88
-
-`vitest.debuggerAddress`: TCP/IP address of process to be debugged. Default: localhost
89
-
-`vitest.cliArguments`: Additional arguments to pass to the Vitest CLI. Note that some arguments will be ignored: `watch`, `reporter`, `api`, and `ui`. Example: `--mode=staging`
90
-
-`vitest.showImportsDuration`: Show how long it took to import and transform the modules. When hovering, the extension provides more diagnostics.
91
-
-`vitest.watchOnStartup`: Keep Vitest server running in the background at all times automatically on startup, rerunning tests when files change (default: `false`). This is the same as enabling continuous run.
76
+
| Key | Description | Type | Default |
77
+
|-----|-------------|------|---------|
78
+
|`vitest.rootConfig`| The path to your root config file. If you have several Vitest configs, consider using a [Vitest workspace](https://vitest.dev/guide/workspace). |`string`| — |
79
+
|`vitest.workspaceConfig`| The path to the [Vitest workspace](https://vitest.dev/guide/workspace) config file. You can only have a single workspace config per VSCode workspace. |`string`| — |
80
+
|`vitest.ignoreWorkspace`| Ignores the workspace resolution step. The extension will only look for `vitest.config` files. |`boolean`| — |
81
+
|`vitest.configSearchPatternInclude`|[Glob pattern](https://code.visualstudio.com/docs/editor/glob-patterns) used when looking for config files. Applied to _config_ files, not test files inside configs. |`string`|`**/*{vite,vitest}*.config*.{ts,js,mjs,cjs,cts,mts}`|
82
+
|`vitest.configSearchPatternExclude`|[Glob pattern](https://code.visualstudio.com/docs/editor/glob-patterns) ignored when looking for config files. Applied to _config_ files, not test files inside configs. If the extension cannot find Vitest, please open an issue. |`string`|`{**/node_modules/**, **/vendor/**, **/.*/**, *.d.ts}`|
83
+
|`vitest.runtime`| The default runtime to run tests in. Supported: `auto`, `node`, `deno`. If `auto`, the extension looks for a `deno.enabled` config flag or a `deno.json` file in the root folder. |`string`|`auto`|
84
+
|`vitest.shellType`| The method the extension uses to spawn a Vitest process. Useful if you use a custom shell script to set up the environment. When using `terminal`, a websocket connection is established. |`"child_process" \| "terminal"`|`child_process`|
85
+
|`vitest.nodeExecutable`| The path to the Node.js executable. If not set, tries to find it via `PATH` or `which`. Only applies when `vitest.shellType` is `child_process`. |`string`| — |
86
+
|`vitest.nodeExecArgs`| Arguments to pass to the Node.js executable. Only applies when `vitest.shellType` is `child_process`. |`string[]`| — |
87
+
|`vitest.terminalShellPath`| The path to the shell executable. Only applies when `vitest.shellType` is `terminal`. |`string`| — |
88
+
|`vitest.terminalShellArgs`| Arguments to pass to the shell executable. Only applies when `vitest.shellType` is `terminal`. |`string[]`| — |
89
+
|`vitest.debuggerPort`| Port the debugger will be attached to. Uses `9229` or finds a free port if unavailable. |`number`|`9229`|
90
+
|`vitest.debuggerAddress`| TCP/IP address of the process to be debugged. |`string`|`localhost`|
91
+
|`vitest.cliArguments`| Additional arguments to pass to the Vitest CLI. Note: `watch`, `reporter`, `api`, and `ui` are ignored. Example: `--mode=staging`|`string`| — |
92
+
|`vitest.showImportsDuration`| Show how long it took to import and transform modules. Hovering provides more diagnostics. |`boolean`| — |
93
+
|`vitest.watchOnStartup`| Keep Vitest running in the background on startup, rerunning tests when files change. Same as enabling continuous run. |`boolean`|`false`|
92
94
93
95
> 💡 The `vitest.nodeExecutable` and `vitest.nodeExecArgs` settings are used as `execPath` and `execArgv` when spawning a new `child_process`, and as `runtimeExecutable` and `runtimeArgs` when [debugging a test](https://github.com/microsoft/vscode-js-debug/blob/main/OPTIONS.md).
94
96
> The `vitest.terminalShellPath` and `vitest.terminalShellArgs` settings are used as `shellPath` and `shellArgs` when creating a new [terminal](https://code.visualstudio.com/api/references/vscode-api#Terminal)
95
97
96
98
### Other Options
97
99
98
-
-`vitest.filesWatcherInclude`: Glob pattern for the watcher that triggers a test rerun or collects changes. Default: `**/*`
99
-
-`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.
100
-
-`vitest.nodeEnv`: Environment passed to the runner process in addition to
101
-
`process.env`
102
-
-`vitest.debugNodeEnv`: Environment passed to the runner process in addition to `process.env` and `vitest.nodeEnv` when debugging tests
103
-
-`vitest.debugExclude`: Excludes files matching specified glob patterns from debugging. Default:
104
-
`["<node_internals>/**", "vitest/dist/**"]`
105
-
-`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.
106
-
-`vitest.logLevel`: How verbose should the logger be in the "Output" channel. Default: `info`
107
-
-`vitest.applyDiagnostic`: Show a squiggly line where the error was thrown. This also enables the error count in the File Tab. Default: `true`
108
-
-`vitest.showInlineConsoleLog`: Show console.log messages inline in the editor next to the code that produced them. When disabled, console logs will still appear in the test output but not inline. Default: `true`
109
-
-`vitest.forceCancelTimeout`: When the 'Stop' button is clicked, the extension tries to stop tests gracefully so they don't keep any hanging processes. By default, if tests didn't finish in 1 second, the extension will kill any Vitest process which may keep your test's 'child_process' alive. You can configure the timeout with this option, but consider using [`signal`](https://vitest.dev/guide/test-context#signal) API inside of your tests instead.
100
+
| Key | Description | Type |Default|
101
+
|-----|-------------|------|---------|
102
+
|`vitest.filesWatcherInclude`| Glob pattern for the watcher that triggers a test rerun or collects changes. |`string`|`**/*`|
103
+
|`vitest.vitestPackagePath`| Path to a `package.json` of a Vitest executable (usually in `node_modules`) if the extension cannot find it. Used to resolve Vitest API paths. Last resort fix. |`string`| — |
104
+
|`vitest.nodeEnv`|Environment passed to the runner process in addition to `process.env`. |`object`| — |
105
+
|`vitest.debugNodeEnv`| Environment passed to the runner process in addition to `process.env` and `vitest.nodeEnv` when debugging tests. |`object`| — |
106
+
|`vitest.debugExclude`| Glob patterns for files to exclude from debugging. |`string[]`|`["<node_internals>/**", "vitest/dist/**"]`|
107
+
|`vitest.debugOutFiles`|If source maps are enabled, glob patterns specifying the generated JavaScript files. Patterns starting with `!`exclude files. If not set, generated code is expected alongside its source. |`string[]`| — |
108
+
|`vitest.logLevel`|How verbose the logger is in the "Output" channel. |`string`|`info`|
109
+
|`vitest.applyDiagnostic`|Show a squiggly line where the error was thrown. Also enables the error count in the File Tab. |`boolean`|`true`|
110
+
|`vitest.showInlineConsoleLog`|Show `console.log` messages inline in the editor next to the code that produced them. Logs still appear in test output when disabled. |`boolean`|`true`|
111
+
|`vitest.forceCancelTimeout`| Milliseconds to wait for tests to stop gracefully after clicking "Stop" before force-killing Vitest. Consider using the [`signal`](https://vitest.dev/guide/test-context#signal) API in tests instead.|`number`|`1000`|
0 commit comments