**这是本文档旧的修订版!**
WebStorm 调试 TypeScript
一句话原则:断点永远打在 .ts 源码上,真正执行的是编译后的 JS,靠 source map 把两边对上。
零、前置准备
- 装好 Node.js(
node -v、npm -v能输出版本) - 项目里装依赖:
npm i -D typescript ts-node # ESM 项目更省事的选择 npm i -D tsx
tsconfig.json必须打开sourceMap:
{
"compilerOptions": {
"target": "ES2022",
"module": "commonjs",
"rootDir": "src",
"outDir": "dist",
"sourceMap": true,
"strict": true
},
"include": ["src"]
}
sourceMap 没开,后面所有步骤都会变成“断点打了但停不下来”。
一、方式 A:直接调试 .ts 文件(推荐)
让 ts-node / tsx 在运行时就地编译,不用手动 build。
- 右上角运行配置下拉框 →
Edit Configurations…→+→Node.js - 关键字段:
| 字段 | 填写内容 |
|---|---|
| Name | debug index |
| Node interpreter | 默认的 node |
| JavaScript file | src/index.ts(直接选 .ts 文件) |
| Application parameters | 传给脚本的参数,如 –env dev |
| Working directory | 项目根目录 |
| Node parameters | CommonJS 项目:–require ts-node/register;ESM 项目:–import tsx(Node 20+)或 –loader ts-node/esm |
| Environment variables | 按需补充 |
- 点
Debug按钮(绿色小虫子,Windows 快捷键Shift+F9,macOS 用Ctrl+D) - 在
src/index.ts的行号左侧点一下,打上红点断点
更快的路径:编辑器里右键 .ts 文件 → Debug 'index.ts',WebStorm 会自动生成上面的配置(首次会提示装 ts-node)。
二、方式 B:先编译再调试 JS(最稳)
适合 ts-node 在 ESM 下反复报错、或者你本来就依赖构建产物的情况。
- 先编译:
npx tsc(或 npm scriptbuild) - 新建 Node.js 运行配置,
JavaScript file选dist/index.js - 断点仍然打在
.ts源码里 —— sourceMap 开着就能停住 - 改代码后要重新编译:开一个常驻终端跑
npx tsc -w,或在配置的Before launch里加一个 tsc 任务
如果单步跳到了 dist/xxx.js 里,说明 sourceMap 没生效或者产物过期,回第零步检查。
三、方式 C:前端项目(Vite / webpack + 浏览器)
浏览器里跑的 TS(React、Vue 等)用 JavaScript Debug 配置:
- 先在 Terminal 起开发服务器:
npm run dev(假设是 http://localhost:5173) Edit Configurations…→+→JavaScript Debug- URL 填
http://localhost:5173 - 点 Debug,WebStorm 拉起浏览器,
.ts/.tsx里的断点直接生效 - Vite 开发模式自带 sourcemap;生产构建排查要开
build.sourcemap = true
四、同时跑多个 npm run dev
手上好几个项目,每个都要常驻一个 dev server 时,按下面由简到繁选一种。
4.1 先给每个项目固定端口
Vite / Next 发现端口被占会自动换一个端口,结果你调试的 URL 和实际端口对不上。所以第一步是把端口钉死:
| 项目 | 固定端口的方式 |
|---|---|
| Vite | vite.config.ts 里 server.port: 5174,或 npm run dev – –port 5174 |
| Next.js | next dev -p 3001 |
| Vue CLI | npm run serve – –port 8081 |
| CRA | 环境变量 PORT=8081(Windows 下用 cross-env 保证跨平台) |
4.2 方案一:多开 Terminal 标签
最简单,适合临时跑两三个项目。底部 Terminal 窗口标签栏点 + 新建标签,一个标签盯一个项目:
# 标签 1 cd ~/code/site-a && npm run dev # 标签 2 cd ~/code/site-b && npm run dev -- --port 5174
缺点是终端一关就得重新敲,标签开多了也容易看错目录 —— 项目固定的话往下走。
4.3 方案二:每个项目一个 npm 运行配置
- 打开项目 A 的
package.json,scripts里dev左边有绿色三角,点它 →Run 'dev' 或Debug 'dev' - WebStorm 会自动建一个 npm 配置:
Package.json指向 A、Command是dev、工作目录也是 A - 到 B、C 项目里各重复一次
- 之后在右上角下拉框里切换、点 Run,几个站点互不干扰地各起一个
好处是运行配置记住了各自的工作目录,不用再 cd;配一次一直能用。
注意别把不同项目的 ''.env'' 或端口串在一起。
4.4 方案三:Compound 一键启动全部
Edit Configurations… → + → Compound,把上面几个配置都勾进去,之后点一次 Run/Debug 就全部起来。想要并发分组、自定义启动顺序,可以再装第三方插件 Multirun。
4.5 方案四:一个终端一条命令全跑
项目路径固定、只想省事就选这个。在任意一个总目录里建 package.json,用 concurrently:
npm i -D concurrently
{
"scripts": {
"dev": "concurrently -n web,admin,api -c blue,magenta,green \"npm:dev:web\" \"npm:dev:admin\" \"npm:dev:api\"",
"dev:web": "npm --prefix ../web run dev",
"dev:admin": "npm --prefix ../admin run dev -- --port 5174",
"dev:api": "npm --prefix ../api run dev"
}
}
-n给每行日志加前缀(web / admin / api),-c上色,一眼看出是哪个站点在输出npm –prefix ../web run dev等价于先cd再跑,跨平台不用写cd- 等价替代:
npm-run-all –parallel dev:* Ctrl+C一次全停,这是它比多标签最省事的地方
4.6 同时调试多个 dev server
每个站点配一个 JavaScript Debug 配置(见第三节),URL 填各自的端口:
- site-a →
http://localhost:5173 - site-b →
http://localhost:5174
只要端口不冲突、sourcemap 正常,这些调试会话可以同时挂着,断点各停各的,互不干扰。
五、调试技巧
- 条件断点:右键已打的断点 →
Condition填i === 5,只在条件成立时停 - Logpoint(日志断点):右键断点 → 取消
Suspend,勾上Evaluate and log,写处理到 ${id}—— 只打印不暂停,适合循环里看值 - Variables 面板:看当前作用域的局部变量与闭包
- Watches:把关键表达式固定进来,单步时实时刷新
- Evaluate Expression(
Alt+F8):调试中执行任意表达式,也能临时改状态 - Console 面板:同样可以跑代码、看输出
- 行内值提示:单步后行尾会直接显示变量当前值
Mute Breakpoints:一键静音所有断点,位置保留
调试控制键(Windows / 括号内为 macOS):
| 操作 | 快捷键 |
|---|---|
| Run | Shift+F10(Ctrl+R) |
| Debug | Shift+F9(Ctrl+D) |
| Step Over 单步跳过 | F8 |
| Step Into 进入函数 | F7 |
| Step Out 跳出函数 | Shift+F8 |
| Resume 继续运行 | F9 |
| Evaluate Expression | Alt+F8 |
六、常见坑
- 断点是灰色/空心的:该行没有可执行代码,或文件没被编译进去。检查
include、rootDir,确认 ts-node 真的启用了 - 断点打在 .ts 却停在 .js:
sourceMap没开,或产物没重新编译 - 路径别名 @/xxx 报错:ts-node 要配
tsconfig-paths:
npm i -D tsconfig-paths # 然后在 Node parameters 里追加 -r tsconfig-paths/register
“type”: “module”下 ts-node 各种报错:别硬刚,换tsx,Node parameters 写–import tsx- 找不到配置文件、相对路径错乱:把运行配置里的
Working directory设为项目根目录 - 改了代码没生效:方式 B 是编译型的,记得重新 build 或开
tsc -w EADDRINUSE: address already in use:端口被另一个项目的 dev server 占了。先按 4.1 给每个项目固定不同端口;想知道是谁占的,用lsof -i :5173(macOS/Linux)或netstat -ano | findstr :5173(Windows)
参考:第二十一章_调试
# WebStorm 调试 TypeScript ## 前置准备 ### 安装 Node.js ### tsconfig 开启 sourceMap ### 装 ts-node 或 tsx ## 方式 A 直跑 .ts ### Node.js 运行配置 ### JavaScript file 选 .ts ### Node parameters 加 --require ts-node/register ## 方式 B 编译后调 JS ### tsc 产出 dist ### 断点仍打在 .ts ### 配合 tsc -w ## 方式 C 浏览器调试 ### JavaScript Debug 配置 ### URL 填 dev server 地址 ### Vite 开发模式自带 sourcemap ## 同时跑多个 dev server ### 先给各项目固定端口 ### 方案一 多开 Terminal 标签 ### 方案二 每项目一个 npm 运行配置 ### 方案三 Compound 一键启动全部 ### 方案四 concurrently 一条命令全跑 ### 每站一个 JavaScript Debug 配置 ## 调试技巧 - 条件断点 Condition - Logpoint 只打印不暂停 - Variables 与 Watches - Evaluate Expression - Mute Breakpoints ## 常见坑 - 断点灰色 = 该行无可执行代码 - 停在 .js = sourceMap 未生效 - 别名 @ 报错 = 加 tsconfig-paths - ESM 报错 = 换 tsx - 路径错乱 = 改 Working directory - EADDRINUSE = 端口被别的项目占用