# @applitools/testgenai-cypress 中文文档

规范地址：https://npmcn.com/package/%40applitools/testgenai-cypress/

版本：0\.8\.23
npm 元数据更新时间：2026-06-28T14:45:21.638Z
中文译文更新时间：2026-11-06T11:52:40.895Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40applitools/testgenai-cypress
原文对照：https://npmcn.com/package/%40applitools/testgenai-cypress/?lang=original

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

- 包体积（解压后）：2.9 MB，314 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2024-06-13T18:58:17.174Z
- 最新版本发布：2025-04-01T15:27:46.649Z
- 近 30 天下载量：4545（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 0 个）

## 中文简介

Applitools TestGenAI使技术和非技术小组成员能够有效地扩大测试范围。 这种包容性使非技术参与者能够进行测试自动化,帮助更有效地分配整个系统的工作量

## 安装

```sh
npm install @applitools/testgenai-cypress
```

也可以使用：`pnpm add @applitools/testgenai-cypress`、`yarn add @applitools/testgenai-cypress`、`bun add @applitools/testgenai-cypress`

## README

# Cypress 的 Applitools 测试GenAI 插件

Applitools TestGenAI使技术和非技术小组成员能够有效地扩大测试范围。 这种包容性使非技术参与者能够进行测试自动化,有助于更有效地在整个团队中分配工作量.

TestGenAI 的好处:

-   节省时间: 它快速记录用户动作,生成测试例而无需为每个步骤写手动代码.
-   自发自愈与强健试验: 该工具将填表等平庸任务自动化,并提供了改善生成的测试代码整体质量的便利设施,使测试更加坚固并随着时间推移易于维护.
-   现代测试覆盖:快速在使用Cypress的代码中创建现代测试覆盖,其中包含了行业上的最佳做法并允许从现有的测试实施,如Selenium,轻松地向Cypress迁移.
-   便利非发展中国家参与测试自动化,有效分配测试创建工作量.
-   自动重用变量生成 .
-   Page Object Model 生成可以使代码更有效率,测试更可读.

如果你有任何问题,请访问我们 [文档](https://applitools.com/docs/testgenai/) 或者联系我们 [支持@applitools.com](mailto:support@applitools.com)

## 开始

### 安装

```bash
npm install @applitools/testgenai-cypress
```

### 初始设置

#### 备选案文1:自动设置

您可以通过运行自动配置 TestGenAI 插件 :

```bash
npx @applitools/testgenai-cypress init
```

#### 备选案文2:手动设置

如果您喜欢手动设置或遇到自动配置的问题 :

1.  添加到您的 `cypress/support/e2e.js`数字 :

```js
import '@applitools/testgenai-cypress/commands'
```

2.  添加到您的 `cypress.config.js`数字 :

```js
const { testGenAICypressTasksSetup } = require("@applitools/testgenai-cypress/tasks");

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      testGenAICypressTasksSetup(on)
    },
  },
});
```

3.  创建所需的目录 :
    -   创建一个 `testgenai` cypress 目录中的文件夹
    -   内部 `testgenai`,创建两个文件夹: `autoheal` 财务报告和审定财务报表 `POMs`
    -   最后结构: `./cypress/testgenai/autoheal` 财务报告和审定财务报表 `./cypress/testgenai/POMs`

## 配置

### 使用配置选项

通过 . 配置 TestGenAI 插件 `env.applitoolsTestGenAI` 对象 `cypress.config.js`。这里有一个结合各种选项的例子:

```js:cypress.config.js
module.exports = defineConfig({
  env: {
    applitoolsTestGenAI: {
      // Basic configuration
      isEnabled: true,
      autohealDataFolders: ['cypress/testgenai/autoheal'],

      // Network settings
      waitForNetworkCalls: {
        isEnabled: true,
        idle: 3000,
        timeout: 30000
      },

      // Element timing settings
      getElementTimeout: 30000,
      ifExistsTimeout: 5000,

      // Debug settings
      debug: {
        fileLogEnabled: true,
        recordTestRun: false
      }
    }
  },
});
```

所有配置选项都是可选的,如果没有指定,将使用它们的默认值.

### 配置选项参考

#### 核心设置

| 选项 | 默认 | 说明 |
| --- | --- | --- |
| `isEnabled` | `true` | 禁用/ 启用飞行前循环插件 |
| `generateFixedTests` | `true` | 生成自动愈合测试 |
| `allowObscuredElements` | `true` | 允许模糊元素 |
| `forceActions` | `false` | 力量与元素的相互作用,即使它们被其他元素所覆盖或者不完全可见. |

#### 网络设置

| 选项 | 默认 | 说明 |
| --- | --- | --- |
| `waitForNetworkCalls.isEnabled` | `true` | 等网络通话结束再继续测试 |
| `waitForNetworkCalls.idle` | `2000ms` | 等网络电话闲置再继续 |
| `waitForNetworkCalls.timeout` | `60000ms` | 网络呼叫完成的最大等待时间 |

#### 元素时间设置

| 选项 | 默认 | 说明 |
| --- | --- | --- |
| `getElementTimeout` | `60000ms` | 等待元素出现的最大时间 |
| `ifExistsTimeout` | `3000ms` | 等待元素存在的最大时间 |
| `waitToDisappear.searchElementTimeout` | `10000ms` | 在等待元素消失之前等待元素出现的最大时间 |
| `waitToDisappear.timeout` | `90000ms` | 等待元素消失的最大时间 |

#### 选择器和自动愈合设置

| 选项 | 默认 | 说明 |
| --- | --- | --- |
| `autohealDataFolders` | `[]` | 自动修补文件夹的目录路径列表 |
| `selectorGeneratorOptions.excludedAttributeTypes` | `[]` | 在自愈中排除的选定属性列表 |
| `selectorGeneratorOptions.excludedAttributeValueKeywords` | `[]` | 包含关键词的选定者属性列表以排除自愈 |
| `selectorGeneratorOptions.includedAttributeTypes` | `[]` | 自愈中要选择的属性列表 |

#### 调试设置

| 选项 | 默认 | 说明 |
| --- | --- | --- |
| `debug.fileLogEnabled` | `false` | 启用调试日志并生成调试文件夹中的日志文件 |
| `debug.recordTestRun` | `false` | 启用测试执行的调试记录并生成调试文件夹中的zip文件 |

## 常见问题

### @applitools/testgenai-cypress 是什么？

Applitools TestGenAI使技术和非技术小组成员能够有效地扩大测试范围。 这种包容性使非技术参与者能够进行测试自动化,帮助更有效地分配整个系统的工作量

### 如何安装 @applitools/testgenai-cypress？

在项目目录运行 npm install @applitools/testgenai-cypress，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 init，可以用 npx init 直接运行。

### @applitools/testgenai-cypress 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @applitools/testgenai-cypress 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @applitools/testgenai-cypress 可以商用吗？

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

### @applitools/testgenai-cypress 的下载量有多少？

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

### @applitools/testgenai-cypress 还在维护吗？

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