在前端开发中，测试是一个至关重要的环节。而 Allure 是一款基于 Java 的测试报告框架，可以让测试结果更加易读、易扩展和易维护。而 @types/allure-js-commons 就是针对 Allure 框架的 TypeScript 类型定义包。本文将为大家介绍如何使用 @types/allure-js-commons 包来简化 Allure 测试报告的生成。
安装
首先需要在你的项目中安装 @types/allure-js-commons。可以使用 npm 或者 yarn 来安装：
npm install --save-dev @types/allure-js-commons
或
yarn add --dev @types/allure-js-commons
安装完成后，在 TypeScript 代码中就可以直接引用 @types/allure-js-commons 包了。
开始使用
1. 引入包
在 TypeScript 代码中，需要先引入 @types/allure-js-commons 包。可以使用 import 语句来引入：
import { AllureRuntime } from 'allure-js-commons'2. 创建 AllureRuntime 实例
使用已经引入的 AllureRuntime，在代码中创建一个新的 AllureRuntime 实例：
const allureRuntime = new AllureRuntime({})这里我们传入了一个空对象，实际上可以传入一些配置选项，如：
const allureRuntime = new AllureRuntime({
resultDir: './allure-results',
testMapper: (path) => {
return { name: path.basename, fullName: path.name }
}
})这里传入了 resultDir 和 testMapper 选项来指定结果输出目录和测试结果映射方法。
3. 记录测试结果
Allure 测试报告的核心是记录测试结果。可以使用 AllureRuntime 实例提供的方法来记录测试结果。具体的 API 可以查看 TypeScript 类型定义文件。
allureRuntime.startStep('TestCase1')
// 执行测试逻辑
allureRuntime.endStep('passed')
allureRuntime.startStep('TestCase2')
// 执行测试逻辑
allureRuntime.endStep('failed')这里记录了两个测试用例，分别是 TestCase1 和 TestCase2，并且使用了 startStep 和 endStep 方法来标记测试步骤和测试结果。
4. 生成测试报告
在测试运行结束后，可以使用 AllureRuntime 实例提供的 generate 方法来生成测试报告：
await allureRuntime.generate()
这里使用 await 关键词等待测试报告生成完成后再执行下一步操作。
示例代码
下面是一个使用 @types/allure-js-commons 包记录测试结果的示例代码：
-- -------------------- ---- -------
------ - -------------- -------- - ---- -------------------
----- -------- ---------- -
----- ------------- - --- ---------------
---------- -------------------
--
----------------------------- ------- -----------
----------------------------- ---- ---
-- ------
--------------------------------------
----------------------------- ---- ---
-- ------
---------------------------------------
----------------------------- ---- ---
-- ------
--------------------------------------
----- ------------------------
-
----------这里使用了 startTest 和 endTest 方法来标记测试用例集的开始和结束；使用了 Category 枚举来标记测试结果的类型。
总结
使用 @types/allure-js-commons 包可以极大地简化使用 Allure 框架生成测试报告的过程。通过本文的介绍，希望可以帮助读者更加轻松地应用 Allure 框架来提升测试效率和质量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedc142b5cbfe1ea0611d37