调试

Terminal

在非集成开发环境下，为了调试一个测试文件，你可以使用 ndb。仅仅在你的代码的任何位置添加一个 debugger 语句，然后运行 ndb：

# 全局安装 ndb
npm install -g ndb

# 或者使用 yarn
yarn global add ndb

# 在启用 debugger 的情况下运行测试
ndb npm run test

TIP

在调试测试时，你可能使用 --test-timeout CLI 参数来防止测试在断点处停止时超时。

VS Code

在 VSCode 中调试测试的快速方法是通过 JavaScript 调试终端。 打开一个新的 JavaScript 调试终端 并直接运行 npm run test 或 vitest。这适用于在 Node 中运行的任何代码，因此适用于大多数 JS 测试框架

你还可以添加专用启动配置以在 VSCode 中调试测试文件:

{
  // 想了解更多的信息, 请访问：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"
    }
  ]
}

然后在调试选项卡中确保选择 'Debug Current Test File'，然后你可以打开要调试的测试文件并按 F5 开始调试。

浏览器模式

要调试 Vitest 浏览器模式，请在 CLI 中传递 --inspect 或 --inspect-brk，或在 Vitest 配置中定义它：

CLI

vitest --inspect-brk --browser --no-file-parallelism

vitest.config.js

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    inspectBrk: true,
    fileParallelism: false,
    browser: {
      name: 'chromium',
      provider: 'playwright',
    },
  },
})

默认情况下，Vitest 将使用端口 9229 作为调试端口。您可以通过在 --inspect-brk中传递值来覆盖它：

vitest --inspect-brk=127.0.0.1:3000 --browser --no-file-parallelism

使用以下 VSCode 复合配置 在浏览器中启动 Vitest 并附加调试器：

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Run Vitest Browser",
      "program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
      "console": "integratedTerminal",
      "args": ["--inspect-brk", "--browser", "--no-file-parallelism"]
    },
    {
      "type": "chrome",
      "request": "attach",
      "name": "Attach to Vitest Browser",
      "port": 9229
    }
  ],
  "compounds": [
    {
      "name": "Debug Vitest Browser",
      "configurations": ["Attach to Vitest Browser", "Run Vitest Browser"],
      "stopAll": true
    }
  ]
}

IntelliJ IDEA

创建一个 'Node.js' 运行配置。使用以下配置在调试模式下运行所有测试：

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

然后在调试模式下运行此配置。IDE 将在编辑器中设置的 JS/TS 断点处停止。

Node Inspector, e.g. Chrome DevTools

Vitest 还支持在没有 IDE 的情况下调试测试。然而，这要求测试不是并行运行的。可以使用以下命令之一启动 Vitest。

# To run in a single worker
vitest --inspect-brk --pool threads --poolOptions.threads.singleThread

# To run in a single child process
vitest --inspect-brk --pool forks --poolOptions.forks.singleFork

# To run in browser mode
vitest --inspect-brk --browser --no-file-parallelism

如果你使用的是 Vitest 1.1 或更高版本，你也可以仅提供 --no-parallelism 标志：

# 如果线程池未知
vitest --inspect-brk --no-file-parallelism

一旦 Vitest 启动，它将停止执行并等待你打开可以连接到 NodeJS 检查器 的开发者工具。 你可以通过在浏览器上打开 chrome://inspect 来使用 Chrome DevTools。

在监视模式下，你可以使用 --poolOptions.threads.isolate false 选项在测试重新运行期间保持调试器打开。