解决 twin.macro 在 Storybook v8 中的兼容性问题

问题背景

twin.macro 是一个结合了 Tailwind CSS 和 styled-components 的强大工具，它允许开发者在 CSS-in-JS 环境中使用 Tailwind 的实用类。然而，当升级到 Storybook v8 时，许多开发者遇到了构建失败的问题。

错误现象

在 Storybook v8 环境下，当组件中使用了 twin.macro 或基于 twin.macro 的样式组件时，会出现以下典型错误：

1. 模块解析失败：无法解析 'module'、'v8' 和 'perf_hooks' 等核心 Node.js 模块
2. Webpack 编译错误
3. Babel 插件未正确加载的警告

根本原因分析

经过深入调查，发现问题的核心在于 Storybook v8 的架构变化。新版本对构建工具链进行了重大调整，特别是对 Babel 的处理方式发生了变化。

关键点在于：

1. Storybook v8 默认不再自动加载项目中的自定义 Babel 配置
2. twin.macro 依赖 babel-plugin-macros 进行代码转换
3. 当 Babel 配置未正确加载时，twin.macro 无法正常工作

解决方案

要解决这个问题，需要采取以下步骤：

1. 安装 Storybook 的 Webpack5 Babel 编译器插件

   npm install --save-dev @storybook/addon-webpack5-compiler-babel
   

2. 在 Storybook 配置文件中注册该插件

   // .storybook/main.js
   module.exports = {
     addons: [
       '@storybook/addon-webpack5-compiler-babel'
     ],
     // 其他配置...
   }
   

3. 确保项目中的 Babel 配置正确包含 twin.macro 所需的插件

验证配置

为了验证 Babel 配置是否正确加载，可以运行以下命令：

BABEL_SHOW_CONFIG_FOR=.storybook/preview.tsx npm run storybook

这将显示 Storybook 实际使用的 Babel 配置，确保其中包含了 twin.macro 所需的所有插件和预设。

最佳实践

1. 保持依赖更新：定期更新 twin.macro 和 Storybook 到最新版本，以获得最佳兼容性
2. 明确依赖关系：确保项目中的 Babel 相关依赖版本一致
3. 隔离配置：为 Storybook 创建单独的 Babel 配置（如果需要）
4. 监控构建过程：使用 --debug-webpack 参数运行 Storybook 以获取更详细的构建信息

总结

Storybook v8 带来了许多改进，但也改变了构建工具链的工作方式。通过添加 Webpack5 Babel 编译器插件，我们可以确保 twin.macro 能够继续在 Storybook 环境中正常工作。这一解决方案不仅解决了当前的兼容性问题，也为未来的升级奠定了更稳定的基础。

对于使用 twin.macro 的开发团队来说，理解这一变化并相应调整配置，将有助于保持开发流程的顺畅和高效。