# @artilleryio/playwright-reporter 中文文档

规范地址：https://npmcn.com/package/%40artilleryio/playwright-reporter/

版本：1\.1\.3
npm 元数据更新时间：2025-02-26T12:53:47.238Z
中文译文更新时间：2026-11-06T21:09:19.079Z
软件包许可：SEE LICENSE IN LICENSE\.txt

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

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

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

- 包体积（解压后）：45.4 kB，5 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2024-11-19T13:43:59.444Z
- 最新版本发布：2025-02-26T12:53:47.022Z
- 近 30 天下载量：23960（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 0 个）

## 中文简介

炮兵云剧作家记者

## 安装

```sh
npm install @artilleryio/playwright-reporter
```

也可以使用：`pnpm add @artilleryio/playwright-reporter`、`yarn add @artilleryio/playwright-reporter`、`bun add @artilleryio/playwright-reporter`

## README

# 升级您的 Playwright E2E 测试

![Artillery Cloud Playwright Reporter](https://www.artillery.io/images/playwright-reporter/playwright-report@2x.png)

添加 `@artilleryio/playwright-reporter` 到您的 Playwright 项目 获取 :

-   用于 Playwright 测试报告的云仪表板
-   实时报告截图、痕迹和附件
-   自动跟踪Web维生性能衡量标准
-   有痕迹的调试 CI 失败
-   GitHub 动作与 PR 注释集成

开始一个免费的炮兵云帐号 [https://app.artillery.io (英语)](https://app.artillery.io/)

## 学多点

-   [安装](https://npmcn.com/package/%40artilleryio/playwright-reporter/#readme-installation)
-   [GitHub 动作](https://npmcn.com/package/%40artilleryio/playwright-reporter/#readme-github-actions)
-   [业绩跟踪](https://npmcn.com/package/%40artilleryio/playwright-reporter/#readme-performance-tracking)
-   [截图](https://npmcn.com/package/%40artilleryio/playwright-reporter/#readme-screenshots)
-   [目前的限制](https://npmcn.com/package/%40artilleryio/playwright-reporter/#readme-current-limitations)

## 使用量

### 安装记者

添加 `@artilleryio/playwright-reporter` 到您的项目作为 dev 依赖:

```sh
npm install -D @artilleryio/playwright-reporter
```

### 启用记者

启用您 Playwright 配置中的记者( T)`playwright.config.ts`:

```ts
const config: PlaywrightTestConfig = {
  reporter: [
    ['@artilleryio/playwright-reporter', { name: 'My Test Suite' }],
  ],
  // ... rest of your config
};
```

> \[注\] 从记者的更早版本升级? 这个 `blob` 记者不再需要使用 `@artilleryio/playwright-reporter`。您可以在您配置中的记者名单上删除它.

### 设定您的炮兵云 API 密钥

签入"炮兵云"(免费)并创建API键: [https://app.artillery.io/ settings/api-keys 互联网档案馆的存檔,存档日期2014-12-22](https://app.artillery.io/settings/api-keys)。 。 。 .

然后导出您的 `ARTILLERY_CLOUD_API_KEY`数字 :

```sh
export ARTILLERY_CLOUD_API_KEY=a9_your_api_key
```

### 运行您的剧作家测试

```sh
npx playwright test
```

测试开始后,记者会将测试运行的URL打印到控制台. URL会像这样:

```
https://app.artillery.io/b9j745e5cx4yrxcrb4qwpfty7p8r3/playwright/pwzxhq_abcdefabcdefghi_7atf
```

您可以实时在"炮兵云"中跟踪测试运行进度,每次测试都有截图和痕迹.

## GitHub 动作

当记者被使用在一个 GitHub Action 工作流程中时,它可以随测试结果向PR发布评论. 要启用 PR 注释, 设置 `GITHUB_TOKEN` 您运行 Playwright 测试的 GitHub 动作工作中的环境变量 :

```yaml
jobs:
  test:
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '22'
          cache: 'npm'

      - name: Run Playwright tests
        env:
          ARTILLERY_CLOUD_API_KEY: "${{ secrets.ARTILLERY_CLOUD_API_KEY }}" # API key to send results to Artillery Cloud
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Enable PR comments
        run: npx playwright test
```

## 使用Web Vitus进行性能跟踪(实验性)

您可以配置测试以跟踪 [网络维度](https://web.dev/vitals/) 自动为您测试的每个页面( LCP, CLS, FCP, TTFB, 和INP) .

为了能够进行性能跟踪,请使用 `withPerformanceTracking()` 扩展 Playwright 内置的方法 `test` 函数 :

```ts
// Rename the "test" import from @playwright/test to "base":
import { test as base } from '@playwright/test';
// Import the withPerformanceTracking function:
import { withPerformanceTracking } from '@artilleryio/playwright-reporter';

// Extend the base test function with performance tracking. This needs to be at the top before using test()
const test = withPerformanceTracking(base);

// The rest of your tests remain the same, e.g.:

test('has title', async ({ page }) => {
  await page.goto('https://playwright.dev/');
  await expect(page).toHaveTitle(/Playwright/);
});
```

## 截图

| 报告概览 | 除错出错 |
| --- | --- |
| ![Overview](https://www.artillery.io/images/playwright-reporter/overview@2x.png) | ![Debug](https://www.artillery.io/images/playwright-reporter/debug@2x.png) |

## 目前的限制

-   以已磨损模式运行的测试尚未得到充分支持 。 每跑一跑都会在"炮兵云"中产生多份部分报告,每分一分. 我们很快会释放出全力支持被压抑的跑道.

## 路线图

这些是我们正在积极从事的一些工作。 如果你有特别要求或想法,请告诉我们 [支持@ artillery.io](mailto:support@artillery.io)。 。 。 .

-   完全支持软化测试运行
-   更好的 GitHub 动作整合

## 许可证

炮兵云游剧作家记者根据FSL-1.1-ALv2获得许可 [公平来源许可证](https://fsl.software/)见 [LICENSE.txt (英语)](https://npmcn.com/package/%40artilleryio/playwright-reporter/LICENSE.txt) 详细文件.

## 常见问题

### @artilleryio/playwright-reporter 是什么？

炮兵云剧作家记者

### 如何安装 @artilleryio/playwright-reporter？

在项目目录运行 npm install @artilleryio/playwright-reporter，或使用 pnpm add / yarn add / bun add。

### @artilleryio/playwright-reporter 支持 TypeScript 吗？

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

### @artilleryio/playwright-reporter 支持 ESM 还是 CommonJS？

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

### @artilleryio/playwright-reporter 可以商用吗？

@artilleryio/playwright-reporter 使用 SEE LICENSE IN LICENSE\.txt 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @artilleryio/playwright-reporter 的下载量有多少？

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

### @artilleryio/playwright-reporter 还在维护吗？

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