# @bbc/psammead-test-helpers 中文文档

规范地址：https://npmcn.com/package/%40bbc/psammead-test-helpers/

版本：6\.0\.5
npm 元数据更新时间：2025-03-06T15:59:45.836Z
中文译文更新时间：2026-11-07T18:48:49.764Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40bbc/psammead-test-helpers
原文对照：https://npmcn.com/package/%40bbc/psammead-test-helpers/?lang=original
项目主页：https://github.com/bbc/psammead/blob/latest/packages/utilities/psammead-test-helpers/README.md
源码仓库：https://github.com/bbc/psammead/tree/latest/packages/utilities/psammead-test-helpers

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

- 包体积（解压后）：30.8 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2018-12-03T10:25:57.524Z
- 最新版本发布：2021-08-27T08:12:02.184Z
- 近 30 天下载量：9072（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：40（近 12 个月 0 个）

## 中文简介

收集实施Jest快照测试情感的帮助方法,这是许多Psammead组件所要求的.

## 安装

```sh
npm install @bbc/psammead-test-helpers
```

也可以使用：`pnpm add @bbc/psammead-test-helpers`、`yarn add @bbc/psammead-test-helpers`、`bun add @bbc/psammead-test-helpers`

## README

# psammead - test - 帮助者 - [![Known Vulnerabilities](https://snyk.io/test/github/bbc/psammead/badge.svg?targetFile=packages%2Futilities%2Fpsammead-test-helpers%2Fpackage.json)](https://snyk.io/test/github/bbc/psammead?targetFile=packages%2Futilities%2Fpsammead-test-helpers%2Fpackage.json) [![Dependency Status](https://david-dm.org/bbc/psammead.svg?path=packages/utilities/psammead-test-helpers)](https://david-dm.org/bbc/psammead?path=packages/utilities/psammead-test-helpers) [![peerDependencies Status](https://david-dm.org/bbc/psammead/peer-status.svg?path=packages/utilities/psammead-test-helpers)](https://david-dm.org/bbc/psammead?path=packages/utilities/psammead-test-helpers&type=peer) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/bbc/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-test-helpers.svg)](https://www.npmjs.com/package/@bbc/psammead-test-helpers) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/bbc/psammead/blob/latest/CONTRIBUTING.md)

这个软件包提供了一套实施Jest快照测试的帮助方法,这是许多Psammead组件所需要的.

## 导出函数

| 名称 | 参数 | 说明 |
| :-- | :-- | :-- |
| 匹配抓图 | 标题,组件 | 使用 @ testing-library/ react 将组件渲染,将其转换为 JSON 并声称它与给定的快照相匹配,该快照将在 `__snapshots__` 目录。 第一个论点 `title` 是测试的标题. |
| 匹配Snapshot 同步 | 组件 | 使用 @ testing-library/ react 将组件渲染,将其转换为 JSON 并声称它与给定的快照相匹配,该快照将在 `__snapshots__` 目录。 与 `shouldMatchSnapshot`,它不创建测试,因此可以在任意 `it(...)` 测试. |
| 无效 | 标题,组件 | 使用 @ testing-library/ react 渲染组件,将其转换为JSON并声称其无效. 第一个论点 `title` 是测试的标题. |
| 测试工具 软件包 | 实际出口、 预期出口、 工具Name | 对照窗体中的密钥值对对象验证导入的通用软件包的输出值 `{ name_of_export: 'type of export' }`,比如说. `{ shouldMatchSnapshot: 'function' }`。 。 。 . |
| 设置窗口 | 键, 值 | 允许您在窗口( 如位置) 上设置通常不可写入的变量 |
| 重新设置窗口 | 键, 值 | 允许您重置先前被设置的 WindowValue 函数所覆盖的窗口工具 |
| 抑制预告 | 警告 | 在测试期间,会发出预言的道具警告. |

## 安装

```jsx
npm install react react-dom @bbc/psammead-test-helpers --save-dev
```

## 使用量

```jsx
import { shouldMatchSnapshot } from '@bbc/psammead-test-helpers';

shouldMatchSnapshot('should render correctly', <h1>Hello World</h1>);
```

## 路线图

## 捐款

何时 **添加** 向此工具包新导出 [出口测试](https://github.com/bbc/psammead/blob/5d7395fd60bd8d73796d5a23775b4b5b36db1445/packages/utilities/psammead-test-helpers/index.test.jsx#L8-L14) 还需要更新,出口应添加到 [读取](https://github.com/bbc/psammead/tree/5d7395fd60bd8d73796d5a23775b4b5b36db1445/packages/utilities/psammead-test-helpers#exported-functions)时 **删除** 从此工具包中导出 [出口测试](https://github.com/bbc/psammead/blob/5d7395fd60bd8d73796d5a23775b4b5b36db1445/packages/utilities/psammead-test-helpers/index.test.jsx#L8-L14) 需要更新,出口应从 [读取](https://github.com/bbc/psammead/tree/5d7395fd60bd8d73796d5a23775b4b5b36db1445/packages/utilities/psammead-test-helpers#exported-functions) 而软件包版本则需要作重大修改(EG:1.2.1 - > 2.0.0),因为这会被视为功能被去除而导致的突破性修改.

Psammead完全开源. 我们感谢任何贡献,无论是新的组件、错误修正还是总体改进。 请参看我们的主要贡献指南,可查阅: [psammead 仓库的根](https://github.com/bbc/psammead/blob/latest/CONTRIBUTING.md)。 。 。 .

### [行为守则](https://github.com/bbc/psammead/blob/latest/CODE_OF_CONDUCT.md)

我们欢迎对这项工作的反馈和帮助。 通过参与这个项目,你同意遵守 [行为守则](https://github.com/bbc/psammead/blob/latest/CODE_OF_CONDUCT.md)请稍候再读一下.

### 许可证

萨姆米德 [Apache 2.0 许可](https://github.com/bbc/psammead/blob/latest/LICENSE)。 。 。 .

## 常见问题

### @bbc/psammead-test-helpers 是什么？

收集实施Jest快照测试情感的帮助方法,这是许多Psammead组件所要求的\.

### 如何安装 @bbc/psammead-test-helpers？

在项目目录运行 npm install @bbc/psammead-test-helpers，或使用 pnpm add / yarn add / bun add。

### @bbc/psammead-test-helpers 支持 TypeScript 吗？

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

### @bbc/psammead-test-helpers 支持 ESM 还是 CommonJS？

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

### @bbc/psammead-test-helpers 可以商用吗？

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

### @bbc/psammead-test-helpers 的下载量有多少？

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

### @bbc/psammead-test-helpers 还在维护吗？

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

