Jest 安装和配置

Jest 安装

由于我们的项目是使用 typescript-library-starter 初始化的，已经内置了 Jest 的安装，但是安装的版本却不是最新的，我们可以对 package.json 中的相关依赖版本做修改，重新安装。

  1. {
  2.   "@types/jest": "^24.0.13",
  3.   "jest": "^24.8.0",
  4.   "jest-config": "^24.8.0",
  5.   "ts-jest": "^24.0.2",
  6.   "typescript": "^3.4.5"
  7. }

注意，这里都是目前最新的版本，未来如果有版本升级的话，可以自行更新到最新版本。

更改版本后，在命令行再次执行 npm install 即可安装到相应版本。

Jest 配置

在 package.json 文件中有 jest 字段，对应 Jest 配置：

  1. "jest": {
  2.   "transform": {
  3.     ".(ts|tsx)": "ts-jest"
  4.   },
  5.   "testEnvironment": "jsdom",
  6.   "testRegex": "/test/.*\\.(test|spec)\\.(ts)$",
  7.   "moduleFileExtensions": [
  8.     "ts",
  9.     "tsx",
  10.     "js"
  11.   ],
  12.   "coverageThreshold": {
  13.     "global": {
  14.       "branches": 90,
  15.       "functions": 95,
  16.       "lines": 95,
  17.       "statements": 95
  18.     }
  19.   },
  20.   "collectCoverageFrom": [
  21.     "src/*.{js,ts}",
  22.     "src/**/*.{js,ts}"
  23.   ],
  24.   "setupFilesAfterEnv": [
  25.     "<rootDir>/test/boot.ts"
  26.   ]
  27. },

接下来，我们就分别来看这几个配置的含义。

简单地说就是一种转换器配置，比如我们这里的 

  1. "transform": {
  2.   ".(ts|tsx)": "ts-jest"
  3. },

表示的就是使用 ts-jest 工具把 .ts 和 .tsx 文件内容转换成 JavaScript，因为我们也是使用 TypeScript 编写测试代码，而 Node.js 是不能直接支持 TypeScript 的，所以需要配置转换器。

测试环境。

  1. "testEnvironment": "jsdom"

表示它是一个类浏览器的测试环境，我们可以使用浏览器环境中的一些 API。

要测试文件的正则表达式。

  1. "testRegex": "/test/.*\\.(test|spec)\\.(ts)$"

表示 test 目录下所有以 .test.ts 和 .spec.ts 的文件都需要跑测试。

模块文件扩展名，当你去引入一个模块并没有指定扩展名的时候，它会依次尝试去添加这些扩展名去找你引入的模块文件。

  1. "moduleFileExtensions": [
  2.   "ts",
  3.   "tsx",
  4.   "js"
  5. ]

表示优先找 .ts 的模块、然后是 .tsx，最后是 .js。

测试覆盖率的阈值设定，当我们的测试覆盖率达不到阈值的时候，测试会失败。

  1. "coverageThreshold": {
  2.   "global": {
  3.     "branches": 90,
  4.     "functions": 95,
  5.     "lines": 95,
  6.     "statements": 95
  7.   }
  8. }

表示全局的代码分支覆盖率要达到 90%，方法覆盖率要达到 95%，代码行数覆盖率达到 95%，声明覆盖率达到 95%。

收集指定文件的测试覆盖率(即使你没为这些文件编写测试)，它的值为 glob patterns 类型。

  1. "collectCoverageFrom": [
  2.   "src/*.{js,ts}",
  3.   "src/**/*.{js,ts}"
  4. ]

表示收集 src 目录以及它的所有子目录中的 js 和 ts 文件的测试覆盖率。

测试框架安装后立即执行的代码文件列表。

  1. "setupFilesAfterEnv": [
  2.   "<rootDir>/test/boot.ts"
  3. ]

表示每次跑具体测试代码之前会先运行 <rootDir>/test/boot.ts 中的代码，<rootDir> 表示当前项目的根目录。这个配置在之后的章节我们会具体介绍。

其他关于 Jest 的配置，感兴趣的同学可以去官网做扩展学习。

至此，我们学习了 Jest 的安装和配置，下节课我们就开始编写 ts-axios 库的单元测试。