vitest/docs/guide/debugging.md
Joshua Nussbaum dd7c80bee8
docs: add instructions for debugging tests via terminal (#2085)
Co-authored-by: Anjorin Damilare <damilareanjorin1@gmail.com>
2022-10-07 10:03:01 +02:00

1.5 KiB

title
Debugging | Guide

Debugging

Terminal

To debug a test file without an IDE, you can use ndb. Just add a debugger statement anywhere in your code, and then run ndb:

# install ndb globally
npm install -g ndb

# alternatively, with yarn
yarn global add ndb

# run tests with debugger enabled
ndb npm run test

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": "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.