# @argos-ci/storybook 中文文档

规范地址：https://npmcn.com/package/%40argos-ci/storybook/

版本：6\.4\.4
npm 元数据更新时间：2026-10-21T12:40:16.774Z
中文译文更新时间：2026-11-06T18:31:34.759Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40argos-ci/storybook
原文对照：https://npmcn.com/package/%40argos-ci/storybook/?lang=original
项目主页：https://argos-ci.com/docs/reference/storybook
源码仓库：https://github.com/argos-ci/argos-javascript

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

- 包体积（解压后）：40.7 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：4 个
- peer 依赖：storybook ^8\.0\.0 \|\| ^9\.0\.0 \|\| ^10\.0\.0 \|\| ^11\.0\.0-0
- 首次发布：2024-10-25T10:27:18.950Z
- 最新版本发布：2026-10-21T12:40:16.324Z
- 近 30 天下载量：382007（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：120（近 12 个月 65 个）

## 中文简介

故事书试跑者的视觉测试.

## 安装

```sh
npm install @argos-ci/storybook
```

也可以使用：`pnpm add @argos-ci/storybook`、`yarn add @argos-ci/storybook`、`bun add @argos-ci/storybook`

## README

[![Argos](https://raw.githubusercontent.com/argos-ci/argos/main/resources/logos/github-readme-logo-light.png)](https://argos-ci.com/?utm_source=github&utm_medium=logo)

**团队和AI代理的开源视觉测试平台.**

# 阿尔戈斯故事集官方集成

[![npm version](https://img.shields.io/npm/v/@argos-ci/storybook.svg)](https://www.npmjs.com/package/@argos-ci/storybook) [![npm dm](https://img.shields.io/npm/dm/@argos-ci/storybook.svg)](https://www.npmjs.com/package/@argos-ci/storybook) [![npm dt](https://img.shields.io/npm/dt/@argos-ci/storybook.svg)](https://www.npmjs.com/package/@argos-ci/storybook)

抓取并审查您的视觉变化 [故事书](https://storybook.js.org/) 与阿尔戈斯的故事。 它用真实的浏览器运行你的故事,并将每个故事的截图上传到您的CI中的Argos.

访问 [故事书 SDK 文档](https://argos-ci.com/docs/reference/storybook) 用于向导,API参考,以及更多.

## 安装

```sh
npm install --save-dev @argos-ci/storybook
```

## 使用量

建议进行视觉测试的方法是: [故事书 Vitest 附加词](https://storybook.js.org/docs/writing-tests/integrations/vitest-addon)在您的虚拟配置中注册Argos插件 :

```ts
// vitest.config.ts
import { defineConfig } from "vitest/config";
import { argosVitestPlugin } from "@argos-ci/storybook/vitest-plugin";

export default defineConfig({
  plugins: [
    argosVitestPlugin({
      // Upload the screenshots to Argos only on CI.
      uploadToArgos: process.env.CI === "true",
    }),
  ],
});
```

每个故事都会自动被截取 要捕捉到更多的截图(例如,在互动的不同步骤),调用 `argosScreenshot` 在一个故事里面 `play` 函数 :

```ts
// Button.stories.tsx
import { argosScreenshot } from "@argos-ci/storybook/vitest";

export const Example: Story = {
  play: async (ctx) => {
    await argosScreenshot(ctx, "example");
  },
};
```

> 使用 [故事书测试运行器](https://storybook.js.org/docs/writing-tests/integrations/test-runner) 换成? 导入 `argosScreenshot` 从 `@argos-ci/storybook/test-runner` 并打电话给它从 `postVisit` 钩. 见 [测试运行器快速启动](https://argos-ci.com/docs/quickstart/storybook-quickstart/storybook-test-runner-quickstart)。 。 。 .

## 兼容性

`@argos-ci/storybook` 支持"故事书"8至11,包括11个预发版. 屏幕截图可用 [维特加通](https://storybook.js.org/docs/writing-tests/integrations/vitest-addon) ("史记"第9册或后作"活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活 [故事书测试运行器](https://storybook.js.org/docs/writing-tests/integrations/test-runner) (史记 第8册或后.

## 链接

-   [官方 SDK 文档](https://argos-ci.com/docs/reference/storybook)
-   [快速启动](https://argos-ci.com/docs/quickstart/storybook-quickstart)
-   [解析器](https://argos-ci.com/discord)

## 常见问题

### @argos-ci/storybook 是什么？

故事书试跑者的视觉测试\.

### 如何安装 @argos-ci/storybook？

在项目目录运行 npm install @argos-ci/storybook，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：storybook（^8\.0\.0 \|\| ^9\.0\.0 \|\| ^10\.0\.0 \|\| ^11\.0\.0-0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @argos-ci/storybook 支持 TypeScript 吗？

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

### @argos-ci/storybook 支持 ESM 还是 CommonJS？

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

### @argos-ci/storybook 需要什么版本的 Node\.js？

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

### @argos-ci/storybook 可以商用吗？

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

### @argos-ci/storybook 的下载量有多少？

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

### @argos-ci/storybook 还在维护吗？

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