PNPM Workspace - 如何高效优雅的管理 Monorepo 项目

前言

在现代的软件开发中，Monorepo（单仓库）模式越来越受到青睐。Monorepo 允许你将多个项目置于同一个版本控制系统中管理，简化了很多项目间依赖和协调的工作。然而，Monorepo 管理也并非易事，尤其是当涉及到 JavaScript 生态系统中的依赖管理时。

本文将介绍如何使用 PNPM 来优雅地管理 Monorepo，确保依赖清晰、高效和简洁。

PNPM 简介

PNPM 是一个快速、节省磁盘空间的包管理工具，用于 JavaScript 和 Node.js。它通过利用硬链接和符号链接的方式来重用存储在全局内容地址able存储中的文件，从而减少了重复的内容下载和存储。这使得 PNPM 在处理大型代码库或 Monorepo 时，表现出极高的效率。

PNPM Workspace 的优势

• 高效的存储方式：PNPM 使用独特的链接方法存储 node_modules，减少了磁盘空间的占用。
• 一致性与隔离：每个包都可以有独立的依赖版本，但又存储在同一个物理位置，避免了重复而导致的冲突。
• 工作区（Workspace）支持：PNPM 原生支持工作区概念，使得在多包场景下的管理变得简单。

PNPM 管理 Monorepo 步骤

1. 安装 PNPM

首先，你需要在你的机器上安装 PNPM：

bash
npm install -g pnpm

2. 初始化项目

接下来，创建一个新的目录作为你的 Monorepo 工作区根目录，并在其中初始化一个新的项目：

bash
mkdir my-monorepo
cd my-monorepo
pnpm init -y

3. 创建子包

在 Monorepo 中，每一个子项目或包都是独立管理的。创建子包很简单：

bash
mkdir packages
cd packages
pnpm create @my-scope/my-first-package
cd my-first-package
pnpm init -y

重复以上步骤可以创建更多的子包。

4. 配置工作区

在 Monorepo 的根目录下创建一个 pnpm-workspace.yaml 文件，定义工作区的配置：

yaml
packages:
  - 'packages/**'

这告诉 PNPM，packages 目录下的所有目录都是独立的包。

5. 安装依赖和链接

当你需要为某个包安装依赖时，只需在那个包的目录中运行：

bash
pnpm add lodash

如果你想为所有工作区的包同时添加依赖，可以使用 -r 或 --recursive 选项：

bash
pnpm add lodash -r

链接工作区中的包也非常简单：

bash
pnpm install

这将自动处理所有内部依赖的链接。

6. 运行和构建

PNPM 支持使用 pnpm run 命令在 Monorepo 的任何包中运行脚本。使用 -r 选项可以在所有包中运行脚本：

bash
pnpm run build -r

这会在每个包中寻找 build 脚本并执行。

总结

使用 PNPM 管理 Monorepo 不仅可以显著提高依赖管理的效率，还可以通过它的工作区特性简化跨包操作。这种方式为大规模项目和团队合作提供了极大的便利。

如果你正在寻找一个高效且现代的 Monorepo 管理工具，PNPM 绝对值得尝试。