插件窝 干货文章 掌握 Lerna:管理 JavaScript Monorepos 的指南

掌握 Lerna:管理 JavaScript Monorepos 的指南

strong lerna li 依赖 612    来源:    2024-10-20

目录

  1. 简介
  2. 第一章:lerna 是什么?
    • 为什么选择 monorepos?
  3. 第 2 章:安装和设置 lerna
    • 先决条件
    • 分步安装指南
    • 设置您的第一个 lerna 项目
  4. 第 3 章:lerna 中的依赖关系管理
    • 独立依赖
    • 提升共享依赖项
    • 引导包
  5. 第 4 章:跨包运行脚本
    • 全局执行脚本
    • 针对特定包
  6. 第 5 章:使用 lerna 进行版本控制和发布
    • 固定模式与独立模式
    • 将包发布到 npm
  7. 第 6 章:将 lerna 与 yarn 工作区结合使用
    • 在 lerna 中启用 yarn 工作区
    • 使用 lerna + yarn 工作区优化工作流程
  8. 第 7 章:lerna 高级用法
    • 过滤命令
    • 创建自定义命令
  9. 第 8 章:lerna monorepos 的最佳实践
    • 逻辑包组织
    • 自动化测试和构建
    • ci/cd 集成
  10. 结论
  11. 附录:常用 lerna 命令

简介

管理涉及多个相互依赖的包的大型 javascript 或 typescript 项目对于开发人员和开发团队来说可能是一项重大挑战。通常,开发人员依赖每个包的多个存储库,这会导致代码维护、依赖项管理和协作方面的开销。

lerna 是一个为管理 monorepos 开发的强大工具,它简化了这个过程。 monorepos 使团队能够在单个存储库中托管多个包,从而简化依赖关系管理并使团队之间的协作更加顺畅。

这本电子书旨在提供使用 lerna 有效管理您的 monorepos 的完整指南。无论您是处理组件库还是具有多个互连包的大型项目,您都会发现有价值的见解,帮助您通过 lerna 最大限度地提高生产力。


第一章:lerna 是什么?

lerna 是一个开源工具,有助于管理 monorepo 中的多个包。它提供了强大的功能,例如自动依赖管理、版本控制和发布,使大规模维护 javascript 和 typescript 项目变得更加容易。

立即学习“Java免费学习笔记(深入)”;

为什么选择 monorepos?

monorepos 是许多大型项目的架构选择,因为它们提供了多种好处:

  • 共享代码库:使用 monorepos,代码重用更加容易。这减少了重复并确保项目之间的一致性。
  • 简化协作:当所有包都集中在一个地方时,开发人员可以更有效地协作。
  • 统一构建流程:跨多个包的标准化构建、测试和部署变得更加容易。

尽管有这些好处,管理单一存储库也会带来独特的挑战,特别是在管理依赖项和版本控制方面。 lerna 旨在正面应对这些挑战,为 monorepos 提供优化的工作流程。


第 2 章:安装和设置 lerna

先决条件

开始之前,请确保您已安装 node.jsnpm(或 yarn)。 lerna 与 npm 和 yarn 兼容。

第 1 步:安装 lerna

您可以通过 npm 在全局安装 lerna:

npm install --global lerna

或者,您可以将 lerna 添加为项目中的开发依赖项:

npm install --save-dev lerna

第 2 步:初始化 lerna monorepo

安装后,通过导航到项目目录并运行来初始化您的 monorepo:

lerna init

这将创建必要的配置文件,包括 lerna.json,并设置一个包文件夹来存放您的各个包。

第 3 步:添加包

在 lerna 项目中,每个包都位于 packages 下自己的子文件夹中。每个包必须有自己的 package.json 文件用于依赖管理。

示例结构:

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

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

管理多个包之间的依赖关系是 lerna 的核心优势之一。

独立依赖

lerna 允许您向特定包添加依赖项。例如,如果只有 package-a 需要 lodash,则可以运行:

lerna add lodash --scope=package-a

提升共享依赖项

当多个包共享依赖项时,您可以将这些依赖项提升到 monorepo 的根目录。这减少了冗余并加快了安装速度。要启用提升,请将其添加到 lerna.json:

{
  "hoist": true
}

引导

要安装相互依赖的依赖项和链接包,请运行:

lerna bootstrap

这可确保安装所有必需的外部依赖项,并且包可以正确地相互引用。


第 4 章:跨包运行脚本

lerna 可以轻松地在 monorepo 中的所有包中执行脚本(例如构建、测试、lint)。

全局执行脚本

要在所有包中运行诸如构建之类的脚本,请使用:

lerna run build

针对特定包

如果您只想运行某些包中的脚本,请使用 --scope 标志:

lerna run test --scope=package-a

这种灵活性可以实现更有针对性的执行,从而节省开发时间。


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

lerna 提供强大的版本控制和发布功能,使您可以轻松版本和发布软件包。

1.固定模式

在固定模式下,所有包共享相同的版本号。当任何软件包更新时,所有软件包的版本号都会增加。

2.独立模式

独立模式下,每个包都有自己的版本号。当软件包发生更改时,仅更新该软件包的版本。

要切换到独立模式,请修改lerna.json:

{
  "version": "independent"
}

发布包

要将包发布到 npm,请运行:

lerna publish

lerna 将根据您的配置处理版本控制和发布。


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

将 lerna 与 yarn workspaces 相结合可以通过提升更多共享依赖项来进一步优化依赖项管理。

要启用 yarn 工作区,请修改 lerna.json 文件:

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

然后更新你的 package.json:

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

这种集成提高了性能并简化了大型项目的管理。


第 7 章:lerna 高级用法

过滤命令

lerna 允许过滤为特定包运行命令或排除某些包。

在特定包上运行的示例:

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

排除包裹的示例:

lerna run build --ignore=package-c

自定义命令

您可以在 package.json 中为专门的工作流程定义自定义 lerna 命令。然后可以在您的包中运行这些命令。


第 8 章:lerna monorepos 的最佳实践

  1. 按逻辑组织包:将相关包分组在一起,以便更好地重用代码。
  2. 使用提升:提升共享依赖项可以节省空间并加快安装时间。
  3. 自动化测试:使用 lerna run 对整个 monorepo 进行自动化测试。
  4. ci/cd 管道:实施持续集成和部署工作流程以自动测试和部署更改。
  5. yarn 工作区:利用 yarn 工作区与 lerna 进行更好的依赖管理。

结论

lerna 是管理 monorepos 的宝贵工具,提供简化复杂工作流程(从依赖管理到版本控制和发布)的功能。通过采用 lerna,团队可以降低复杂性、简化流程并改善协作,从而更轻松地维护大型项目。

无论您是在开发简单的组件库还是多包生态系统,lerna 都能提供有效管理项目所需的工具。继续尝试 lerna 的高级功能,以释放其全部潜力。


附录:常用 lerna 命令

  • lerna init:初始化 lerna monorepo。
  • lerna bootstrap:安装依赖项和链接包。
  • lerna add [package] --scope=[package-name]:添加对特定包的依赖。
  • lerna run [script]:在所有包中运行脚本。
  • lernapublish:将包发布到 npm。

快乐编码:)