Monorepo 中如何方便地引用公共代码库?

monorepo 中如何方便地引用公共代码库?

monorepo 路径别名配置指南

在 monorepo 架构中,子项目可能需要引用公共代码库中的模块。为了简化引用过程,可以通过配置路径别名来访问这些模块。

以给定的拓扑图为例,common 是 a、b、c 三个项目公共引用的代码库。以下是如何为 common 配置路径别名,以便在 a、b、c 项目中引用它:

pnpm

支持 monorepo 的工具通常提供自己的协议来访问内部包。以 pnpm 为例:

a/package.json

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

common/package.json

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

通过上述配置,可以在 a 项目中使用 import common from "workspace:common"; 来引用 common 模块。其他工具也提供了类似的路径别名配置机制。

在生产环境下,包之间的引用有以下几种方案:

  • 使用构建守望(build watch)模式:
    所有包在开发环境中使用 build --watch 模式,无需配置别名。ただし、包需要按依赖顺序构建,且不能有循环依赖。
  • 配置路径别名:
    所有包在开发环境中正常启动,但都需要为对应的包配置别名。
  • 替换入口文件:
    开发环境下,通过脚本将每个包的 package.json 中的入口文件替换为源码入口。生产环境中再替换回构建产物的入口。

以上就是Monorepo 中如何方便地引用公共代码库?的详细内容,更多请关注其它相关文章!