解决 twin.macro 中 styled-components/jsx-dev-runtime 解析问题

2025-05-28 08:04:32作者：余洋婵Anita

🦹‍♂️ Twin blends the magic of Tailwind with the flexibility of css-in-js (emotion, styled-components, solid-styled-components, stitches and goober) at build time.

项目地址：https://gitcode.com/gh_mirrors/tw/twin.macro

问题背景

在使用 Next.js 与 NX 结合 twin.macro 时，开发者经常会遇到一个常见错误："Can't resolve 'styled-components/jsx-dev-runtime'"。这个问题通常出现在配置 styled-components 和 twin.macro 的过程中，特别是在 Next.js 项目中。

问题分析

这个错误表明系统无法找到 styled-components 的 JSX 运行时模块。这通常发生在以下几种情况：

styled-components 版本不兼容
Babel 配置不正确
Next.js 配置存在问题
编译时缺少必要的运行时支持

解决方案

1. 检查 styled-components 版本

首先确保安装了正确版本的 styled-components。对于 Next.js 项目，推荐使用最新稳定版：

npm install styled-components@latest
# 或
yarn add styled-components@latest

2. 完整的 Babel 配置

正确的 Babel 配置应该包含以下关键部分：

{
  "presets": [
    [
      "next/babel",
      {
        "preset-react": {
          "runtime": "automatic",
          "importSource": "styled-components"
        }
      }
    ]
  ],
  "plugins": [
    "babel-plugin-macros",
    [
      "babel-plugin-styled-components",
      {
        "ssr": true,
        "displayName": true
      }
    ],
    "babel-plugin-twin"
  ]
}

3. Next.js 配置调整

在 next.config.js 中确保正确配置了 styled-components 编译器：

module.exports = {
  compiler: {
    styledComponents: true
  }
}

4. 自定义运行时解决方案

借鉴 Emotion 的实现思路，我们可以创建一个自定义的样式注册表组件来管理样式：

'use client';
import { CacheProvider } from '@emotion/react';
import createCache from '@emotion/cache';
import { useServerInsertedHTML } from 'next/navigation';
import { useState } from 'react';

const StyleRegistry = ({ children }) => {
  const [cache] = useState(() => {
    const cache = createCache({ key: 'css' });
    cache.compat = true;
    return cache;
  });

  useServerInsertedHTML(() => (
    <style
      data-emotion={`${cache.key} ${Object.keys(cache.inserted).join(' ')}`}
      dangerouslySetInnerHTML={{
        __html: Object.values(cache.inserted).join(' '),
      }}
    />
  ));

  return <CacheProvider value={cache}>{children}</CacheProvider>;
};

export default StyleRegistry;

然后在应用的根组件中包裹这个注册表：

import StyleRegistry from './StyleRegistry';

export default function RootLayout({ children }) {
  return (
    <html>
      <body>
        <StyleRegistry>{children}</StyleRegistry>
      </body>
    </html>
  );
}

深入理解

这个问题的本质在于 styled-components 在服务器端渲染(SSR)时的运行时支持。Next.js 13+ 使用新的 App Router 架构后，样式管理变得更加复杂。自定义的 StyleRegistry 组件通过以下方式工作：

创建一个 Emotion 缓存实例来管理样式
使用 useServerInsertedHTML 钩子在服务器渲染时注入样式
确保客户端和服务器端的样式一致性

最佳实践建议

版本一致性：确保 styled-components、twin.macro 和 Next.js 的版本兼容
配置检查：仔细检查 Babel 和 Next.js 配置中的每一个选项
逐步调试：如果问题仍然存在，尝试逐步移除配置，找到最小可复现案例
社区支持：查阅 twin.macro 和 styled-components 的官方文档和社区讨论

总结

解决 "Can't resolve 'styled-components/jsx-dev-runtime'" 错误需要综合考虑 Babel 配置、Next.js 设置和运行时环境。通过正确的配置和自定义样式管理组件，可以有效地解决这个问题，使 twin.macro 在 Next.js 项目中正常工作。理解这些工具如何协同工作，将有助于开发者更好地处理类似的前端构建问题。

twin.macro