如何使用PNPM管理Monorepo项目？一站式提升开发效率的指南

随着前端开发项目的日益复杂化，Monorepo 的使用逐渐成为现代前端工程中的重要趋势。传统上，开发者们通常使用多个 Git 仓库来管理不同的项目，而 Monorepo 的理念则是将所有子项目集中在同一个 Git 仓库中进行管理，即所有的子项目都存放在根目录的packages目录下，简化协作和提高效率。PNPM 作为当前最快速且节省磁盘空间的包管理工具，在 Monorepo 项目管理中展现了其独特的优势。本文将深入探讨 PNPM 在 Monorepo 项目中的应用，从零开始构建高效的开发环境。

文章导航

什么是 Monorepo？

Monorepo 是一种将多个项目或包文件放入同一个 Git 仓库进行管理的开发模式。其主要结构通常如下：

├── packages
|   ├── pkg1
|   |   ├── package.json
|   ├── pkg2
|   |   ├── package.json
├── package.json
├── pnpm-workspace.yaml

在 Monorepo 模式下，packages 目录下的每个子文件夹代表一个项目或包，这种方式的核心优势在于：

代码复用：多个项目可以共享代码，避免重复开发。
统一开发流程：所有项目在同一个 Git 仓库中，开发流程一致。
高效管理：便于集中管理、发布和版本控制，尤其是对于多项目依赖的情况。

为什么选择 PNPM？

与常见的 Yarn 和 NPM 相比，PNPM 在 Monorepo 项目中展现了更多独特的优势：

安装速度极快：PNPM 采用非扁平的包结构，不使用yarn/npm复杂的扁平算法，并且仅更新发生变化的文件，极大提升了安装速度。
节省磁盘空间：PNPM 会将安装的包统一存放在磁盘的某个位置，项目中的node_modules通过hard-link的方式链接到实际的安装地址，有效减少磁盘占用。

这些优势使得 PNPM 成为管理 Monorepo 项目的不二选择，特别是在多个项目间需要频繁共享代码时，PNPM 的节省空间和高效安装能力尤为突出。

如何使用 PNPM 构建 Monorepo？

以下是使用 PNPM 管理 Monorepo 项目的步骤：

1. 初始化项目

在项目根目录下创建 package.json 文件，并初始化项目：

pnpm init

随后，新建一个名为 pnpm-workspace.yaml 的文件以及 packages 文件夹（用于存放各个子项目），这两者是 PNPM 管理 Monorepo 项目的固定格式。

2. 创建多个子项目

然后在你的packages 下可创建多个文件夹（一般一个项目代表一个文件夹），并分别初始化你的项目（就像平常构建项目一样构建、只不过是在packages 文件夹下面）

分别初始化每个项目执行 pnpm init
然后正常构建项目

# 初始化 pkg1 子项目
cd packages/pkg1
pnpm init

此时，每个项目的开发流程与普通项目无异，只是它们都位于同一个 Git 仓库中，便于集中管理。

3. 全局与局部安装依赖

在 Monorepo 中，可以选择在根目录下或具体的项目中安装依赖。在这里的项目打包我是用的 vite。

在根目录安装vite（由于vite是两个项目都使用，可在根目录执行命令如下）

# 此处的 -w 正是因为 pnpm 本身支持monorepo。他代表其他项目共用这个包
pnpm i vite --save-dev -w

然后对于某个项目特定的包

pnpm --filter 具体项目文件名 add 包名

4. 如何统一或者单独在根目录下执行你的项目

分别配置项目中的package.json（根目录下的除外）中的脚本如图所示（此处是 vite 配置）

"dev": "vite",
"build": "vite build",

然后在根目录下安装一个包名为 concurrently 的包实现多个项目同时打包或运行

pnpm i concurrently --save-dev -w

然后在根下的package.json中统一配置

{
  "scripts": {
    "dev:main": "pnpm -C ./packages/main run dev",
    "dev:plugins": "pnpm -C ./packages/plugins run dev",
    "build:main": "pnpm -C ./packages/main run build",
    "build:plugins": "pnpm -C ./packages/plugins run build",
    "dev": "concurrently \"pnpm dev:main\" \"pnpm dev:plugins\"",
    "build": "concurrently \"pnpm build:main\" \"pnpm build:plugins\"",
    "test": "echo \"Error: no test specified\" && exit 1"
  }
}