在 TypeScript 项目中使用 Jest 进行单元测试-JavaScript中文网-JavaScript教程资源分享门户

在 TypeScript 项目中使用 Jest 进行单元测试

Jest 是一种流行的 JavaScript 单元测试框架，它提供了丰富的功能和易用的 API。在 TypeScript 项目中使用 Jest 进行单元测试可以帮助我们确保代码的正确性和可维护性，同时也可以提高我们的代码质量。在本文中，我们将介绍如何在 TypeScript 项目中使用 Jest 进行单元测试，并提供了示例代码和指导意义。

步骤一：安装 Jest 和相关库

首先，我们需要使用 npm 或 yarn 安装 Jest 和相关库。可以使用以下命令：

npm install --save-dev jest @types/jest ts-jest

或者：

yarn add --dev jest @types/jest ts-jest

Jest 是主要的测试框架，@types/jest 是 TypeScript 对 Jest 的类型定义文件，ts-jest 是将 TypeScript 代码编译为 JavaScript 代码的 Jest 插件。

步骤二：配置 Jest

我们需要在项目中创建一个 jest.config.js 文件，并对 Jest 进行配置。以下是一个基本的配置文件示例：

module.exports = {
  roots: ['<rootDir>/src'],
  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
  transform: {
    '^.+\\.tsx?$': 'ts-jest',
  },
};

这个配置文件告诉 Jest 应该在哪些目录中查找测试文件，使用哪种正则表达式匹配测试文件的文件名，使用哪些文件扩展名，以及如何使用 ts-jest 将 TypeScript 代码编译为 JavaScript 代码。更详细的 Jest 配置可以在 Jest 文档中找到。

步骤三：编写测试代码

现在，我们可以开始编写测试代码了。我们可以在项目中的任何地方创建一个 tests 目录，并在其中编写测试代码。例如，我们可以编写一个简单的 add 函数，并测试其是否正确的执行了加法操作：

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

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

描述函数 add，it 函数代表一个测试用例，expect 函数代表一个断言，它判断函数返回的结果是否等于预期的结果。在这个测试代码中，我们期望 add(1, 2) 返回 3，并使用 toBe 函数判断实际结果是否等于预期结果。

步骤四：运行测试

当我们编写完测试代码后，可以运行 Jest 来执行测试。可以使用下面命令：

jest

此命令将在控制台中报告测试结果。如果测试通过，结果为 “PASS”，否则为 “FAIL”。

步骤五：持续集成

对于一个开发团队，持续集成是至关重要的。我们可以使用像 Travis CI 或者 GitHub Actions 这样的 CI/CD 工具自动执行测试。为了在持续集成过程中执行 Jest 测试，我们需要更新项目的配置。以下是一个基本的 .travis.yml 文件配置示例：

language: node_js
node_js: 
  - "14"
script:
  - npm test

这个配置文件告诉 Travis CI，它应该使用 Node.js 版本 14 ，并且在执行脚本时使用 npm test 命令来运行 Jest 测试。

结论

使用 Jest 进行 TypeScript 项目中的单元测试提高了代码质量和可维护性，可以更好地保证代码正确性，并加速迭代周期。本文提供了完整的步骤和示例代码，指导你如何配置 Jest 并编写测试代码。希望可以帮助你加强对 Jest 的理解并在项目中实践。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/67161852ad1e889fe21abb47