Storybook Vitest插件中预览配置脚本加载问题的分析与解决方案

问题背景

在Storybook项目中，开发者经常需要在预览环境中注入自定义脚本或样式。通常我们会通过previewHead或previewBody配置项来实现这一需求，例如在.storybook/main.js中：

export default {
  previewHead: (head) => `
    ${head}
    ${
      process.env.ANALYTICS_ID ? '<script src="https://cdn.example.com/analytics.js"></script>' : ''
    }
  `,
};

然而，当使用Storybook的Vitest插件进行组件测试时，这些自定义脚本却无法正常工作。这是因为Vitest插件目前没有正确处理Storybook的预览配置，导致测试环境与实际的Storybook预览环境存在差异。

问题影响

这种不一致性会带来几个实际问题：

1. 测试结果不准确：如果组件依赖这些注入的脚本或样式，测试结果可能与实际运行效果不符
2. 环境差异：开发者在Storybook中看到的效果与测试结果不一致，增加了调试难度
3. 功能缺失：如分析脚本、全局样式等关键功能在测试中失效

技术分析

Vitest作为Vite原生的测试框架，其运行机制与Storybook的预览环境有所不同。Storybook在构建预览页面时会处理previewHead和previewBody配置，而Vitest默认不会考虑这些配置。

Vite提供了transformIndexHtml插件钩子，可以在构建过程中修改HTML内容。这正是解决这个问题的关键所在。

解决方案

方案一：官方插件改进

理想的解决方案是让Storybook的Vitest插件内部集成对预览配置的支持。具体实现思路是：

1. 在Vitest插件中读取Storybook的配置
2. 使用Vite的transformIndexHtml钩子注入previewHead和previewBody内容
3. 保持与Storybook预览环境的一致性

示例实现逻辑：

const previewHeadPlugin = (previewHead) => {
  return {
    name: 'storybook-preview-head-injection',
    transformIndexHtml(html) {
      return html.replace('</head>', `${previewHead}</head>`)
    },
  }
}

方案二：临时解决方案

在官方修复前，开发者可以手动创建Vite插件来解决：

1. 创建自定义Vite插件
2. 在Vitest配置中应用该插件
3. 确保与Storybook配置一致

// vitest.config.ts
import { defineWorkspace } from 'vitest/config'

export default defineWorkspace([
  { 
    extends: '.storybook/vite.config.ts', 
    plugins: [ 
      storybookTest(),
      customPreviewHeadPlugin(`
        <style>
          body { background: yellow !important; }
        </style>
      `),
    ] 
  }
])

最佳实践建议

1. 环境一致性检查：建立自动化检查机制，确保测试环境与预览环境一致
2. 配置集中管理：将关键配置集中管理，避免分散在多处
3. 渐进式迁移：对于复杂项目，逐步迁移到新的测试方案

总结

Storybook Vitest插件目前对预览配置的支持不足是一个需要注意的问题。虽然可以通过自定义插件临时解决，但长期来看，官方插件的改进才是最佳方案。开发者在使用过程中应当注意环境差异，确保测试结果能够真实反映组件在Storybook中的表现。

对于依赖特定脚本或样式的组件，建议编写专门的测试用例来验证这些依赖项是否按预期工作，从而保证组件在各种环境中的一致性。