在extension-create项目中配置swc-loader以支持Monorepo开发

背景介绍

在extension-create项目中开发浏览器扩展时，开发者经常会遇到在monorepo架构下无法正确处理TypeScript文件的问题。当扩展项目需要引用monorepo中其他包的未编译TypeScript代码时，默认的webpack配置会导致编译失败，因为swc-loader的include规则仅限定了manifest文件所在目录。

问题分析

在monorepo结构中，典型的目录布局可能如下：

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

当extension包需要直接引用package-a或package-b中的TypeScript源码时，由于extension-create默认配置的swc-loader仅包含manifest文件所在目录，会导致这些外部TypeScript文件无法被正确处理，出现类似"Module parse failed"的错误。

解决方案

方案一：使用scripts目录作为入口

extension-create项目支持在manifest同级目录下创建scripts目录，该目录下的所有js-like文件都会被当作顶级入口处理。开发者可以在此目录下创建中转文件来引用monorepo中的其他包。

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

方案二：自定义webpack插件

更灵活的解决方案是创建一个自定义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: {
            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,
    ];
  }
}

然后在extension.config.js中注册该插件：

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

方案三：配置路径别名

对于使用路径别名的项目，还需要在swc-loader配置中添加对应的baseUrl和paths设置：

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

注意事项

1. 确保package.json中的"type"字段设置正确。如果使用CommonJS模块(extension.config.js)，需要移除"type": "module"。

2. 避免直接引用其他包的相对路径，推荐使用monorepo内部包机制，即在其他包的package.json中正确定义exports和types字段。

3. 对于CSS处理，注意不要重复添加postcss-loader规则，以免与默认配置冲突。

4. 使用pnpm时内部包引用工作更可靠，使用npm/yarn可能需要额外配置。

最佳实践

虽然直接引用其他包的源码可以工作，但从工程角度考虑，推荐以下做法：

1. 将共享代码封装为正式的内部包，在package.json中正确定义入口和类型
2. 使用明确的导入路径，而非相对路径或别名
3. 保持各包的依赖关系清晰，避免隐式依赖
4. 考虑构建流程，确保各包可以独立构建

通过合理配置extension-create的webpack设置，开发者可以充分利用monorepo的优势，在保持项目结构清晰的同时，实现代码的高效共享和热更新。