@argos-ci/storybook

中文文档
6.4.4发布于 2026/10/21MITTypeScriptESM + CJS构建来源已验证近 30 天下载 38.2万

Visual testing for Storybook test runner.

原始使用文档
文档目录4 节
  1. Installation
  2. Usage
  3. Compatibility
  4. Links

Argos

The open source visual testing platform for teams and AI agents.

Official Argos Storybook integration

npm version npm dm npm dt

Capture and review visual changes of your Storybook stories with Argos. It runs your stories in a real browser and uploads a screenshot of each one to Argos in your CI.

Visit the Storybook SDK documentation for guides, the API reference, and more.

Installation

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

Usage

The recommended way to run visual tests is with the Storybook Vitest addon. Register the Argos plugin in your Vitest config:

// 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",
    }),
  ],
});

A screenshot is captured for every story automatically. To capture additional screenshots (for example, at different steps of an interaction), call argosScreenshot inside a story's play function:

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

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

Using the Storybook Test Runner instead? Import argosScreenshot from @argos-ci/storybook/test-runner and call it from the postVisit hook. See the Test Runner quickstart.

Compatibility

@argos-ci/storybook supports Storybook 8 through 11, including the 11 pre-releases. Screenshots can be taken with the Vitest addon (Storybook 9 or later, Vitest 4 or 5) or with the Storybook Test Runner (Storybook 8 or later).

版本与发布记录

@argos-ci/storybook 共发布 120 个版本,首次发布于 2024/10/25;过去 12 个月发布了 65 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
6.4.4latest2026/10/2117 天前
6.4.22026/10/041 个月前
6.4.12026/09/301 个月前
6.4.02026/09/131 个月前
6.3.12026/09/121 个月前
6.3.02026/09/052 个月前

其他发布通道:canary → 6.2.5-canary-20260811115807.6.sha-15ba429。

关于 @argos-ci/storybook 的常见问题

@argos-ci/storybook 是什么?

Visual testing for Storybook test runner.

如何安装 @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 和提交记录判断。