Monorepo保姆级教程

498 阅读2分钟

Monorepo是一种将多个项目或组件存储在一个统一的代码仓库中的策略,旨在提高代码复用性和团队协作效率。以下是一个详细的Monorepo管理多个项目的保姆级教程:

1. 初始化项目

首先,创建一个新的项目目录并初始化为Git仓库:

mkdir my_monorepo
cd my_monorepo
git init

2. 创建子包

在项目根目录下创建多个子包,每个子包可以是一个独立的库或应用:

mkdir -p packages/pkg1 packages/pkg2

3. 版本控制

将项目提交到Git仓库:

git add .
git commit -m "Initial commit"

4. 使用 Lerna 管理 Monorepo

Lerna 是一个优化管理多包存储库工作流程的工具,可以与 yarn workspaces 结合使用。

安装 Lerna

npm install -g lerna

初始化 Lerna 项目

lerna init

创建子项目

packages 目录下创建子项目,并在每个子项目中运行 npm inityarn init

配置 package.json

在根目录的 package.json 中添加 workspaces 字段:

{
  "private": true,
  "workspaces": ["packages/*"]
}

5. 使用 Yarn Workspaces

Yarn Workspaces 允许在 Monorepo 中共享依赖项,只需运行一次 yarn install 即可安装所有包。

配置 package.json

在根目录的 package.json 中添加 workspaces 字段:

{
  "private": true,
  "workspaces": ["packages/*"]
}

安装依赖

在根目录下运行:

yarn install

6. 使用 pnpm 管理 Monorepo

pnpm 是一种包管理工具,支持 Workspaces,可以高效管理依赖项。

安装 pnpm

npm install -g pnpm

初始化项目

pnpm init

创建子项目

packages 目录下创建子项目,并在每个子项目中运行 pnpm init

配置 pnpm-workspace.yaml

在根目录下创建 pnpm-workspace.yaml 文件:

packages:
  - 'packages/*'

安装依赖

在根目录下运行:

pnpm install

7. 共享代码

在 Monorepo 中,可以通过软链接共享代码。例如,假设有一个 shared 子项目,其他子项目可以通过以下命令添加依赖:

pnpm add shared

8. 运行脚本

可以使用 pnpm recursive 命令在所有或部分子项目中运行脚本:

pnpm recursive run build

通过以上步骤,你可以成功搭建和管理一个 Monorepo 项目,实现代码复用和高效协作。