解决Lingui项目中Next.js与Yarn PnP的SWC插件兼容性问题

在Lingui项目的Next.js示例中，当使用Yarn PnP(nodeLinker: pnp)模式时，可能会遇到SWC插件无法正常工作的问题。本文将深入分析问题原因并提供多种解决方案。

问题背景

在使用Lingui的nextjs-swc示例项目时，如果配置Yarn 4.x并启用PnP模式(nodeLinker: pnp)，运行应用会出现"Internal Server Error"和"index not found"等错误。这些错误主要源于SWC插件系统与Yarn PnP的兼容性问题。

根本原因分析

经过验证，这个问题实际上是SWC项目本身对Yarn PnP支持不足导致的。SWC目前尚未完全支持通过Yarn PnP加载WASM插件，这是上游项目的一个已知限制。

解决方案

1. 使用node-modules链接器

最简单的解决方案是在.yarnrc.yml中配置nodeLinker: node-modules，回退到传统的node_modules模式。这种方法不需要任何额外配置，但会失去PnP的优势。

2. WASM插件手动复制方案

对于希望保持PnP优势的用户，可以采用手动复制WASM插件文件的方案：

1. 创建一个脚本文件(copy-lingui-swc-plugin.js)，内容如下：

import path from 'node:path';
import yarnfslib from '@yarnpkg/fslib';
import yarnlibzip from '@yarnpkg/libzip';
import pnpapi from 'pnpapi';

const { PosixFS } = yarnfslib;
const { getLibzipSync, ZipOpenFS } = yarnlibzip;
const { resolveRequest, resolveVirtual } = pnpapi;

const libzip = getLibzipSync();
const zipOpenFs = new ZipOpenFS({ libzip });
const crossFs = new PosixFS(zipOpenFs);

const swcPluginPathFromYarnCache = resolveVirtual(
  resolveRequest('@lingui/swc-plugin', process.cwd())
);

if (!crossFs.existsSync('./bin')) {
  crossFs.mkdirSync('./bin');
}

const copiedSwcPluginPath = path.resolve('./bin/lingui_swc_plugin.wasm');
crossFs.copyFileSync(swcPluginPathFromYarnCache, copiedSwcPluginPath);

export default copiedSwcPluginPath;

2. 在next.config.js中引用复制的WASM文件：

import path from 'node:path';
const linguiSwcPluginPath = path.resolve('./bin/lingui_swc_plugin.wasm');

const nextConfig = {
  experimental: {
    swcPlugins: [[linguiSwcPluginPath, {}]],
  },
  // 其他配置...
};

3. 在package.json中添加postinstall脚本自动执行复制：

{
  "scripts": {
    "postinstall": "node scripts/copy-lingui-swc-plugin.js"
  }
}

3. 使用unplug命令

另一种更简单的方法是使用Yarn的unplug命令：

yarn unplug @lingui/swc-plugin

这个命令会将指定的包从PnP虚拟存储中解压到磁盘上的真实位置，使其能够被SWC正常加载。

方案比较

方案	优点	缺点
node-modules	简单直接，无需额外配置	失去PnP的优势
WASM复制	保持PnP优势，稳定可靠	需要额外脚本和维护
unplug命令	最简单快捷的解决方案	需要记住在每次安装后执行

最佳实践建议

对于大多数项目，推荐使用yarn unplug方案，它既简单又能解决问题。对于需要长期稳定运行的生产环境，WASM复制方案可能更为可靠。如果项目对PnP没有硬性要求，使用node-modules模式是最省事的解决方案。

随着SWC对PnP支持的完善，这个问题未来可能会得到根本解决。在此之前，上述方案都能有效解决问题，开发者可以根据项目需求选择最适合的方法。