Node.js 调试 (在 VS Code 中)

Visual Studio Code 编辑器内置了对 Node.js 运行时的调试支持，并且可以调试 JavaScript、TypeScript 以及许多其他转译为 JavaScript 的语言。使用 VS Code 设置 Node.js 调试项目非常简单，它提供了合适的启动配置默认值和代码片段。

在 VS Code 中，您可以通过几种方式调试 Node.js 程序

使用自动附加来调试在 VS Code 集成终端中运行的进程。
使用JavaScript 调试终端，类似于使用集成终端。
使用启动配置来启动程序，或附加到进程在 VS Code 外部启动的进程。

自动附加

如果启用了“自动附加”功能，Node 调试器会自动附加到从 VS Code 集成终端启动的某些 Node.js 进程。要启用此功能，请使用命令面板中的“切换自动附加”命令 (⇧⌘P (Windows、Linux Ctrl+Shift+P))，或者，如果已激活，则使用“自动附加”状态栏项。

自动附加有三种模式，您可以在结果快速选择和通过 debug.javascript.autoAttachFilter 设置中选择

smart - 如果您在 node_modules 文件夹外部执行脚本，或者使用像 mocha 或 ts-node 这样的常用“运行器”脚本，则将调试该进程。您可以使用“自动附加智能模式”设置 (debug.javascript.autoAttachSmartPattern) 配置“运行器”脚本允许列表。
always - 将调试在集成终端中启动的所有 Node.js 进程。
onlyWithFlag - 仅调试使用 --inspect 或 --inspect-brk 标志启动的进程。

启用“自动附加”后，您需要通过单击终端右上角的 ⚠ 图标或创建一个新终端来重启终端。然后，调试器应在一秒钟内附加到您的程序

Auto Attach

当自动附加开启时，“自动附加”项将出现在 VS Code 窗口底部的状态栏中。单击它可以更改自动附加模式，或临时关闭它。如果您正在运行一些不需要调试的一次性程序，但又不想完全禁用该功能，则临时关闭自动附加非常有用。

其他配置

其他启动配置属性

您可以将通常在 launch.json 中找到的其他属性应用于 debug.javascript.terminalOptions 设置中的自动附加。例如，要将 node 内部组件添加到您的 skipFiles 中，您可以将以下内容添加到您的用户或工作区设置中

  "debug.javascript.terminalOptions": {
    "skipFiles": [
      "<node_internals>/**"
    ]
  },

自动附加智能模式

在 smart 自动附加模式下，VS Code 将尝试附加到您的代码，而不会附加到您不感兴趣调试的构建工具。它通过将主脚本与glob 模式列表进行匹配来实现这一点。glob 模式可在 debug.javascript.autoAttachSmartPattern 设置中配置，默认设置为

[
  '!**/node_modules/**', // exclude scripts in node_modules folders
  '**/$KNOWN_TOOLS$/**' // but include some common tools
];

$KNOWN_TOOLS$ 被替换为常见“代码运行器”的列表，例如 ts-node、mocha、ava 等。如果这些设置不起作用，您可以修改此列表。例如，要排除 mocha 并包含 my-cool-test-runner，您可以添加两行

[
  '!**/node_modules/**',
  '**/$KNOWN_TOOLS$/**',
  '!**/node_modules/mocha/**', // use "!" to exclude all scripts in "mocha" node modules
  '**/node_modules/my-cool-test-runner/**' // include scripts in the custom test runner
];

JavaScript 调试终端

与自动附加类似，JavaScript 调试终端将自动调试您在其中运行的任何 Node.js 进程。您可以通过从命令面板 (kbs(workbench.action.showCommands)) 运行“调试: 创建 JavaScript 调试终端”命令，或从终端切换器下拉列表中选择“创建 JavaScript 调试终端”来创建调试终端。

Create Debug Terminal

其他配置

其他启动配置属性

您可以将通常在 launch.json 中找到的其他属性应用于 debug.javascript.terminalOptions 设置中的调试终端。例如，要将 node 内部组件添加到您的 skipFiles 中，您可以将以下内容添加到您的用户或工作区设置中

"debug.javascript.terminalOptions": {
  "skipFiles": [
    "<node_internals>/**"
  ]
},

启动配置

启动配置是在 VS Code 中设置调试的传统方式，并且为您运行复杂应用程序提供了最多的配置选项。

在本节中，我们将更详细地介绍更高级调试场景的配置和功能。您将找到有关使用源映射调试、跳过外部代码、进行远程调试等的说明。

如果您想观看入门视频，请参阅VS Code 调试入门。

注意：如果您刚开始使用 VS Code，您可以从调试主题中了解常规调试功能和创建 launch.json 配置文件。

启动配置属性

调试配置存储在工作区的 .vscode 文件夹中的 launch.json 文件中。常规调试文章中介绍了调试配置文件的创建和使用。

以下是特定于 Node.js 调试器的常用 launch.json 属性的参考。您可以在vscode-js-debug 选项文档中查看完整的选项集。

以下属性在类型为 launch 和 attach 的启动配置中受支持

outFiles - 用于定位生成的 JavaScript 文件的glob 模式数组。请参阅源映射部分。
resolveSourceMapLocations - 用于解析源映射位置的glob 模式数组。请参阅源映射部分。
timeout - 重新启动会话时，在此毫秒数后放弃。请参阅附加到 Node.js部分。
stopOnEntry - 程序启动时立即中断。
localRoot - VS Code 的根目录。请参阅下面的远程调试部分。
remoteRoot - Node 的根目录。请参阅下面的远程调试部分。
smartStep- 尝试自动跳过未映射到源文件的代码。请参阅智能步进部分。
skipFiles - 自动跳过这些glob 模式涵盖的文件。请参阅跳过不感兴趣的代码部分。
trace - 启用诊断输出。

以下属性仅适用于请求类型为 launch 的启动配置

program - 要调试的 Node.js 程序的绝对路径。
args - 传递给要调试的程序的参数。此属性的类型为数组，并将各个参数作为数组元素。
cwd - 在此目录中启动要调试的程序。
runtimeExecutable - 要使用的运行时可执行文件的绝对路径。默认为 node。请参阅启动配置对“npm”和其他工具的支持部分。
runtimeArgs - 传递给运行时可执行文件的可选参数。
runtimeVersion - 如果使用“nvm”（或“nvm-windows”）或“nvs”来管理 Node.js 版本，则可以使用此属性来选择特定版本的 Node.js。请参阅下面的多版本支持部分。
env - 可选环境变量。此属性将环境变量作为字符串类型的键/值对列表。
envFile - 包含环境变量定义的可选文件路径。请参阅下面的从外部文件加载环境变量部分。
console - 启动程序的控制台 (internalConsole、integratedTerminal、externalTerminal)。请参阅下面的Node 控制台部分。
outputCapture - 如果设置为 std，则进程 stdout/stderr 的输出将显示在调试控制台中，而不是侦听调试端口上的输出。这对于直接写入 stdout/stderr 流而不是使用 console.* API 的程序或日志库很有用。

此属性仅适用于请求类型为 attach 的启动配置

restart - 在终止时重启连接。请参阅在源文件编辑时自动重启调试会话部分。
port - 要使用的调试端口。请参阅附加到 Node.js和远程调试部分。
address - 调试端口的 TCP/IP 地址。请参阅附加到 Node.js和远程调试部分。
processId - 调试器在发送 USR1 信号后尝试附加到此进程。使用此设置，调试器可以附加到尚未在调试模式下启动的正在运行的进程。使用 processId 属性时，调试端口会根据 Node.js 版本（和使用的协议）自动确定，并且无法显式配置。因此，请勿指定 port 属性。
continueOnAttach - 是否在附加到进程时继续进程（如果进程已暂停）。如果您使用 --inspect-brk 启动程序，则此选项很有用。

常见场景的启动配置

您可以在 launch.json 文件中触发 IntelliSense (⌃Space (Windows、Linux Ctrl+Space)) 以查看常用 Node.js 调试场景的启动配置代码片段。

Launch configuration snippets for Node.js

您还可以使用 launch.json 编辑器窗口右下角的“添加配置...”按钮调出代码片段。

以下代码片段可用

启动程序：在调试模式下启动 Node.js 程序。
通过 npm 启动：通过 npm “debug”脚本启动 Node.js 程序。如果您的 package.json 中定义了 npm 调试脚本，则可以从启动配置中使用它。npm 脚本中使用的调试端口必须与代码片段中指定的端口相对应。
附加：附加到本地运行的 Node.js 程序的调试端口。确保要调试的 Node.js 程序已在调试模式下启动，并且使用的调试端口与代码片段中指定的端口相同。
附加到远程程序：附加到 address 属性指定的主机上运行的 Node.js 程序的调试端口。确保要调试的 Node.js 程序已在调试模式下启动，并且使用的调试端口与代码片段中指定的端口相同。为了帮助 VS Code 在您的工作区和远程主机的文件系统之间映射源文件，请确保为 localRoot 和 remoteRoot 属性指定正确的路径。
按进程 ID 附加：打开进程选取器以选择要调试的 node 或 gulp 进程。使用此启动配置，您甚至可以附加到未在调试模式下启动的 node 或 gulp 进程。
Nodemon 设置：使用 nodemon 在 JavaScript 源代码更改时自动重新启动调试会话。确保您已全局安装 nodemon。请注意，终止调试会话只会终止要调试的程序，而不会终止 nodemon 本身。要终止 nodemon，请在集成终端中按 Ctrl+C。
Mocha 测试：在项目的 test 文件夹中调试 mocha 测试。确保您的项目在其 node_modules 文件夹中安装了“mocha”。
Yeoman 生成器：调试 yeoman 生成器。代码片段会要求您指定生成器的名称。确保您的项目在其 node_modules 文件夹中安装了“yo”，并且您生成的项目已通过在项目文件夹中运行 npm link 安装以进行调试。
Gulp 任务：调试 gulp 任务。确保您的项目在其 node_modules 文件夹中安装了“gulp”。
Electron Main：调试 Electron 应用程序的主 Node.js 进程。该代码片段假定 Electron 可执行文件已安装在工作区的 node_modules/.bin 目录中。

Node 控制台

默认情况下，Node.js 调试会话在内部 VS Code 调试控制台中启动目标。由于调试控制台不支持需要从控制台读取输入的程序，因此您可以通过将启动配置中的 console 属性分别设置为 externalTerminal 或 integratedTerminal 来启用外部终端或使用 VS Code 集成终端。默认值为 internalConsole。

在外部终端中，您可以通过 terminal.external.windowsExec、terminal.external.osxExec 和 terminal.external.linuxExec 设置配置要使用的终端程序。

启动配置对“npm”和其他工具的支持

您可以直接从启动配置中使用“npm”脚本或其他任务运行器工具，而不是直接使用 node 启动 Node.js 程序

您可以将 PATH 上可用的任何程序（例如“npm”、“mocha”、“gulp”等）用于 runtimeExecutable 属性，并且可以通过 runtimeArgs 传递参数。
如果您的 npm 脚本或其他工具隐式指定了要启动的程序，则不必设置 program 属性。

让我们看一个“npm”示例。如果您的 package.json 具有“debug”脚本，例如

  "scripts": {
    "debug": "node myProgram.js"
  },

相应的启动配置将如下所示

{
  "name": "Launch via npm",
  "type": "node",
  "request": "launch",
  "cwd": "${workspaceFolder}",
  "runtimeExecutable": "npm",
  "runtimeArgs": ["run-script", "debug"]
}

多版本支持

如果您使用“nvm”（或“nvm-windows”）来管理 Node.js 版本，则可以在启动配置中指定 runtimeVersion 属性以选择特定版本的 Node.js

{
  "type": "node",
  "request": "launch",
  "name": "Launch test",
  "runtimeVersion": "14",
  "program": "${workspaceFolder}/test.js"
}

如果您使用“nvs”来管理 Node.js 版本，则可以使用 runtimeVersion 属性来选择特定版本、体系结构和风格的 Node.js，例如

{
  "type": "node",
  "request": "launch",
  "name": "Launch test",
  "runtimeVersion": "chackracore/8.9.4/x64",
  "program": "${workspaceFolder}/test.js"
}

请确保安装了要与 runtimeVersion 属性一起使用的 Node.js 版本，因为该功能不会自动下载和安装该版本。例如，如果您计划将 "runtimeVersion": "7.10.1" 添加到启动配置中，则必须从集成终端运行类似 nvm install 7.10.1 或 nvs add 7.10.1 的命令。

如果您省略次要版本和补丁版本，并且例如具有 "runtimeVersion": "14"，则将使用系统上安装的最新 14.x.y 版本。

从外部文件加载环境变量

VS Code Node 调试器支持从文件加载环境变量并将它们传递给 Node.js 运行时。要使用此功能，请将属性 envFile 添加到您的启动配置，并指定包含环境变量的文件的绝对路径

   //...
   "envFile": "${workspaceFolder}/.env",
   "env": { "USER": "john doe" }
   //...

在 env 字典中指定的任何环境变量都将覆盖从文件加载的变量。

这是 .env 文件的示例

USER=doe
PASSWORD=abc123

# a comment

# an empty value:
empty=

# new lines expanded in quoted strings:
lines="foo\nbar"

附加到 Node.js

如果您要将 VS Code 调试器附加到外部 Node.js 程序，请按如下方式启动 Node.js

node --inspect program.js

或者，如果程序不应开始运行，而必须等待调试器附加

node --inspect-brk program.js

将调试器附加到程序的选项

打开一个“进程选取器”，其中列出了所有潜在的候选进程，并允许您选择一个，或者
创建一个“附加”配置，该配置显式指定所有配置选项，然后按 F5。

让我们详细了解这些选项

附加到 Node 进程操作

命令面板中的“附加到 Node 进程”命令 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 打开一个快速选择菜单，其中列出了 Node.js 调试器可用的所有潜在进程

Node.js Process picker

选取器中列出的各个进程显示了调试端口和进程 ID。一旦您在该列表中选择了您的 Node.js 进程，Node.js 调试器将尝试附加到它。

除了 Node.js 进程之外，选取器还显示了使用各种形式的 --inspect 参数启动的其他程序。这使得可以附加到 Electron 或 VS Code 的辅助进程。

设置“附加”配置

此选项需要更多的工作，但与前两个选项相比，它允许您显式配置各种调试配置选项。

最简单的“附加”配置如下所示

{
  "name": "Attach to Process",
  "type": "node",
  "request": "attach",
  "port": 9229
}

端口 9229 是 --inspect 和 --inspect-brk 选项的默认调试端口。要使用其他端口（例如 12345），请将其添加到如下选项中：--inspect=12345 和 --inspect-brk=12345，并更改启动配置中的 port 属性以匹配。

要附加到未在调试模式下启动的 Node.js 进程，您可以通过将 Node.js 进程的进程 ID 指定为字符串来完成此操作

{
  "name": "Attach to Process",
  "type": "node",
  "request": "attach",
  "processId": "53426"
}

为了避免在启动配置中重复输入新的进程 ID，Node 调试支持命令变量 PickProcess，它将打开进程选取器（如上所示）。

使用 PickProcess 变量，启动配置如下所示

{
  "name": "Attach to Process",
  "type": "node",
  "request": "attach",
  "processId": "${command:PickProcess}"
}

停止调试

使用“调试: 停止”操作（在调试工具栏中或通过“命令面板”可用）停止调试会话。

如果调试会话以“附加”模式启动（并且调试工具栏中的红色终止按钮显示叠加的“插头”），则按“停止”会断开 Node.js 调试器与调试目标的连接，然后调试目标继续执行。

如果调试会话处于“启动”模式，则按“停止”将执行以下操作

首次按“停止”时，将请求调试目标通过发送 SIGINT 信号来优雅关闭。调试目标可以自由地拦截此信号并根据需要清理任何内容，然后关闭。如果关闭代码中没有断点（或问题），则调试目标和调试会话将终止。
但是，如果调试器在关闭代码中遇到断点，或者调试目标本身未正确终止，则调试会话将不会结束。在这种情况下，再次按“停止”将强制终止调试目标及其子进程 (SIGKILL)。

如果您看到在按红色“停止”按钮时调试会话未结束，请再次按该按钮以强制关闭调试目标。

在 Windows 上，按“停止”会强制杀死调试目标及其子进程。

源映射

VS Code 的 JavaScript 调试器支持源映射，这有助于调试转译语言，例如 TypeScript 或缩小/丑化的 JavaScript。使用源映射，可以在原始源代码中单步执行或设置断点。如果原始源不存在源映射，或者源映射已损坏且无法成功地在源和生成的 JavaScript 之间进行映射，则断点会显示为未验证（灰色空心圆圈）。

默认值为 true 的 sourceMaps 属性控制源映射功能。调试器始终尝试使用源映射（如果可以找到任何源映射），因此，您甚至可以使用 program 属性指定源文件（例如，app.ts）。如果出于某种原因需要禁用源映射，则可以将 sourceMaps 属性设置为 false。

工具配置

由于源映射并非总是自动创建，因此您应确保配置转译器以创建它们。例如

TypeScript

对于 TypeScript，您可以通过将 --sourceMap 传递给 tsc，或在 tsconfig.json 文件中添加 "sourceMap": true 来启用源映射。

tsc --sourceMap --outDir bin app.ts

Babel

对于 Babel，您需要将 sourceMaps 选项设置为 true，或者在编译代码时传递 --source-maps 选项。

npx babel script.js --out-file script-compiled.js --source-maps

Webpack

Webpack 具有众多源映射选项。我们建议在您的 webpack.config.js 中设置属性 devtool: "source-map" 以获得最佳结果保真度，尽管您可以尝试其他设置，但会导致构建速度变慢。

此外，如果 webpack 中有其他编译步骤，例如使用 TypeScript 加载器，您还需要确保将这些步骤设置为生成源映射。否则，webpack 生成的源映射将映射回加载器中的编译代码，而不是实际源。

源映射发现

默认情况下，VS Code 将搜索您的整个工作区（排除 node_modules）以查找源映射。在大型工作区中，此搜索可能会很慢。您可以通过在 launch.json 中设置 outFiles 属性来配置 VS Code 将搜索源映射的位置。例如，此配置将仅发现 bin 文件夹中 .js 文件的源映射

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Launch TypeScript",
      "type": "node",
      "request": "launch",
      "program": "app.ts",
      "outFiles": ["${workspaceFolder}/bin/**/*.js"]
    }
  ]
}

请注意，outFiles 应与您的 JavaScript 文件匹配，而不是源映射文件（源映射文件可能以 .map 而不是 .js 结尾）。

源映射解析

默认情况下，仅解析 outFiles 中的源映射。此行为用于防止依赖项干扰您设置的断点。例如，如果您有一个文件 src/index.ts，并且某个依赖项有一个源映射，该源映射引用了 webpack:///./src/index.ts，则该源映射将错误地解析为您的源文件，并可能导致意外结果。

您可以通过设置 resolveSourceMapLocations 选项来配置此行为。如果设置为 null，则将解析每个源映射。例如，此配置还将允许解析 node_modules/some-dependency 中的源映射

  "resolveSourceMapLocations": [
    "out/**/*.js",
    "node_modules/some-dependency/**/*.js",
  ]

智能步进

在启动配置中将 smartStep 属性设置为 true 后，VS Code 将在调试器中单步执行代码时自动跳过“不感兴趣的代码”。“不感兴趣的代码”是指由转译过程生成的代码，但未被源映射覆盖，因此它不会映射回原始源。当您在调试器中单步执行源代码时，此代码会妨碍您，因为它会使调试器在原始源代码和您不感兴趣的生成代码之间切换。smartStep 将自动单步执行未被源映射覆盖的代码，直到再次到达被源映射覆盖的位置。

智能步进对于 TypeScript 中的 async/await 向下编译等情况特别有用，在这些情况下，编译器会注入未被源映射覆盖的辅助代码。

smartStep 功能仅适用于从源生成的 JavaScript 代码，因此具有源映射。对于没有源的 JavaScript，智能步进选项无效。

JavaScript 源映射提示

使用源映射进行调试时，一个常见问题是您设置断点，它会变成灰色。如果您将光标悬停在断点上，您将看到消息“Breakpoint ignored because generated code not found (source map problem?)”。现在怎么办？导致此问题的原因有很多。首先，快速解释一下 Node 调试适配器如何处理源映射。

当您在 app.ts 中设置断点时，调试适配器必须找出 app.js 的路径，即您的 TypeScript 文件的转译版本，这才是实际在 Node 中运行的文件。但是，从 .ts 文件开始，没有直接的方法可以找出这一点。相反，调试适配器使用 launch.json 中的 outFiles 属性来查找所有转译后的 .js 文件，并解析它们以查找源映射，其中包含其关联的 .ts 文件的位置。

当你在启用了源映射的 TypeScript 中构建 app.ts 文件时，它会生成一个 app.js.map 文件，或者将源映射作为 base64 编码的字符串内联在 app.js 文件底部的注释中。为了找到与此映射关联的 .ts 文件，调试适配器会查看源映射中的两个属性：sources 和 sourceRoot。sourceRoot 是可选的 - 如果存在，它会添加到 sources 中每个路径的前面，而 sources 是路径数组。结果是一个指向 .ts 文件的绝对或相对路径数组。相对路径是相对于源映射解析的。

最后，调试适配器在此生成的 .ts 文件列表中搜索 app.ts 的完整路径。如果找到匹配项，则表示它已找到在将 app.ts 映射到 app.js 时要使用的源映射文件。如果没有匹配项，则无法绑定断点，并且断点将变为灰色。

以下是当你的断点变为灰色时可以尝试的一些方法

调试时，运行调试: 诊断断点问题命令。此命令将弹出一个工具，该工具可以提供提示，帮助你从命令面板（⇧⌘P (Windows, Linux Ctrl+Shift+P)）中解决任何问题。
你是否在启用了源映射的情况下构建？请确保存在 .js.map 文件，或者在你的 .js 文件中存在内联源映射。
你的源映射中的 sourceRoot 和 sources 属性是否正确？它们可以组合起来以获得 .ts 文件的正确路径吗？
你是否在 VS Code 中以不正确的大小写打开了文件夹？有可能从命令行打开文件夹 foo/，例如 code FOO，在这种情况下，源映射可能无法正确解析。
尝试在 Stack Overflow 上搜索有关你的特定设置的帮助，或在 GitHub 上提交 issue。
尝试添加 debugger 语句。如果它在那里中断到 .ts 文件中，但该位置的断点未绑定，则这是包含在 GitHub issue 中的有用信息。

覆盖源映射路径

调试器使用 sourceMapPathOverrides 来实现自定义的源映射到磁盘路径的映射。大多数工具都已设置了良好的默认值，但在高级情况下，你可能需要自定义它。默认路径覆盖是一个对象映射，如下所示

{
  'webpack:///./~/*': "${workspaceFolder}/node_modules/*",
  'webpack:////*': '/*',
  'webpack://@?:*/?:*/*': "${workspaceFolder}/*",
  // and some more patterns...
}

这会将源映射中的路径或 URL 从左侧映射到右侧。模式 ?:* 是非贪婪、非捕获匹配，而 * 是贪婪捕获匹配。然后，调试器将右侧模式中对应的 * 替换为从源映射路径捕获的片段。例如，上面示例中的最后一个模式会将 webpack://@my/package/foo/bar 映射到 ${workspaceFolder}/foo/bar。

请注意，对于浏览器调试，在默认的 sourceMapPathOverrides 中，使用 webRoot 代替 workspaceFolder。

远程调试

注意： VS Code 现在具有通用的远程开发功能。使用 Remote Development 扩展，远程场景和容器中的 Node.js 开发与本地设置中的 Node.js 开发没有什么不同。这是远程调试 Node.js 程序的推荐方式。查看入门指南部分和远程教程以了解更多信息。

如果你无法使用任何 Remote Development 扩展来调试你的 Node.js 程序，以下指南介绍了如何从本地 VS Code 实例调试远程 Node.js 程序。

Node.js 调试器支持远程调试，你可以在其中附加到在不同计算机或容器上运行的进程。通过 address 属性指定远程主机。例如

{
  "type": "node",
  "request": "attach",
  "name": "Attach to remote",
  "address": "192.168.148.2", // <- remote address here
  "port": 9229
}

默认情况下，VS Code 会将调试的源从远程 Node.js 文件夹流式传输到本地 VS Code，并在只读编辑器中显示它。你可以单步执行此代码，但无法修改它。如果你希望 VS Code 从你的工作区打开可编辑的源，则可以在远程位置和本地位置之间设置映射。可以使用 localRoot 和 remoteRoot 属性来映射本地 VS Code 项目和（远程）Node.js 文件夹之间的路径。即使在同一系统上本地或跨不同操作系统，这也有效。每当需要将代码路径从远程 Node.js 文件夹转换为本地 VS Code 路径时，都会从路径中剥离 remoteRoot 路径，并替换为 localRoot。对于反向转换，localRoot 路径将替换为 remoteRoot。

{
  "type": "node",
  "request": "attach",
  "name": "Attach to remote",
  "address": "TCP/IP address of process to be debugged",
  "port": 9229,
  "localRoot": "${workspaceFolder}",
  "remoteRoot": "C:\\Users\\username\\project\\server"
}

访问已加载的脚本

如果你需要在不属于你的工作区并且因此无法通过正常的 VS Code 文件浏览轻松找到和打开的脚本中设置断点，则可以通过运行和调试视图中的 LOADED SCRIPTS 视图访问加载的脚本

Loaded Scripts Explorer

LOADED SCRIPTS 视图允许你通过键入脚本名称快速选择脚本，或者在 Enable Filter on Type 处于启用状态时过滤列表。

脚本将加载到只读编辑器中，你可以在其中设置断点。这些断点在调试会话中会被记住，但你只能在调试会话运行时访问脚本内容。

在源文件编辑时自动重启调试会话

启动配置的 restart 属性控制 Node.js 调试器在调试会话结束后是否自动重启。如果你使用 nodemon 在文件更改时重启 Node.js，则此功能非常有用。将启动配置属性 restart 设置为 true 会使 node 调试器在 Node.js 终止后自动尝试重新附加到 Node.js。

如果你已通过命令行像这样在 nodemon 上启动了程序 server.js

nodemon --inspect server.js

你可以使用以下启动配置将 VS Code 调试器附加到它

{
  "name": "Attach to node",
  "type": "node",
  "request": "attach",
  "restart": true,
  "port": 9229
}

或者，你可以使用启动配置直接通过 nodemon 启动程序 server.js 并附加 VS Code 调试器

{
  "name": "Launch server.js via nodemon",
  "type": "node",
  "request": "launch",
  "runtimeExecutable": "nodemon",
  "program": "${workspaceFolder}/server.js",
  "console": "integratedTerminal",
  "internalConsoleOptions": "neverOpen"
}

提示： 按下停止按钮会停止调试会话并断开与 Node.js 的连接，但 nodemon（和 Node.js）将继续运行。要停止 nodemon，你必须从命令行将其终止（如果你使用如上所示的 integratedTerminal，则很容易做到这一点）。

提示： 如果出现语法错误，在错误修复之前，nodemon 将无法成功启动 Node.js。在这种情况下，VS Code 将继续尝试附加到 Node.js，但最终会放弃（10 秒后）。为了避免这种情况，你可以通过添加具有更大值（以毫秒为单位）的 timeout 属性来增加超时时间。

重启帧

Node 调试器支持在堆栈帧处重启执行。这在你在源代码中发现问题并且想要使用修改后的输入值重新运行代码的一小部分时非常有用。停止然后重启完整的调试会话可能很耗时。Restart Frame 操作允许你在使用 Set Value 操作更改变量后重新进入当前函数

Restart frame

Restart Frame 不会回滚函数外部状态的更改，因此它可能并不总是按预期工作。

断点

条件断点

条件断点是仅当表达式返回真值时才暂停的断点。你可以通过右键单击行号旁边的装订线并选择“条件断点”来创建一个。

Conditional breakpoint

日志点

有时你只想在代码到达特定位置时记录消息或值，而不是暂停。你可以使用日志点执行此操作。日志点不会暂停，而是在命中时将消息记录到调试控制台。在 JavaScript 调试器中，你可以使用花括号将表达式插入到消息中，例如 current value is: {myVariable.property}。

你可以通过右键单击行号旁边的装订线并选择“日志点”来创建一个。例如，这可能会记录类似 location is /usr/local 的内容

Logpoint

命中计数断点

“命中计数条件”控制断点需要被命中多少次才会“中断”执行。你可以通过右键单击行号旁边的装订线，选择“条件断点”，然后切换到“命中计数”来放置命中计数断点。

Hit count breakpoint

Node.js 调试器支持的命中计数语法可以是整数或运算符 <、<=、==、>、>=、% 后跟一个整数。

一些示例

>10 在 10 次命中后始终中断
<3 仅在前两次命中时中断
10 与 >=10 相同
%2 在每次其他命中时中断

触发断点

触发断点是另一个断点被命中后自动启用的断点。当诊断仅在特定前提条件之后发生的代码中的故障情况时，它们非常有用。

可以通过右键单击字形边距，选择 Add Triggered Breakpoint，然后选择哪个其他断点启用该断点来设置触发断点。

断点验证

出于性能原因，Node.js 在首次访问时懒加载 JavaScript 文件中的函数。因此，断点在 Node.js 尚未看到（解析）的源代码区域中不起作用。

由于此行为对于调试来说并不理想，因此 VS Code 会自动将 --nolazy 选项传递给 Node.js。这可以防止延迟解析，并确保可以在运行代码之前验证断点（因此它们不再“跳转”）。

由于 --nolazy 选项可能会显着增加调试目标的启动时间，因此你可以通过传递 --lazy 作为 runtimeArgs 属性轻松选择退出。

这样做时，你会发现你的某些断点没有“粘”在请求的行上，而是“跳转”到已解析代码中的下一个可能的行。为了避免混淆，VS Code 始终在 Node.js 认为断点所在的位置显示断点。在 BREAKPOINTS 部分中，这些断点显示在请求的行号和实际行号之间有一个箭头

Breakpoints View

当会话启动并且断点在 Node.js 中注册时，或者当会话已在运行并且设置了新断点时，会发生此断点验证。在这种情况下，断点可能会“跳转”到不同的位置。在 Node.js 解析了所有代码（例如，通过运行它）之后，可以使用 BREAKPOINTS 部分标题中的 Reapply 按钮轻松地将断点重新应用于请求的位置。这应该使断点“跳回”到请求的位置。

Breakpoint Actions

跳过不感兴趣的代码

VS Code Node.js 调试具有避免单步执行你不想要单步执行的源代码的功能（也称为“Just My Code”）。可以使用启动配置中的 skipFiles 属性启用此功能。skipFiles 是要跳过的脚本路径的glob 模式数组。

例如，使用

  "skipFiles": [
    "${workspaceFolder}/node_modules/**/*.js",
    "${workspaceFolder}/lib/**/*.js"
  ]

将跳过项目中的 node_modules 和 lib 文件夹中的所有代码。skipFiles 也适用于调用 console.log 和类似方法时显示的位置：堆栈中的第一个非跳过位置将显示在调试控制台中的输出旁边。

Node.js 的内置核心模块可以通过 glob 模式中的“魔法名称” <node_internals> 来引用。以下示例跳过所有内部模块

  "skipFiles": [
     "<node_internals>/**/*.js"
   ]

确切的“跳过”规则如下

如果你单步执行到跳过的文件，你不会在那里停止 - 你将在下一个执行的行上停止，该行不在跳过的文件中。
如果你已设置选项以在抛出异常时中断，则你不会在从跳过的文件中抛出的异常处中断，除非它们冒泡到非跳过的文件中。
如果你在跳过的文件中设置断点，你将在该断点处停止，并且你将能够单步执行它，直到你单步跳出它为止，此时正常的跳过行为将恢复。
来自跳过文件内部的控制台消息的位置将显示为调用堆栈中的第一个非跳过位置。

跳过的源以“变暗”样式显示在 CALL STACK 视图中

Skipped source is dimmed in call stack view

悬停在变暗的条目上会解释堆栈帧变暗的原因。

调用堆栈上的上下文菜单项 Toggle skipping this file 使你能够在运行时轻松跳过文件，而无需将其添加到启动配置中。此选项仅在当前调试会话中持续存在。你也可以使用它来停止跳过由启动配置中的 skipFiles 选项跳过的文件。

注意： legacy 协议调试器支持负 glob 模式，但它们必须跟随正模式：正模式添加到跳过文件集，而负模式从该集合中减去。

在以下（仅 legacy 协议）示例中，除了“math”模块之外的所有模块都被跳过

"skipFiles": [
    "${workspaceFolder}/node_modules/**/*.js",
    "!${workspaceFolder}/node_modules/math/**/*.js"
]

注意： legacy 协议调试器必须模拟 skipFiles 功能，因为 V8 Debugger Protocol 本身不支持它。这可能会导致单步执行性能缓慢。

调试 WebAssembly

如果 JavaScript 调试器编译为 WebAssembly 的代码包含 DWARF 调试信息，则可以对其进行调试。许多工具链都支持发出此信息

C/C++ with Emscripten：使用 -g 标志编译以发出调试信息。
Zig：DWARF 信息在“Debug”构建模式下自动发出。
Rust：Rust 发出 DWARF 调试信息。但是，wasm-pack 尚未在构建期间保留它。因此，wasm-bindgen/wasm-pack 库的常见用户不应运行 wasm-pack build，而应使用两个命令手动构建
1. cargo install wasm-bindgen-cli 一次以安装必要的命令行工具。
2. cargo build --target wasm32-unknown-unknown 构建你的库。
3. wasm-bindgen --keep-debug --out-dir pkg ./target/wasm32-unknown-unknown/debug/<library-name>.wasm <extra-arguments> 生成 WebAssembly 绑定，将 <library-name> 替换为 Cargo.toml 中的名称，并根据需要配置 <extra-arguments>。

构建代码后，你需要安装 WebAssembly DWARF Debugging 扩展。为了保持 VS Code 核心“精简”，它作为单独的扩展发布。安装后，重启任何活动的调试会话，然后应在调试器中映射本机代码！你应该在 Loaded Sources 视图中看到你的源代码出现，并且断点应该可以工作。

在下图中，调试器停在 C++ 源代码中的断点处，该断点创建了一个 Mandelbrot 分形。调用堆栈可见，其中包含来自 JavaScript 代码、WebAssembly 和映射的 C++ 代码的帧。你还可以看到 C++ 代码中的变量，以及对与 int32 height 变量关联的内存的编辑。

Debugger stopped on a breakpoint in C++ source code

虽然接近对等，但调试 WebAssembly 与普通的 JavaScript 有些不同

Variables 视图中的变量无法直接编辑。但是，你可以选择变量旁边的 View Binary Data 操作来编辑其关联的内存。
Debug Console 和 Watch 视图中的基本表达式求值由 lldb-eval 提供。这与普通的 JavaScript 表达式不同。
未映射到源代码的位置将以反汇编的 WebAssembly 文本格式显示。对于 WebAssembly，命令 Disable Source Map Stepping 将导致调试器仅在反汇编代码中单步执行。

VS Code 的 WebAssembly 调试构建在 Chromium 作者的 C/C++ Debugging Extension 之上。

支持的类 Node 运行时

当前的 VS Code JavaScript 调试器支持 8.x 或更高版本的 Node 版本、最近的 Chrome 版本和最近的 Edge 版本（通过 msedge 启动类型）。

后续步骤

如果你还没有阅读 Node.js 部分，请查看

Node.js - 包含示例应用程序的端到端 Node 场景

要查看有关 VS Code 中调试基础知识的教程，请查看此视频

VS Code 调试入门.

要了解有关 VS Code 的任务运行支持，请转到

任务 - 使用 Gulp、Grunt 和 Jake 运行任务。显示错误和警告

要编写自己的调试器扩展，请访问

调试器扩展 - 从模拟示例开始创建 VS Code 调试扩展的步骤

常见问题

如果我使用符号链接，可以进行调试吗？

可以，如果你为项目中的文件夹创建了符号链接，例如使用 npm link，你可以通过告诉 Node.js 运行时保留符号链接路径来调试符号链接的源。在你的启动配置 runtimeArgs 属性中使用 node.exe --preserve-symlinks 开关。runtimeArgs 是字符串数组，传递给调试会话运行时可执行文件，默认为 node.exe。

{
  "runtimeArgs": ["--preserve-symlinks"]
}

如果你的主脚本位于符号链接路径中，那么你还需要添加 "--preserve-symlinks-main" 选项。此选项仅在 Node 10+ 中可用。

如何调试 ECMAScript 模块？

如果你使用 esm 或将 --experimental-modules 传递给 Node.js 以使用 ECMAScript 模块，则可以通过 launch.json 的 runtimeArgs 属性传递这些选项

"runtimeArgs": ["--experimental-modules"] - 在 Node v8.5.0+ 中使用实验性 ECMAScript 模块支持
"runtimeArgs": ["-r", "esm"] - 使用 esm ES 模块加载器 (["-r esm"] 不带逗号将不起作用)

如何设置 NODE_OPTIONS？

调试器使用特殊的 NODE_OPTIONS 环境变量来设置与你的应用程序的调试，覆盖它将阻止调试正常工作。你应该附加到它而不是覆盖它。例如，.bashrc 文件可能包含如下内容

export NODE_OPTIONS="$NODE_OPTIONS --some-other-option=here"

02/06/2025