Vanilla Extract在Turborepo+Next.js14项目中的配置问题解析

问题背景

在基于Turborepo的monorepo项目中，开发者尝试使用Vanilla Extract构建的设计系统(@repo/ui)时遇到了构建错误。错误表现为Next.js应用无法正确处理Vanilla Extract生成的CSS文件，控制台显示vanilla.virtual.css文件存在语法错误。

错误现象

当在Next.js 14应用中导入设计系统的组件时，控制台报错如下：

Syntax error: ...\vanilla.virtual.css Unknown word
  23 | }
  24 | options => {
> 25 |     var className = config.defaultClassName;
     |     ^

根本原因分析

经过排查，发现该问题主要由两个配置问题导致：

1. Next.js配置错误：原始的next.config.js文件中，transpilePackages配置被错误放置，导致Next.js无法正确转译monorepo中的设计系统包。

2. 插件顺序问题：Vanilla Extract插件需要正确包裹Next.js配置才能生效，但原始配置中插件应用方式不正确。

解决方案

正确的Next.js配置

修正后的next.config.js应采用以下结构：

const { createVanillaExtractPlugin } = require('@vanilla-extract/next-plugin');
const withVanillaExtract = createVanillaExtractPlugin();

/** @type {import('next').NextConfig} */
const nextConfig = {
  transpilePackages: ['@repo/ui'],
  // 其他Next.js配置...
};

module.exports = withVanillaExtract(nextConfig);

关键配置要点

1. transpilePackages：必须明确列出需要转译的monorepo包名，确保Next.js能正确处理这些包中的代码。

2. 插件包裹顺序：Vanilla Extract插件必须包裹最终的Next.js配置对象，这样才能确保CSS处理流程正确。

3. 依赖版本对齐：确保项目中使用的Vanilla Extract相关插件版本一致，避免因版本不匹配导致的问题。

最佳实践建议

1. monorepo项目结构：在Turborepo项目中，建议将设计系统作为一个独立工作区(workspace)管理。

2. 依赖管理：使用pnpm workspace协议(workspace:*)确保各包依赖版本一致。

3. 构建缓存：利用Turborepo的缓存机制加速构建过程。

4. 类型安全：通过TypeScript项目引用(project references)确保类型定义正确传递。

总结

在monorepo架构下使用Vanilla Extract需要特别注意构建工具的配置。通过正确配置Next.js的转译选项和插件顺序，可以解决大多数集成问题。对于复杂项目，建议逐步验证各环节配置，确保设计系统的样式能够正确编译和应用到主应用中。