在Extension.js项目中实现Monorepo支持的实践指南

背景介绍

Extension.js是一个用于开发浏览器扩展的框架，其默认配置在处理单仓库项目时存在一定局限性。本文将详细介绍如何在Extension.js项目中实现Monorepo支持，解决跨包引用和编译问题。

问题分析

在Monorepo结构中，Extension.js默认的swc-loader配置仅包含manifest.json所在目录的文件，导致以下问题：

1. 无法直接引用其他包中的TypeScript/JavaScript文件
2. 跨包引用时出现模块解析错误
3. 开发体验下降，需要手动修改引用路径

解决方案

方案一：使用scripts目录中转

Extension.js官方建议在manifest.json同级目录下创建scripts目录，作为跨包引用的中转站：

/my-repo
    /extension
        /scripts
            package-a.ts # 导入../../packages/package-a
    /packages
        /package-a

这种方案简单易行，但需要开发者手动维护中转文件，可能影响开发体验。

方案二：自定义Webpack插件

更完善的解决方案是创建一个自定义Webpack插件，扩展swc-loader的包含范围：

const path = require('path');

class MonorepoPlugin {
  apply(compiler) {
    const monorepoRoot = path.join(process.cwd(), "..");
    
    compiler.options.module.rules = [
      {
        test: /\.(js|mjs|jsx|mjsx|ts|mts|tsx|mtsx)$/,
        include: [monorepoRoot],
        exclude: /node_modules/,
        use: {
          loader: require.resolve("swc-loader"),
          options: {
            sync: true,
            module: { type: "es6" },
            minify: compiler.options.mode === "production",
            isModule: true,
            jsc: {
              target: "es2016",
              parser: {
                syntax: "typescript",
                tsx: true,
                jsx: true,
                dynamicImport: true,
              },
              transform: {
                react: {
                  development: compiler.options.mode === "development",
                  refresh: compiler.options.mode === "development",
                  runtime: "automatic",
                  importSource: "react",
                },
              },
            },
          },
        },
      },
      ...compiler.options.module.rules,
    ];
  }
}

方案三：结合路径别名

对于使用路径别名的项目，需要在swc-loader配置中添加对应的路径映射：

jsc: {
  baseUrl: currentDir,
  paths: {
    '@/convex/*': ['../api/src/*'],
    '~/*': ['../../packages/webui/src/*'],
  },
}

最佳实践建议

1. 使用内部包模式：避免直接引用其他包的源码，而是通过package.json定义正式依赖关系
2. 注意模块类型：确保package.json中的"type"字段与项目需求一致
3. 避免CSS加载器冲突：不要重复定义CSS相关规则，以免与Extension.js默认配置冲突
4. 开发环境优化：根据开发/生产环境配置不同的swc-loader选项

常见问题解决

1. ERR_REQUIRE_ESM错误：移除package.json中的"type": "module"声明
2. POSTCSS加载失败：检查是否有重复的CSS规则定义
3. 路径解析失败：确保swc-loader配置中的路径映射与tsconfig.json一致

总结

通过自定义Webpack插件扩展Extension.js的编译范围，开发者可以轻松实现Monorepo支持。建议优先采用内部包模式，通过package.json管理依赖关系，而非直接引用其他包的源码。这种方法既保持了开发便利性，又确保了项目的可维护性。