React Strict Dom 项目中 StyleX 运行时问题的分析与解决

问题背景

在开发基于 React Strict Dom (RSD) 的 npm 组件库时，开发者遇到了一个典型问题：当组件库被 Vite 项目引用时，控制台会抛出 'stylex.create' should never be called at runtime 的错误。这个问题本质上反映了 StyleX 样式系统在构建流程中的编译处理不当。

核心问题分析

StyleX 作为 Facebook 推出的 CSS-in-JS 解决方案，其设计理念是将样式在构建时(build time)而非运行时(runtime)进行编译处理。这与传统的 CSS-in-JS 库(如 styled-components)有着本质区别。

当错误提示显示 stylex.create 被运行时调用时，说明以下两种情况之一发生了：

1. 组件库的代码未经 StyleX 的 Babel 插件处理就被直接发布
2. 主项目没有正确配置对 node_modules 中依赖的编译处理

解决方案详解

组件库开发侧的正确实践

1. 源码发布策略：组件库必须发布未经编译的源代码(通常保留在 src 目录)，而非编译后的 bundle。这是因为 StyleX 的样式转换需要在最终使用项目的构建流程中完成。

2. 构建配置示例：

// 正确的 babel 配置应包含对 StyleX 的支持
module.exports = {
  presets: ['module:metro-react-native-babel-preset'],
  plugins: [
    ['@stylexjs/babel-plugin', {
      dev: process.env.NODE_ENV === 'development',
      runtimeInjection: false,
      styleResolution: 'property-specificity'
    }]
  ]
};

主项目侧的正确配置

在使用 Vite 的项目中，需要特别注意：

1. 依赖编译包含：默认情况下，Vite 不会编译 node_modules 中的依赖。需要通过配置显式包含你的组件库：

// vite.config.js
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'

export default defineConfig({
  plugins: [
    react({
      babel: {
        plugins: [
          ['@stylexjs/babel-plugin', { /* 配置选项 */ }]
        ],
        // 关键配置：包含需要编译的依赖
        include: ['ike-rsd']
      }
    })
  ]
})

2. 开发环境区分：确保开发和生产环境使用正确的 StyleX 配置，开发环境可能需要额外的调试支持。

跨平台兼容性考虑

对于需要同时支持 React Native 和 Web 的项目，还需要注意：

1. 平台检测逻辑：避免在组件库中使用硬编码的平台检测，而是依赖 React Strict Dom 提供的平台抽象层。

2. 样式隔离：确保 Web 和 Native 的样式定义相互隔离，防止样式污染。

最佳实践建议

1. 构建流程标准化：在 monorepo 中统一管理构建配置，确保所有项目使用相同的 StyleX 编译设置。

2. 文档说明：在组件库的 README 中明确说明对 StyleX 的依赖和必要的构建配置。

3. 版本锁定：严格锁定 StyleX 和 React Strict Dom 的版本，避免因版本不匹配导致的编译问题。

通过以上措施，开发者可以构建出同时支持 React Native 和 Web 平台的通用组件库，同时避免 StyleX 运行时错误的问题。