# @codeceptjs/allure-legacy 中文文档

规范地址：https://npmcn.com/package/%40codeceptjs/allure-legacy/

版本：1\.0\.2
npm 元数据更新时间：2026-10-21T10:26:25.048Z
中文译文更新时间：2026-11-10T06:22:14.266Z
软件包许可：ISC

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40codeceptjs/allure-legacy
原文对照：https://npmcn.com/package/%40codeceptjs/allure-legacy/?lang=original
项目主页：https://github.com/codeceptjs/allure-plugin#readme
源码仓库：https://github.com/codeceptjs/allure-plugin

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：16 kB，3 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2023-02-15T01:38:01.484Z
- 最新版本发布：2023-02-15T12:19:19.887Z
- 近 30 天下载量：71120（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

CodeceptJS 的取色插件

## 安装

```sh
npm install @codeceptjs/allure-legacy
```

也可以使用：`pnpm add @codeceptjs/allure-legacy`、`yarn add @codeceptjs/allure-legacy`、`bun add @codeceptjs/allure-legacy`

## README

# 调色器插件

通过 contact-commons v1 为 CodeceptJS 添加了 Alure 插件

> **3⁄4 ̄ ̧漯B** 这个插件在"CodeceptJS"中被贬值了,因为"诱因-通俗"v1不再被维持了. 文档和源代码被移入了这个寄存器. 此时此刻,我们不打算将其迁移到Allure v2,但是社区可以创建自己的执行

启用 Allure 记者 .

#### 使用量

开始请安装 `allure-commandline` 软件包(需要Java 8)

```
npm install -g allure-commandline --save-dev
```

将此插件添加到配置文件 :

```js
plugins: {
  allure: {
    enabled: true,
    require: '@codeceptjs/allure-legacy',
  }
}
```

默认情况下,引出报告将被保存到 `output` 目录. 启动 Allure 服务器, 并在上面的截图上看到报告:

```
allure serve output
```

#### 配置

-   `outputDir` - 应储存诱饵报告的目录。 标准输出目录默认设置.
-   `enableScreenshotDiffPlugin` - 用于添加截图 diff 的布尔旗. 要附加,tou需要附加三个文件到报告上——"diff.png","actual.png","expected.png". 见 [显示屏幕截图插件](https://github.com/allure-framework/allure2/blob/master/plugins/screen-diff-plugin/README.md)

#### 公共 API

从其他插件可以访问的公共API方法很少.

```js
const allure = codeceptjs.container.plugins('allure');
```

`allure` 对象有下列方法:

-   `addAttachment(name, buffer, type)` - 在当前测试/套件中添加附件
-   `addLabel(name, value)` - 在当前测试中添加标签
-   `addParameter(kind, name, value)` - 在当前测试中添加参数
-   `createStep(name, stepFunc)` - 创建一个步骤,步骤Func可以包含一个附件 使用实例:

```js
    allure.createStep('New created step', () => {
      allure.addAttachment(
        'Request params',
        '{"clientId":123, "name":"Tom", "age":29}',
        'application/json'
      );
    });
```

![Created Step Image](https://user-images.githubusercontent.com/63167966/139339384-e6e70a62-3638-406d-a224-f32473071428.png)

-   `addScreenDiff(name, expectedImg, actualImg, diffImg)` - 在当前测试中添加一个特殊的屏幕 diff 块 图像必须是代表以 base64 编码的预期图像文件内容的字符串 使用实例:

```js
const expectedImg = fs.readFileSync('expectedImg.png', { encoding: 'base64' });
...
allure.addScreenDiff('Screen Diff', expectedImg, actualImg, diffImg);
```

![Overlay](https://user-images.githubusercontent.com/63167966/215404458-9a325668-819e-4289-9b42-5807c49ebddb.png) ![Diff](https://user-images.githubusercontent.com/63167966/215404645-73b09da0-9e6d-4352-a123-80c22f7014cd.png)

-   `severity(value)` - 增加重度标签
-   `epic(value)` - 添加史诗标签
-   `feature(value)` - 添加特性标签
-   `story(value)` - 添加故事标签
-   `issue(value)` - 添加问题标签
-   `setDescription(description, type)` - 设定描述

## 添加附件

在当前测试例中添加附件

### 参数

-   `name` **\[弦 \[1\]** 附件名称
-   `buffer` **\[负担\]\[2\]** 附件缓冲
-   `type` **\[弦 \[1\]** 附件的 MIME 类型

## 添加标签

向当前测试报告添加带有给定名称和值的标签

### 参数

-   `name` **\[弦 \[1\]** 要添加的标签名称
-   `value` **\[弦 \[1\]** 要添加的标签值

## 添加页

向当前测试报告添加带有给定类型、名称和值的参数

### 参数

-   `kind` **\[弦 \[1\]** 要添加的参数类型
-   `name` **\[弦 \[1\]** 要添加的参数名称
-   `value` **\[弦 \[1\]** 要添加的参数值

## 添加Screen Diff 数据

为当前测试大小写添加一个特殊的屏幕 diff 块

### 参数

-   `name` **\[弦 \[1\]** 屏幕 diff 块的名称
-   `expectedImg` **\[弦 \[1\]** 字符串代表以 base64 编码的预期图像文件的内容
-   `actualImg` **\[弦 \[1\]** 代表实际图像文件内容的字符串, 编码为 base64
-   `diffImg` **\[弦 \[1\]** 代表被编码为 base64 的 diff 图像文件内容的字符串 . 可以通过图像比较 lib 生成, 如“ 像素匹配” 或替代

## 创建步骤

一种在测试中创建步骤的方法.

### 参数

-   `name` **\[弦 \[1\]** 阶之名.
-   `stepFunc` **\[功能\]\[3\]** 此步骤应执行的函数 。 (可选,默认) `()=>{}`(中文(简体) )

回返 **任意** 分步函数的结果.

## 设置

设置当前测试大小写的说明

### 参数

-   `description` **\[弦 \[1\]** 测试案例说明
-   `type` **\[弦 \[1\]** 描述的 MIME 类型( 可选, 默认) `'text/plain'`(中文(简体) )

## 诱惑

调味记者

\[4\]

### 参数

-   `config`

## 诱惑

创建诱饵记录器实例

### 参数

-   `config` **配置** 诱饵记者配置( 可选, 默认) `{outputDir:global.output_dir}`(中文(简体) )

回返 **\[标 \[9\]** 诱惑记者的例子

## 常见问题

### @codeceptjs/allure-legacy 是什么？

CodeceptJS 的取色插件

### 如何安装 @codeceptjs/allure-legacy？

在项目目录运行 npm install @codeceptjs/allure-legacy，或使用 pnpm add / yarn add / bun add。

### @codeceptjs/allure-legacy 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/codeceptjs\_\_allure-legacy 是否存在。

### @codeceptjs/allure-legacy 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @codeceptjs/allure-legacy 可以商用吗？

@codeceptjs/allure-legacy 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @codeceptjs/allure-legacy 的下载量有多少？

根据 npm 官方下载统计，@codeceptjs/allure-legacy 在 2026/10/10 – 2026/11/08 这 30 天内被下载 71,120 次，日均约 2,371 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @codeceptjs/allure-legacy 还在维护吗？

最新版本 1\.0\.2 发布于 2023/02/15（3 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/02/15。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。