VS Code中TypeScript、nodemon与外部项目的调试问题排查

问题概述 #

调试Node.js server项目时，server和common-internal项目的TypeScript文件可正常设置断点并调试，但common-external项目的断点始终无法绑定，VS Code提示找不到对应源码。

项目结构 #

root folder
- test-app
  - .vscode
  - common-internal
  - server
- common-external
  - .vscode
  - common-external

注：test-app为独立Git仓库，common-external为单独Git仓库。

Server项目依赖配置 #

"dependencies": {
    "common-internal": "file:../common-internal",
    "common-external": "file:../../common-external/common-external",
    "express": "4.18.2"
}

复现步骤 #

1. 克隆仓库
2. 运行common-internal、common-external和server的初始化任务
3. 运行common-internal和common-external的监听任务
4. 启动server任务
5. 通过附加进程启动调试器
6. 在server/src/index.ts设置断点（正常工作）
7. 在common-internal/src/utils.ts设置断点（正常工作）
8. 在common-external/src/external-utils.ts设置断点（无法工作）

问题原因 #

核心是跨仓库的文件夹层级导致Source Map路径映射失效：

• common-external位于test-app仓库的上级目录之外，VS Code调试器默认的路径映射范围仅覆盖当前工作区（test-app），无法识别外部目录的源码路径
• common-external编译生成的Source Map中，源码路径多为相对路径，调试器无法将其解析到实际的外部仓库源码位置

解决方案 #

1. 调整common-external的TypeScript配置 #

确保common-external/tsconfig.json开启Source Map并配置正确路径：

{
  "compilerOptions": {
    "sourceMap": true,
    "sourceRoot": "./src",
    // 其他原有配置...
  }
}

2. 修改Server的调试配置 #

在test-app/.vscode/launch.json中添加sourceMapPathOverrides，将common-external的编译产物路径映射到实际源码路径：

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "attach",
      "name": "Attach to Server",
      "skipFiles": ["<node_internals>/**"],
      "sourceMapPathOverrides": {
        "../../common-external/common-external/dist/*": "${workspaceFolder}/../../common-external/common-external/src/*",
        "../common-internal/dist/*": "${workspaceFolder}/../common-internal/src/*"
      }
    }
  ]
}

3. 将common-external加入VS Code工作区 #

通过文件 > 将文件夹添加到工作区，把common-external文件夹加入当前工作区，确保VS Code能索引到外部仓库的源码文件，让调试器可直接关联断点。

验证步骤 #

修改配置后，重启监听任务和server，重新附加调试器，尝试在common-external/src/external-utils.ts设置断点，确认是否正常触发。

内容的提问来源于stack exchange，提问作者snotmare