# @cronn/playwright-file-snapshots 中文文档

规范地址：https://npmcn.com/package/%40cronn/playwright-file-snapshots/

版本：2\.4\.0
npm 元数据更新时间：2026-11-06T14:07:05.372Z
中文译文更新时间：2026-11-11T01:12:29.565Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：31.4 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^24\.8\.0 \|\| \>=26
- 运行依赖：2 个
- peer 依赖：@playwright/test ^1\.55
- 首次发布：2025-06-18T14:44:31.479Z
- 最新版本发布：2026-11-06T14:07:05.037Z
- 近 30 天下载量：6114（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：58（近 12 个月 25 个）

## 中文简介

使用文件快照写 Playwright 测试

## 安装

```sh
npm install @cronn/playwright-file-snapshots
```

也可以使用：`pnpm add @cronn/playwright-file-snapshots`、`yarn add @cronn/playwright-file-snapshots`、`bun add @cronn/playwright-file-snapshots`

## README

# 播放作家文件快照

使用文件快照与 Playwright 编写测试 .

[阅读全部文档](https://cronn.github.io/file-snapshots/playwright/)

## 开始

### 安装

```shell
pnpm add -D @cronn/playwright-file-snapshots
```

```shell
npm install -D @cronn/playwright-file-snapshots
```

```shell
yarn add -D @cronn/playwright-file-snapshots
```

### 配置

定义可重复使用 `expect` 输出( 如: `fixtures.ts`:

```ts
import { defineFileSnapshotMatchers } from "@cronn/playwright-file-snapshots";

export const expect = defineFileSnapshotMatchers();
```

将输出目录添加到您的 `.gitignore`数字 :

```
# file snapshots
/data/test/output
```

## 写入测试

```ts
import { test } from "@playwright/test";

import { expect } from "./fixtures";

test("value is expected value", async () => {
  await expect({ value: "expected value" }).toMatchJsonFile();
});
```

**产出(`value_is_expected_value.json`:**

```json
{
  "value": "expected value"
}
```

## 常见问题

### @cronn/playwright-file-snapshots 是什么？

使用文件快照写 Playwright 测试

### 如何安装 @cronn/playwright-file-snapshots？

在项目目录运行 npm install @cronn/playwright-file-snapshots，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@playwright/test（^1\.55）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cronn/playwright-file-snapshots 支持 TypeScript 吗？

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

### @cronn/playwright-file-snapshots 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cronn/playwright-file-snapshots 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^24\.8\.0 \|\| \>=26。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cronn/playwright-file-snapshots 可以商用吗？

@cronn/playwright-file-snapshots 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @cronn/playwright-file-snapshots 的下载量有多少？

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

### @cronn/playwright-file-snapshots 还在维护吗？

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