Monorepo 项目中，如何配置路径别名来解决包间引用问题？

monorepo 路径别名的配置：解决包间引用问题

在 monorepo 项目中，常遇到项目之间相互依赖的问题。下面展示一种解决方案，通过配置路径别名，让包间引用更方便。

问题概述：

如下图拓扑图所示，假设 common 是 a、b、c 三个项目的公共依赖。我们需要给 common 配置路径别名，并且使引用它的包（a、b、c）也能生效。

root
├── package.json
├── pnpm-workspace.yaml
├── packages
  ├── common
    ├── package.json
  ├── utils
    ├── package.json
  ├── a
    ├── package.json
  ├── b
    ├── package.json
  ├── c
    ├── package.json

解决方案：

使用支持 workspace 的工具，如 pnpm，提供专用协议访问内部包。

pnpm 中的别名配置：

1. 修改 common 的 package.json，指定别名：

{
    "name": "common",
    "version": "1.0.0",
    "dependencies": {
        "a": "workspace:^1.0.0",
    }
}

2. 修改引用 common 的 a 的 package.json，指定依赖别名：

{
    "name": "a",
    "version": "1.0.0",
    "devDependencies": {
        "common": "workspace:^1.0.0",
    }
}

通过这种配置，当 a 引用 common 时，会使用指定别名，确保 a 可以正常工作。

其它引用方案：

在不同场景中，包间互相引用的方案还有：

• 开发环境下，通过 watch 方式构建，无需配置别名，但需要按依赖顺序构建，且不能有循环依赖。
• 全部项目配置别名。
• 编写脚本，动态替换不同环境下的入口文件。