使用vscode调试编译后的js代码

发表于 分类于 阅读次数：

vscode 是一个非常棒的编辑器，内置功能强大的调试能力。经过简单的设定，就可以对 js 文件进行调试。但有时我们想要调试的内容是经过编译的，当然我们可以直接调试编译后的代码。但经过编译压缩以后的代码，可读性很差，且也可能无法分模块查看了，有什么方法进行编译前的代码调试么？答案当然是肯定的。

vscode 的常规调试

vscode 的调试界面在窗口最左边：

调试窗口

某些版本的vscode，该选项默认隐藏了，需要自己打开。

首次打开调试界面时，当前没有任何调试配置，我们可以点击齿轮 icon 添加一个：

添加调试配置

选择 Node.js 后，会自动在当前工程目录下添加 .vscode/launch.json 文件，这个文件就是 vscode 调试配置文件。

一个简易的配置文件内容为：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
    // 使用 IntelliSense 了解相关属性。 
    // 悬停以查看现有属性的描述。
    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "启动程序",
            "program": "${workspaceFolder}/index.js"
        }
    ]
}

上面这个配置所做的工作是启动当前目录下的 index.js 文件进行调试。

我们也可以设置每次摁 F5 时自动调试当前打开的文件，只需要修改 program：

1
2
3
{
    "program": "${file}"
}

调试编译后的文件

想要调试编译后的文件，需要对 launch.json 文件进行设置。

vscode 要想调试编译后的代码，他需要知道哪些代码是经过编译的，且需要知道编译后的代码与编译前代码的对应关系。

其实理论上 vscode 是可以把每个要执行的文件都认为是编译后的文件，进行源文件的查找？我猜是因为性能原因，我们需要自己指定哪些文件是编译后的文件。在 launch.json 中，使用outFiles属性来指定编译后的产出文件：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
    "version": "0.2.0",
    "configurations": [
        {
            // 省略其他设置...

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

            // ...
        }
    ]
}

虽然有些麻烦，但好在我们可以使用通配符。

现在有了编译后的文件，vscode 还需要知道源文件，以及编译后文件与源文件的对应关系，听着有没有很熟悉？这个过程就是通过 sourcemap 来进行实现的。

我们需要在编译 js 文件时生成相应的 .map 文件，并在产出 js 文件后面附加 .map 文件的地址：

1
//@ sourceMappingURL=./index.js.map

ok，现在 vscode 在执行 js 文件时，会从 outFile 中查找是否是编译后的代码，如果是，就通过 sourcemap 映射到源代码，方便我们进行调试。

自动执行编译

现在我们的开发流程变成了：修改源代码 -> 编译源代码 -> 调试。

为了方便，我们可以设置preLaunchTask属性，该属性的作用是每次调试前执行一个前置任务，我们可以把编译过程放在前置任务里。

首先我们需要来配置一个task，task的配置文件在 .vscode/tasks.json，可以打开 command palette (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 选择“任务：配置任务”自动生成一个：

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    // See https://go.microsoft.com/fwlink/?LinkId=733558
    // for the documentation about the tasks.json format
    "version": "2.0.0",
    "tasks": [
        {
            "label": "build",
            "type": "npm",
            "script": "build",
            "problemMatcher": []
        }
    ]
}

这里我们配置了npm run build作为前置任务，每次执行调试时都会先进行 build。

示例配置文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
    // 使用 IntelliSense 了解相关属性。 
    // 悬停以查看现有属性的描述。
    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "example",
            "program": "${workspaceFolder}/index.js",
            "preLaunchTask": "build",
            "cwd": "${workspaceFolder}",
            "outFiles": [
                "${workspaceFolder}/lib/*.js"
            ]
        }

相关文档