Jest 在 TypeScript 下的使用

阅读时长 4 分钟读完

Jest 是一个流行的 JavaScript 测试框架,它提供了简单易用的 API 和强大的断言功能。在 TypeScript 项目中使用 Jest 可以帮助我们更好地测试代码,提高代码质量和可维护性。

安装 Jest

在使用 Jest 之前,需要先安装它。可以使用 npm 或 yarn 安装 Jest:

使用 Jest

编写测试用例

使用 Jest 编写测试用例非常简单,只需要创建一个以 .test.ts.spec.ts 结尾的文件,然后在文件中定义测试用例。

例如,我们有一个叫 sum.ts 的模块,它导出了一个 sum 函数,用于计算两个数的和。我们可以创建一个 sum.test.ts 文件,编写测试用例:

-- -------------------- ---- -------
------ - --- - ---- --------

---------- - - - -- ----- --- -- -- -
  ------------- ------------
---

---------- - - - -- ----- --- -- -- -
  ------------- ------------
---

在测试用例中,我们使用 test 函数定义一个测试用例,第一个参数是测试用例的描述,第二个参数是测试用例的具体实现。在实现中,我们使用 expect 函数和一些断言方法来判断测试是否通过。

运行测试

编写好测试用例后,我们需要运行测试来验证代码的正确性。可以使用以下命令运行 Jest:

Jest 会自动查找项目中的测试文件,并运行其中的测试用例。测试结果会在控制台中输出。

配置 Jest

Jest 默认会查找项目中所有以 .test.ts.spec.ts 结尾的文件,并运行其中的测试用例。如果需要更改 Jest 的配置,可以在项目根目录下创建一个 jest.config.js 文件,并在其中定义配置项。

例如,我们可以将 Jest 的测试文件扩展名更改为 .test.tsx

更多 Jest 配置项可以参考官方文档

TypeScript 支持

Jest 默认不支持 TypeScript,但是可以通过安装 ts-jest 来使其支持 TypeScript。

首先需要安装 ts-jest

然后在 jest.config.js 文件中添加以下配置:

preset 配置项指定了 Jest 使用的预设,这里使用了 ts-jest 预设。testEnvironment 配置项指定了测试环境,这里使用了 Node.js 环境。

示例代码

下面是一个完整的 TypeScript + Jest 示例代码:

-- -------------------- ---- -------
-- ------
------ -------- ------ ------- -- -------- ------ -
  ------ - - --
-

-- -----------
------ - --- - ---- --------

---------- - - - -- ----- --- -- -- -
  ------------- ------------
---

---------- - - - -- ----- --- -- -- -
  ------------- ------------
---

-- --------------
-------------- - -
  ------- ----------
  ---------------- -------
--

总结

Jest 是一个功能强大、易于使用的 JavaScript 测试框架,它支持 TypeScript,并且具有丰富的配置选项。在 TypeScript 项目中使用 Jest 可以帮助我们更好地测试代码,提高代码质量和可维护性。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/65cb1ac9add4f0e0ff4dd98c

纠错
反馈