使用 Visual Studio Code 调试 TypeScript + Jest

在 TypeScript + Jest 的项目中,如果写的测试代码触发了源码中的 bug ,那么就需要 debug 了。此时主要有两种 debug 工具:

  • 借助于 Chrome 开发者工具调试。
  • 使用 Visual Studio Code 内置的调试功能。

两种方式各有优缺点,第一种主要是操作界面很熟悉,毕竟平时前端开发就是直接在使用 Chrome 开发者工具,但是第一种方案只有在代码里面 import 了某个模块,才能在 Sources 标签下面找到那个文件。第二种主要是操作界面可能需要适应一段时间,但是文件还是很容易找到的。

本文主要介绍怎么配置第二种 debug 环境。

配置 Visual Studio Code 的 launch.json

  • 切换到 debug 界面。
image.png
  • 点击新建 launch.json 文件(该文件会存放在 <project root>/.vscode/launch.json 路径下)。
image.png
  • 选择调试类型为 node :
image.png
  • 修改生成的 launch.json 文件内容为:
{
    "version": "0.2.0",
    "configurations": [
        {
            // 调试类型是 node
            "type": "node",
            // 使用 launch 方式,另一种 attach 方式可用于调试已存在的 node 进程。
            "request": "launch",
            // 该调试配置的名称,主要用于在 select 控件里面选择本配置。
            "name": "test debug",
            // 类似于命令行参数
            "runtimeArgs": [
                "--inspect-brk",
                "${workspaceFolder}/node_modules/.bin/jest",
                "--runInBand"
            ],
            // node 的可执行程序
            "runtimeExecutable": "/usr/local/bin/node",
            // 使用什么终端工具。integratedTerminal 表示使用 Visual Studio Code 内置的终端工具,也可以配置成使用操作系统默认的终端工具。
            "console": "integratedTerminal",
            // 打开 console 的时机。这个 console 类似于 Chrome 开发者工具 console 的作用。
            "internalConsoleOptions": "openOnSessionStart"
        }
    ]
}

一般来说,在启动调试的时候遇到 Cannot find runtime 'node' on PATH. 的时候,才去配置 runtimeExecutable ,或者实在想用某个特定版本的 node 的时候。

对于上面的配置,启动程序的时候,相当于运行 node --inspect-brk ${workspaceFolder}/node_modules/.bin/jest --runInBand--runInBank 是 Jest 特有的配置,默认情况下, Jest 是会使用子进程池去运行测试代码的,这种多进程方式不利于 debug ,因此在 debug 的时候要使用 --runInBank 去关闭 Jest 的多进程模式。

配置 Jest

在 package.json 中添加 Jest 配置:

{
  ...
  "jest": {
    // 对于 ts 代码和当前 node 还不支持的 js 代码,需要使用相应的转换器转换一下
    "transform": {
      // 使用 ts-jest 转换 ts 代码。 ts 文件路径匹配 "^.+\\.tsx?$" 的,才会被转换。
      "^.+\\.tsx?$": "ts-jest",
      // 使用 babel-jest 转换 js 代码。 js 文件路径匹配 "^.+\\.jsx?$" 的,才会被转换。
      "^.+\\.jsx?$": "babel-jest"
    },
    // 转换过程中,需要被忽略的文件。
    "transformIgnorePatterns": [
      "<rootDir>/node_modules/(moment|core-js|babel-runtime|regenerator-runtime|lodash)/"
    ],
    // 是否搜集单测覆盖率信息。
    "collectCoverage": false,
    // 匹配单测 spec 文件。
    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(tsx?)$",
     // 支持的源码后缀名。
    "moduleFileExtensions": [
      "ts",
      "js"
    ],
    "globals": {
      "ts-jest": {
        // 过了 ts-jest 转换器,就不要过 babel 转换器了。
        "skipBabel": true
      }
    },
    "testPathIgnorePatterns": [
      "/(node_modules|lib|coverage|types)/"
    ]
  }
  ...
}

推荐默认关掉单测覆盖率信息搜集: collectCoverage: false ,然后在 package.json 中配置如下 scripts :

{
  ...
  "scripts": {
    "test": "jest --coverage",
    "test-debug": "node --inspect-brk node_modules/.bin/jest --runInBand"
  }
  ...
}

其中 npm run test 用于跑正式的测试代码,此时是需要生成覆盖率报告的。而在对测试过程进行 debug 的时候,是不需要生成覆盖率报告的:为了生成覆盖率报告,要在源码中插入很多代码,然后默认又不会正确处理 Source Map ,因此会造成 debug 的时候将转换后的代码映射到源码会出现问题。

ts-jest 默认情况下会自动查找 tsconfig.json 配置,查找逻辑为:从当前待转换源码文件所在目录为起始目录,依次往上找(包括当前目录) tsconfig.json 配置文件。

babel-jest 寻找 .babelrc 配置文件的逻辑与 ts-jest 的类似。 .babelrc 中配置好测试环境就行了:

{
    "env": {
        "test": {
            "presets": ["env", "stage-2"],
            "plugins": [
                "istanbul",
                [
                    "transform-runtime",
                    {
                        "polyfill": false,
                        "regenerator": false
                    }
                ]
            ]
        }
    }
}

安装依赖

安装如下依赖:

npm run @types/jest jest babel-plugin-transform-runtime babel-preset-env babel-preset-stage-2 ts-jest typescript -D

testEnvironment

Jest 默认在 jsdom 跑测试代码, jsdom 是一个在 js 中模拟 DOM 环境的库,少不了存在一些缺陷,比如 getComputedStyle 不会将 CSS 中 rule 的缩略写法扩展成完整写法,因此在某些条件下会有一些问题,这个时候,如果能全局 mock 掉这些问题就关系不大,如果不能 mock ,就只能切换执行测试代码的环境了。不过对于大多数场景来说, jsdom 还是够用的。

debug 测试

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

推荐阅读更多精彩内容