在extension.js项目中配置swc-loader支持Monorepo项目的最佳实践

在开发浏览器扩展时，使用extension.js工具链可以极大简化开发流程。然而，当项目采用Monorepo结构时，开发者可能会遇到TypeScript/JavaScript文件编译问题。本文将深入分析问题根源，并提供多种解决方案。

问题背景

在Monorepo项目中，常见目录结构如下：

/my-repo
    /extension
    /packages
        /package-a
        /package-b

当extension包需要引用其他内部包的未编译TypeScript代码时，默认配置会导致webpack编译失败，错误提示需要额外的loader处理.ts文件。这是因为extension.js默认只配置了对manifest.json所在目录的swc-loader支持。

根本原因分析

extension.js内部使用JsFrameworksPlugin插件配置swc-loader时，设置了严格的include规则：

include: [path.dirname(this.manifestPath)]

这种配置限制了swc-loader只处理manifest文件所在目录下的文件，导致Monorepo中其他包的TypeScript文件无法被正确处理。

解决方案

方案一：使用scripts目录中转

extension.js会自动将scripts目录下的文件作为入口点处理。可以创建scripts目录作为中转：

/extension
    /scripts
        package-a.ts  // 内容：export * from "@repo/package-a"
        package-b.ts  // 内容：export * from "@repo/package-b"

然后在代码中引用：

import { something } from '~/scripts/package-a'

方案二：自定义Monorepo插件

更彻底的解决方案是创建自定义webpack插件，扩展swc-loader的include范围：

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: {
            // 详细配置...
          }
        }
      },
      ...compiler.options.module.rules
    ];
  }
}

在extension.config.js中使用：

module.exports = {
  config: (config) => {
    config.plugins.push(new MonorepoPlugin());
    return config;
  }
};

方案三：使用内部包模式

最佳实践是采用内部包模式，即在Monorepo中每个包都是独立的npm包，通过package.json的exports字段暴露接口：

1. 在package-a/package.json中配置：

{
  "name": "@repo/package-a",
  "exports": {
    ".": {
      "types": "./src/index.d.ts",
      "import": "./dist/index.js"
    }
  }
}

2. 在extension中正常导入：

import { something } from '@repo/package-a'

注意事项

1. 路径别名配置：如果使用路径别名，需要在swc-loader的jsc.paths中同步配置
2. 模块类型：确保package.json中的type字段与项目需求一致
3. CSS处理：自定义配置时注意不要重复添加CSS相关loader
4. 依赖管理：确保所有引用到的依赖在extension包中都有声明

总结

在extension.js项目中支持Monorepo有多种方案，开发者可以根据项目复杂度选择适合的方式。对于简单项目，scripts目录中转足够；对于复杂项目，建议采用内部包模式配合自定义插件，既能保持代码整洁，又能确保编译正确性。无论采用哪种方案，都要注意依赖管理和路径解析的一致性。