[FE] 使用vscode调试npm scripts

1. 调试node.js

我们先来看看vscode如何调试node.js。

1.1 新建项目

$ mkdir vscode-debug
$ cd vscode-debug
$ npm init -f

1.2 新建index.js

console.log('hello');

1.3 打开vscode

用vscode打开vscode-debug文件夹,作为vscode资源管理的根目录

1.4 添加vscode配置

打开工具栏的“调试”菜单,然后点击“添加配置”。


vscode会让我们选择环境,这里我们选择“Node.js”。


vscode会自动在工程目录下创建一个 .vscode/launch.json 文件。

我们看到 .vscode/launch.jsonconfigurations.program属性为,

{
    ...
    "configurations": [
        {
            ...
            "program": "${workspaceFolder}/index.js"
        }
    ]
}

其中${workspaceFolder}/index.js表示了调试的入口,
workspaceFolder是vscode资源管理器的根目录,
因此,上文中我们强调了项目目录应当为资源管理器的根目录

1.5 启动调试

添加完调试配置之后,直接按F5,就可以启动调试了。
在此之前,记得去 index.js 文件中打个断点。

启动调试之后,程序就会停在断点处了,


2. 调试npm scripts

在实际项目中,好多命令放到了npm scritps中,
下面我们介绍调试npm scripts的办法。

2.1 添加npm scripts

{
  ...
  "scripts": {
    ...
    "debug": "node --inspect-brk=5858 index.js"
  },
  ...
}

其中,debug是npm scripts的名字,可以任取,
后面--inspect-brk=5858是必须的,其中5858是任意指定的调试端口号。

2.2 修改vscode调试配置

打开 .vscode/launch.json
增加以下3个配置项,runtimeExecutableruntimeArgsport

program配置项就可以删掉了,

"program": "${workspaceFolder}/index.js"
{
    ...
    "configurations": [
        {
            ...
            "runtimeExecutable": "npm",
            "runtimeArgs": [
                "run-script",
                "debug"
            ],
            "port": 5858
        }
    ]
}

其中,runtimeExecutable表示要使用的运行时,默认为node,这里我们配置成了npm
runtimeArgs的第二个参数,就是npm scripts的命令名,第一个参数run-script不要修改。
port指的是npm scripts中我们配置的--inspect-brk=5858调试端口号5858

2.3 启动调试

然后按F5,就可以启动调试了,
程序停到了 index.js 我们打的断点处。

3. 调试非node命令

3.1 node_modules/.bin

npm run会自动添加node_module/.bin 到当前命令所用的PATH变量中,
可参考npm-run-script

例如,如果我们配置了名为build的npm scripts,

{
  ...
  "scripts": {
    "build": "webpack"
  },
  ...
}

npm run build实际调用的是 node_modules/.bin/webpack

3.2 不能直接加 --inspect-brk

在这种情况下,直接加--inspect-brk=5858是不灵的。

{
  ...
  "scripts": {
    "debug": "webpack --inspect-brk=5858"
  },
  ...
}

以上配置,会自动执行npm run debug,但不会进入断点。

3.3 转换成node调用

{
  ...
  "scripts": {
    "debug": "node --inspect-brk=5858 ./node_modules/.bin/webpack"
  },
  ...
}

这次就启动成功了,这是因为--inspect-brk是node的参数,
我们需要将npm script中的命令改成node调用。

3.4 stopOnEntry

我们还可以设置 .vscode/launch.jsonconfigurations.stopOnEntry属性,
启动调试后会,会自动将断点停在代码的第一行。

{
    ...
    "configurations": [
        {
            ...
            "stopOnEntry": true,
        }
    ]
}

参考

Launch configuration support for 'npm' and other tools

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,053评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,527评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,779评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,685评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,699评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,609评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,989评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,654评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,890评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,634评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,716评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,394评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,976评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,950评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,191评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,849评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,458评论 2 342