Storycap
一個 Storybook 擴充套件，透過 Puppeteer 儲存你的 stories 的螢幕截圖影像 :camera:。
Storycap 會爬取你的 Storybook 並擷取螢幕截圖。它主要負責產生視覺測試（例如 reg-suit）所需的影像。
功能
- :camera: 透過 Puppeteer 擷取每個 stories 的螢幕截圖。
- :zap: 極快。
- :package: 零配置。
- :rocket: 提供彈性的螢幕截圖選項。
- :tada: 獨立於任何 UI 框架（React、Angular、Vue 等...）
安裝
$ npm install storycap
或
$ npm install storycap puppeteer
安裝 Puppeteer 是可選的。請參閱 Chromium 版本 以取得更多詳細資訊。
開始使用
Storycap 以 2 種模式執行。一種是「簡單」模式，另一種是「管理」模式。
在簡單模式下，您無需配置您的 Storybook。您只需要提供 Storybook 的 URL，例如
$ npx storycap https://127.0.0.1:9001
您可以使用 --serverCmd 選項啟動您的伺服器。
$ storycap --serverCmd "start-storybook -p 9001" https://127.0.0.1:9001
當然，您可以使用預先建置的 Storybook
$ build-storybook -o dist-storybook
$ storycap --serverCmd "npx http-server dist-storybook -p 9001" https://127.0.0.1:9001
此外，Storycap 可以爬取已建置且已託管的 Storybook 頁面
$ storycap https://next--storybookjs.netlify.app/vue-kitchen-sink/
管理模式
設定 Storybook
如果您想要控制如何擷取 stories（時間、大小等），請使用管理模式。
首先，將 storycap 新增到您的 Storybook 設定檔
/* .storybook/main.js */
module.exports = {
stories: ['../src/**/*.stories.@(js|mdx)'],
addons: [
'@storybook/addon-actions',
'@storybook/addon-links',
'storycap', // <-- Add storycap
],
};
接下來，使用 withScreenshot 裝飾器來告訴 Storycap 如何擷取您的 stories。
/* .storybook/preview.js */
import { withScreenshot } from 'storycap';
export const decorators = [
withScreenshot, // Registration the decorator is required
];
export const parameters = {
// Global parameter is optional.
screenshot: {
// Put global screenshot parameters(e.g. viewport)
},
};
[!NOTE] 您可以使用
addParameters和screenshot鍵來設定螢幕截圖的配置。
設定你的 stories（選用）
並且您可以透過 parameters 覆寫特定 stories 檔案中的全域螢幕截圖選項。
import React from 'react';
import MyComponent from './MyComponent';
export default {
title: 'MyComponent',
component: MyComponent,
parameters: {
screenshot: {
delay: 200,
},
},
};
export const Normal = {};
export const Small = {
args: {
text: 'small',
},
parameters: {
screenshot: {
viewport: 'iPhone 5',
},
},
};
執行 storycap 命令
$ npx start-storybook -p 9009
$ npx storycap https://127.0.0.1:9009
或者您可以使用 --serverCmd 選項以單行程式碼執行
$ npx storycap https://127.0.0.1:9009 --serverCmd "start-storybook -p 9009"
API
withScreenshot
一個 Storybook 裝飾器，用於通知 Storycap 擷取 stories。
類型 ScreenshotOptions
ScreenshotOptions 物件可用作 addParameters 引數或 withScreenshot 引數的 screenshot 鍵的值。
interface ScreenshotOptions {
delay?: number; // default 0 msec
waitAssets?: boolean; // default true
waitFor?: string | () => Promise<void>; // default ""
fullPage?: boolean; // default true
hover?: string; // default ""
focus?: string; // default ""
click?: string; // default ""
skip?: boolean; // default false
viewport?: Viewport;
viewports?: string[] | { [variantName]: Viewport };
variants?: Variants;
waitImages?: boolean; // default true
omitBackground?: boolean; // default false
captureBeyondViewport?: boolean; // default true
clip?: { x: number; y: number; width: number; height: number } | null; // default null
}
delay：擷取前的等待時間 [毫秒]。waitAssets：如果設定為 true，則 Storycap 會等待直到 story 所請求的所有資源（例如<img>或 CSS 背景圖片）完成。waitFor：如果您設定一個函式來傳回Promise，則 Storycap 會等待 promise 被解析。您也可以設定傳回Promise的全域函式的名稱。fullPage：如果設定為 true，則 Storycap 會擷取 stories 的整個頁面。focus：如果設定有效的 CSS 選擇器字串，則 Storycap 會在聚焦由選擇器比對的元素後擷取。hover：如果設定有效的 CSS 選擇器字串，則 Storycap 會在滑鼠懸停在由選擇器比對的元素後擷取。click：如果設定有效的 CSS 選擇器字串，則 Storycap 會在點擊由選擇器比對的元素後擷取。skip：如果設定為 true，則 Storycap 會取消擷取對應的 stories。viewport、viewports：請參閱下方的類型Viewport章節。variants：請參閱下方的類型Variants章節。waitImages：已棄用。請使用waitAssets。如果設定為 true，則 Storycap 會等待直到 story 中的<img>被載入。omitBackground：如果設定為 true，則 Storycap 會省略頁面的背景，允許透明的螢幕截圖。請注意，storybook 主題也需要是透明的。captureBeyondViewport：如果設定為 true，則 Storycap 會擷取視窗外的螢幕截圖。另請參閱 Puppeteer API 文件。clip：如果設定，則 Storycap 只會擷取螢幕上由 x/y/width/height 限制的部分。
類型 Variants
Variants 用於從 1 個 story 產生多個 PNG。
type Variants = {
[variantName: string]: {
extends?: string | string[]; // default: ""
delay?: number;
waitAssets?: boolean;
waitFor?: string | () => Promise<void>;
fullPage?: boolean;
hover?: string;
focus?: string;
click?: string;
skip?: boolean;
viewport?: Viewport;
waitImages?: boolean;
omitBackground?: boolean;
captureBeyondViewport?: boolean;
clip?: { x: number; y: number; width: number; height: number } | null;
};
};
extends：如果設定其他變體的名稱（或它們的名稱陣列），則此變體會延伸其他變體的選項。而且此變體會產生具有後綴（例如_${parentVariantName}_${thisVariantName}）的 PNG 檔案。
類型 Viewport
Viewport 與 Puppeteer 視窗介面 相容。
type Viewport =
| string
| {
width: number; // default: 800
height: number; // default: 600
deviceScaleFactor: ?number; // default: 1,
isMobile?: boolean; // default: false,
hasTouch?: boolean; // default: false,
isLandscape?: boolean; // default: false,
};
[!NOTE] 如果設定字串，您應該選擇有效的裝置名稱。
Viewport 值在 viewports 欄位中可用，例如
addParameters({
screenshot: {
viewports: {
large: {
width: 1024,
height: 768,
},
small: {
width: 375,
height: 668,
},
xsmall: {
width: 320,
height: 568,
},
},
},
});
函式 isScreenshot
function isScreenshot(): boolean;
傳回目前程序是否在 Storycap 瀏覽器中執行。這對於僅在 Storycap 中變更您的 stories 的行為（例如，停用 JavaScript 動畫）很有用。
命令列選項
usage: storycap [options] storybook_url
Options:
--help Show help [boolean]
--version Show version number [boolean]
-o, --outDir Output directory. [string] [default: "__screenshots__"]
-p, --parallel Number of browsers to screenshot. [number] [default: 4]
-f, --flat Flatten output filename. [boolean] [default: false]
-i, --include Including stories name rule. [array] [default: []]
-e, --exclude Excluding stories name rule. [array] [default: []]
--delay Waiting time [msec] before screenshot for each story. [number] [default: 0]
-V, --viewport Viewport. [array] [default: ["800x600"]]
--disableCssAnimation Disable CSS animation and transition. [boolean] [default: true]
--disableWaitAssets Disable waiting for requested assets [boolean] [default: false]
--trace Emit Chromium trace files per screenshot. [boolean] [default: false]
--silent [boolean] [default: false]
--verbose [boolean] [default: false]
--forwardConsoleLogs Forward in-page console logs to the user's console. [boolean] [default: false]
--serverCmd Command line to launch Storybook server. [string] [default: ""]
--serverTimeout Timeout [msec] for starting Storybook server. [number] [default: 60000]
--shard The sharding options for this run. In the format <shardNumber>/<totalShards>.
<shardNumber> is a number between 1 and <totalShards>. <totalShards> is the total
number of computers working. [string] [default: "1/1"]
--captureTimeout Timeout [msec] for capture a story. [number] [default: 5000]
--captureMaxRetryCount Number of count to retry to capture. [number] [default: 3]
--metricsWatchRetryCount Number of count to retry until browser metrics stable. [number] [default: 1000]
--viewportDelay Delay time [msec] between changing viewport and capturing. [number] [default: 300]
--reloadAfterChangeViewport Whether to reload after viewport changed. [boolean] [default: false]
--stateChangeDelay Delay time [msec] after changing element's state. [number] [default: 0]
--listDevices List available device descriptors. [boolean] [default: false]
-C, --chromiumChannel Channel to search local Chromium. One of "puppeteer", "canary", "stable", "*"
[string] [default: "*"]
--chromiumPath Executable Chromium path. [string] [default: ""]
--puppeteerLaunchConfig JSON string of launch config for Puppeteer.
[string] [default: "{ "args": ["--no-sandbox", "--disable-setuid-sandbox", "--disable-dev-shm-usage"] }"]
Examples:
storycap https://127.0.0.1:9009
storycap https://127.0.0.1:9009 -V 1024x768 -V 320x568
storycap https://127.0.0.1:9009 -i "some-kind/a-story"
storycap http://example.com/your-storybook -e "**/default" -V iPad
storycap --serverCmd "start-storybook -p 3000" https://127.0.0.1:3000
從 1 個 story 產生多個 PNG
預設情況下，storycap 從 1 個 story 產生 1 個螢幕截圖影像。如果您想要 1 個 story 的多個 PNG（例如，視窗、元素的狀態變化等），請使用 variants。
基本用法
例如
import React from 'react';
import MyButton from './MyButton';
export default {
title: 'MyButton',
component: MyButton,
};
export const Normal = {
parameters: {
screenshot: {
variants: {
hovered: {
hover: 'button.my-button',
},
},
},
},
};
以上配置會產生 2 個 PNG
MyButton/normal.pngMyButton/normal_hovered.png
在以上範例中，變體鍵 hovered 用作產生之 PNG 檔案名稱的後綴。並且幾乎所有 ScreenshotOptions 欄位都可用作變體值欄位。
注意： variants 本身和 viewports 會被禁止作為變體的欄位。
變體組合
您可以使用 extends 欄位組合多個變體。
export const Normal = {
parameters: {
screenshot: {
variants: {
small: {
viewport: 'iPhone 5',
},
hovered: {
extends: 'small',
hover: 'button.my-button',
},
},
},
},
};
以上範例會產生以下內容
MyButton/normal.png(預設)MyButton/normal_small.png(衍生自small變體)MyButton/normal_hovered.png(衍生自hovered變體)MyButton/normal_small_hovered.png(衍生自hovered和small變體)
[!NOTE] 您可以使用
viewports選項的鍵延伸一些視窗，因為viewports欄位會在內部擴展為變體。
跨多台電腦的平行處理
為了在多台電腦上平行處理更多 stories，可以使用 shard 引數。
shard 引數是格式為：<shardNumber>/<totalShards> 的字串。<shardNumber> 是介於 1 和 <totalShards> 之間（含）的數字。<totalShards> 是執行執行的電腦總數。
例如，以 --shard 1/1 執行的執行會被視為單一電腦上的預設行為。兩台電腦分別執行 --shard 1/2 和 --shard 2/2 會將 stories 分散到兩台電腦上。
當 stories 按照 ID 排序時，會以循環的方式分佈到不同的 shards 上。如果一系列「緊密相鄰」的 stories 螢幕截圖速度比其他 stories 慢，則應將它們平均分配。
提示
使用 Docker 執行
請使用 regviz/node-xcb。
或者建立您的 Docker 基礎映像，例如
FROM node:18
RUN apt-get update -y \
&& apt-get install -yq \
ca-certificates \
fonts-liberation \
git \
libayatana-appindicator3-1 \
libasound2 \
libatk-bridge2.0-0 \
libatk1.0-0 \
libc6 \
libcairo2 \
libcups2 \
libdbus-1-3 \
libexpat1 \
libfontconfig1 \
libgbm1 \
libgcc1 \
libglib2.0-0 \
libgtk-3-0 \
libnspr4 \
libnss3 \
libpango-1.0-0 \
libpangocairo-1.0-0 \
libstdc++6 \
libx11-6 \
libx11-xcb1 \
libxcb1 \
libxcomposite1 \
libxcursor1 \
libxdamage1 \
libxext6 \
libxfixes3 \
libxi6 \
libxrandr2 \
libxrender1 \
libxss1 \
libxtst6 \
lsb-release \
wget \
xdg-utils
完全控制螢幕截圖時間
有時您可能想要完全管理執行螢幕截圖的時間。如果您這樣認為，請使用 waitFor 選項。此參數接受傳回 Promise 的函式或應該指向傳回 Promise 的全域函式的函式名稱。
範例 1
例如，您可以使用 @storybook/test 套件提供的 screen 函式，等待特定 HTML 元素的出現。當元素被延遲渲染時，這會很有用。
/* MyComponent.stories.js */
import { screen } from '@storybook/test';
export const MyStory = {
screenshot: {
waitFor: async () => {
await screen.findByRole('link');
},
},
};
範例 2
另一個範例，以下設定會告訴 storycap 等待 fontLoading 的解析
<!-- ./storybook/preview-head.html -->
<link rel="preload" href="/some-heavy-asset.woff" as="font" onload="this.setAttribute('loaded', 'loaded')" />
<script>
function fontLoading() {
const loaded = () => !!document.querySelector('link[rel="preload"][loaded="loaded"]');
if (loaded()) return Promise.resolve();
return new Promise((resolve, reject) => {
const id = setInterval(() => {
if (!loaded()) return;
clearInterval(id);
resolve();
}, 50);
});
}
</script>
/* .storybook/preview.js */
import { withScreenshot } from 'storycap';
export const decorators = [withScreenshot];
export const parameters = {
screenshot: {
waitFor: 'fontLoading',
},
};
Chromium 版本
自 v3.0.0 起，Storycap 不會直接使用 Puppeteer。相反地，Storycap 會依以下順序搜尋 Chromium 二進位檔
- 已安裝的 Puppeteer 套件（如果您已明確安裝）
- 本機安裝的 Canary Chrome
- 本機安裝的 Stable Chrome
您可以使用 --chromiumChannel 選項變更搜尋通道，或使用 --chromiumPath 選項設定可執行 Chromium 檔案路徑。
Storybook 相容性
Storybook 版本
Storycap 已使用以下版本進行測試
- 簡單模式
- Storybook v7.x
- Storybook v8.x
- 管理模式
- Storybook v7.x
- Storybook v8.x
另請參閱 examples 目錄中的套件。
UI 框架
Storycap（使用簡單模式和管理模式）與特定的 UI 框架（例如 React、Angular、Vue.js 等）無關。因此，您可以將它與您自己喜歡的框架一起使用 Storybook :smile:。
運作方式
Storycap 會使用 Puppeteer 存取啟動的頁面。
貢獻
請參閱 CONTRIBUTING.md。
