Builder API

Storybook 的架构旨在支持多种 builder，包括 Webpack、Vite 和 ESBuild。builder API 是一组接口，您可以使用这些接口向 Storybook 添加新的 builder。

Storybook builders

builder 如何工作？

在 Storybook 中，builder 负责将您的组件和 stories 编译成在浏览器中运行的 JS 包。builder 还提供用于交互式开发的开发服务器和用于优化包的生产模式。

要选择使用 builder，用户必须将其添加为依赖项，然后编辑其配置文件 (.storybook/main.js) 以启用它。例如，使用 Vite builder

npm install @storybook/builder-vite --save-dev

.storybook/main.js|ts

export default {
  stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
  addons: ['@storybook/addon-essentials'],
  core: {
    builder: '@storybook/builder-vite', // 👈 The builder enabled here.
  },
};

Builder API

在 Storybook 中，每个 builder 都必须实现以下 API，公开以下配置选项和入口点

export interface Builder<Config, Stats> {
  start: (args: {
    options: Options;
    startTime: ReturnType<typeof process.hrtime>;
    router: Router;
    server: Server;
  }) => Promise<void | {
    stats?: Stats;
    totalTime: ReturnType<typeof process.hrtime>;
    bail: (e?: Error) => Promise<void>;
  }>;
  build: (arg: {
    options: Options;
    startTime: ReturnType<typeof process.hrtime>;
  }) => Promise<void | Stats>;
  bail: (e?: Error) => Promise<void>;
  getConfig: (options: Options) => Promise<Config>;
  corePresets?: string[];
  overridePresets?: string[];
}

在开发模式下，start API 调用负责初始化开发服务器，以监视文件系统中的更改（例如，组件和 stories），然后在浏览器中执行热模块重载。它还提供一个 bail 函数，允许正在运行的进程通过用户输入或错误优雅地结束。

在生产模式下，build API 调用负责生成静态 Storybook 构建，默认情况下将其存储在 storybook-static 目录中（如果未提供其他配置）。生成的输出应包含用户查看其 Storybook 所需的一切，只需在浏览器中打开 index.html 或 iframe.html，而无需运行其他进程。

实现

在底层，builder 负责服务/构建预览 iframe，它有自己的一组要求。为了完全支持 Storybook，包括 Storybook 附带的必备插件，它必须考虑以下事项。

导入 Stories

stories 配置字段启用 Storybook 中的 story 加载。它定义了一个文件 glob 数组，其中包含组件 stories 的物理位置。builder 必须能够加载这些文件并监视其更改，并相应地更新 UI。

提供配置选项

默认情况下，Storybook 的配置在专用文件 (storybook/main.js|ts) 中处理，使用户可以选择自定义它以满足其需求。builder 也应通过其他字段或一些其他适合 builder 的机制来提供自己的配置支持。例如

vite-server.ts

import { stringifyProcessEnvs } from './envs';
import { getOptimizeDeps } from './optimizeDeps';
import { commonConfig } from './vite-config';
 
import type { EnvsRaw, ExtendedOptions } from './types';
 
export async function createViteServer(options: ExtendedOptions, devServer: Server) {
  const { port, presets } = options;
 
  // Defines the baseline config.
  const baseConfig = await commonConfig(options, 'development');
  const defaultConfig = {
    ...baseConfig,
    server: {
      middlewareMode: true,
      hmr: {
        port,
        server: devServer,
      },
      fs: {
        strict: true,
      },
    },
    optimizeDeps: await getOptimizeDeps(baseConfig, options),
  };
 
  const finalConfig = await presets.apply('viteFinal', defaultConfig, options);
 
  const envsRaw = await presets.apply<Promise<EnvsRaw>>('env');
 
  // Remainder implementation
}

处理 preview.js 导出

preview.js 配置文件允许用户控制 story 在 UI 中的渲染方式。这通过 decorators 命名导出提供。当 Storybook 启动时，它通过虚拟模块入口将这些命名导出转换为内部 API 调用，例如，addDecorator()。builder 也必须提供类似的实现。例如

import { virtualPreviewFile, virtualStoriesFile } from './virtual-file-names';
import { transformAbsPath } from './utils/transform-abs-path';
import type { ExtendedOptions } from './types';
 
export async function generateIframeScriptCode(options: ExtendedOptions) {
  const { presets, frameworkPath, framework } = options;
  const frameworkImportPath = frameworkPath || `@storybook/${framework}`;
 
  const presetEntries = await presets.apply('config', [], options);
  const configEntries = [...presetEntries].filter(Boolean);
 
  const absoluteFilesToImport = (files: string[], name: string) =>
    files
      .map((el, i) => `import ${name ? `* as ${name}_${i} from ` : ''}'${transformAbsPath(el)}'`)
      .join('\n');
 
  const importArray = (name: string, length: number) =>
    new Array(length).fill(0).map((_, i) => `${name}_${i}`);
 
  const code = `
    // Ensure that the client API is initialized by the framework before any other iframe code
    // is loaded. That way our client-apis can assume the existence of the API+store
    import { configure } from '${frameworkImportPath}';
 
    import {
      addDecorator,
      addParameters,
      addArgTypesEnhancer,
      addArgsEnhancer,
      setGlobalRender
    } from '@storybook/preview-api';
    import { logger } from '@storybook/client-logger';
    ${absoluteFilesToImport(configEntries, 'config')}
    import * as preview from '${virtualPreviewFile}';
    import { configStories } from '${virtualStoriesFile}';
 
    const configs = [${importArray('config', configEntries.length)
      .concat('preview.default')
      .join(',')}].filter(Boolean)
 
    configs.forEach(config => {
      Object.keys(config).forEach((key) => {
        const value = config[key];
        switch (key) {
          case 'args':
          case 'argTypes': {
            return logger.warn('Invalid args/argTypes in config, ignoring.', JSON.stringify(value));
          }
          case 'decorators': {
            return value.forEach((decorator) => addDecorator(decorator, false));
          }
          case 'parameters': {
            return addParameters({ ...value }, false);
          }
          case 'render': {
            return setGlobalRender(value)
          }
          case 'globals':
          case 'globalTypes': {
            const v = {};
            v[key] = value;
            return addParameters(v, false);
          }
          case 'decorateStory':
          case 'renderToCanvas': {
            return null;
          }
          default: {
            // eslint-disable-next-line prefer-template
            return console.log(key + ' was not supported :( !');
          }
        }
      });
    })
    configStories(configure);
    `.trim();
  return code;
}

MDX 支持

Storybook 的文档包括使用 Webpack 加载器在 MDX 中编写 stories/文档的功能。builder 还必须知道如何解释 MDX 并调用 Storybook 的特殊扩展。例如

mdx-plugin.ts

import mdx from 'vite-plugin-mdx';
 
import { createCompiler } from '@storybook/csf-tools/mdx';
 
export function mdxPlugin() {
  return mdx((filename) => {
    const compilers = [];
 
    if (filename.endsWith('stories.mdx') || filename.endsWith('story.mdx')) {
      compilers.push(createCompiler({}));
    }
    return {
      compilers,
    };
  });
}

生成源代码片段

Storybook 使用与其输入相关的其他元数据注释组件和 stories，以自动生成交互式控件和文档。目前，这是通过 Webpack 加载器/插件提供的。builder 必须重新实现此功能以支持这些特性。

生成静态构建

Storybook 的核心功能之一是生成可以发布到 Web 托管服务的静态构建。builder 还必须能够提供类似的机制。例如

build.ts

import { build as viteBuild } from 'vite';
import { stringifyProcessEnvs } from './envs';
import { commonConfig } from './vite-config';
 
import type { EnvsRaw, ExtendedOptions } from './types';
 
export async function build(options: ExtendedOptions) {
  const { presets } = options;
 
  const baseConfig = await commonConfig(options, 'build');
  const config = {
    ...baseConfig,
    build: {
      outDir: options.outputDir,
      emptyOutDir: false,
      sourcemap: true,
    },
  };
 
  const finalConfig = await presets.apply('viteFinal', config, options);
 
  const envsRaw = await presets.apply<Promise<EnvsRaw>>('env');
  // Stringify env variables after getting `envPrefix` from the final config
  const envs = stringifyProcessEnvs(envsRaw, finalConfig.envPrefix);
  // Update `define`
  finalConfig.define = {
    ...finalConfig.define,
    ...envs,
  };
 
  await viteBuild(finalConfig);
}

开发服务器集成

默认情况下，当 Storybook 在开发模式下启动时，它依赖于其内部开发服务器。builder 需要能够与之集成。例如

server.ts

import { createServer } from 'vite';
 
export async function createViteServer(options: ExtendedOptions, devServer: Server) {
  const { port } = options;
  // Remainder server configuration
 
  // Creates the server.
  return createServer({
    // The server configuration goes here
    server: {
      middlewareMode: true,
      hmr: {
        port,
        server: devServer,
      },
    },
  });
}

关闭开发服务器

builder 必须提供一种在进程终止后停止开发服务器的方法；这可以通过用户输入或错误来完成。例如

index.ts

import { createViteServer } from './vite-server';
 
let server: ViteDevServer;
export async function bail(): Promise<void> {
  return server?.close();
}
 
export const start: ViteBuilder['start'] = async ({ options, server: devServer }) => {
  // Remainder implementation goes here
  server = await createViteServer(options as ExtendedOptions, devServer);
 
  return {
    bail,
    totalTime: process.hrtime(startTime),
  };
};

HMR 支持

在开发模式下运行时，builder 的开发服务器必须能够在故事、组件或辅助函数发生更改时重新加载页面。