vitest/docs/guide/debugging.md
Konrad Kügler 329f9ca34d
docs: Add IntelliJ debug instructions (#1018)
* docs: Add IntelliJ debug instructions

The `--threads false` part is important, because the debugger
otherweise halts all worker threads upon start.
One would have to manually let those continue, which is quite annoying.

* docs: Add IntelliJ debug instructions

Switch to slashes for cross-platform compatibility.
2022-03-24 23:12:49 +08:00

1.2 KiB

Debugging

VSCode

To debug a test file in VSCode, create the following launch configuration.

{
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "type": "pwa-node",
            "request": "launch",
            "name": "Debug Current Test File",
            "autoAttachChildProcesses": true,
            "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
            "program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
            "args": ["run", "${relativeFile}"],
            "smartStep": true,
            "console": "integratedTerminal"
        }
    ]
}

Then in the debug tab ensure 'Debug Current Test File' is selected, you can then open the test file you want to debug and press F5 to start debugging.

IntelliJ IDEA

Create a 'Node.js' run configuration. Use the following settings to run all tests in debug mode:

Setting Value
Working directory /path/to/your-project-root
JavaScript file ./node_modules/vitest/vitest.mjs
Application parameters run --threads false

Then run this configuration in debug mode. The IDE will stop at JS/TS breakpoints set in the editor.