使用 Lerna 掌握 Monorepos：综合指南

简介

管理具有多个相互依赖的包的大型项目对许多开发团队来说是一个挑战。传统方法通常涉及为每个包使用多个存储库，这可能会导致代码维护、依赖项管理和协作方面的开销。

lerna 是一款功能强大的 javascript 工具，通过引入一种有效的方法来管理 monorepos（在单个代码库中托管多个包的存储库），简化了这一挑战。通过利用 lerna，团队可以受益于简化的依赖管理、高效的工作流程以及对其包发布的更好控制。

在这本电子书中，我们将探讨 lerna 是什么、如何使用它，以及为什么它成为大型项目开发人员的必备工具。无论您是管理小型组件库还是相互依赖的包的复杂生态系统，本指南都将帮助您释放 lerna 的全部潜力。

第一章：lerna 是什么？

lerna 是一款开源工具，旨在管理 javascript 和 typescript 项目的 monorepos。它通过处理以下内容简化了在单个存储库中管理多个包的任务：

为什么选择 monorepos？

monorepos 广泛应用于大型软件开发，因为它们具有以下几个优点：

1. 共享代码库：开发人员可以在包之间重用代码，减少重复并提高一致性。
2. 简化协作：多个包的单个存储库使团队可以更轻松地协作，而无需管理单独的存储库。
3. 统一的构建和测试流程：团队可以标准化跨包的构建、测试和部署流程。

但是，管理单一存储库可能会带来挑战，特别是在依赖项管理、版本控制和发布工作流程方面。这就是勒纳的闪光点。

第 2 章：安装和设置 lerna

先决条件

在设置 lerna 之前，请确保您的系统上安装了 node.js 和 npm（或 yarn）。 lerna 支持两种包管理器。

第 1 步：安装 lerna

您可以使用 npm 在全局安装 lerna：

npm install --global lerna

或者，将其作为开发依赖项添加到您的项目中：

npm install --save-dev lerna

第 2 步：初始化 lerna monorepo

要启动新的 monorepo，请导航到您的项目文件夹并运行：

lerna init

此命令在项目的根目录中创建一个 lerna.json 文件，其中包含您的 lerna 配置。它还设置了一个包文件夹，其中将包含您的各个包。

第 3 步：添加包

在 lerna monorepo 中，每个包都位于 packages 目录中自己的子文件夹中。每个包必须有自己的 package.json 文件来定义其依赖项和配置。

目录结构示例：

/my-project  /packages    /package-a    /package-b  lerna.json  package.json

第 3 章：lerna 中的依赖关系管理

lerna 的关键功能之一是它能够管理多个包之间的依赖关系。您可以将依赖项本地安装到每个包，也可以将共享依赖项“提升”到 monorepo 的根目录。

独立依赖

当每个包需要不同的依赖项时，您可以添加特定于包的依赖项：

lerna add lodash --scope=package-a

提升共享依赖项

当多个包共享相同的依赖项时，lerna 允许您将这些依赖项提升到根级 node_modules 目录，从而减少重复。要启用提升，请修改 lerna.json 文件：

{  "hoist": true}

引导

要安装依赖项并链接本地包，请运行：

lerna bootstrap

lerna 将链接相互依赖的包并安装所有必要的外部依赖项。

第 4 章：跨包运行脚本

lerna 使您能够一次跨所有包运行脚本（例如构建、测试或 lint）。这对于需要在整个 monorepo 上执行的任务特别有用。

跨所有包执行脚本

例如，要在每个包中运行构建脚本，请使用：

lerna run build

lerna 对其 package.json 中定义了构建脚本的每个包执行此命令。

运行特定包中的脚本

您可以使用 --scope 标志来定位特定的包：

lerna run test --scope=package-a

这种灵活性使您可以有效地管理大型代码库，而无需在不需要它的包中运行不必要的命令。

第 5 章：使用 lerna 进行版本控制和发布

lerna 最强大的功能之一是它能够从同一存储库对多个包进行版本控制和发布。 lerna 提供两种版本控制模式：

1.固定模式

在固定模式下，所有包共享一个版本号。当您对一个包进行更改并发布它时，所有包的版本号都会递增。

2.独立模式

独立模式下，每个包都可以有自己的版本号，对一个包的更改只会影响其版本。这对于独立发布包的项目很有用。

要切换到独立模式，请更新 lerna.json 文件：

{  "version": "independent"}

发布包

要将包发布到 npm，请运行：

lerna publish

lerna 将根据您的配置自动对软件包进行版本控制并发布它们。

第 6 章：将 lerna 与 yarn 工作区结合使用

lerna 可以与 yarn workspaces 结合使用，以进一步优化依赖管理。 yarn 工作区允许更有效地提升共享依赖项，缩短安装时间并减少 node_modules 大小。

要在 lerna 中启用 yarn 工作区，请将以下内容添加到您的 lerna.json：

{  "npmclient": "yarn",  "useworkspaces": true}

并修改你的package.json：

{  "workspaces": ["packages/*"]}

启用 yarn 工作区后，lerna 和 yarn 都会处理依赖关系，确保更高效的工作流程。

第 7 章：lerna 高级用法

过滤命令

lerna 允许您在特定包上运行命令或排除某些包。当您只想构建或测试 monorepo 的一部分时，这非常有用。

示例：针对特定包运行命令

lerna run build --scope=package-a --scope=package-b

示例：排除套餐

lerna run build --ignore=package-c

自定义 lerna 命令

您可以为更专业的工作流程定义自定义 lerna 命令。这些通常在 package.json 的脚本部分中定义，并且可以包含您想要跨包运行的任何命令。

第 8 章：lerna monorepos 的最佳实践

1. 按逻辑组织包：将相关包分组在一起以改进代码共享和协作。
2. 使用共享依赖项的提升：提升共享依赖项可以节省空间并减少安装时间。
3. 自动化测试：使用 lerna 的运行命令对所有包进行自动化测试。
4. 采用持续集成：使用 ci/cd 管道在 monorepo 中自动测试、构建和发布包。
5. 利用 yarn 工作区：将 lerna 与 yarn 工作区结合起来，以实现更好的依赖管理。

结论

lerna 是管理 monorepos 的强大工具，为跨多个包的依赖管理、版本控制和发布提供有效的解决方案。通过采用 lerna，团队可以简化开发工作流程、降低复杂性并改善协作。

无论您是构建大型 javascript 生态系统还是简单的组件库，lerna 都提供了灵活且可扩展的方式来管理您的项目。不断尝试 lerna 的高级功能，并应用最佳实践来维护干净、有组织且高效的代码库。

附录

常用 lerna 命令