使用Lerna + Yarn Workspace管理Monorepo项目

1.前言

通常，我们会根据自身业务的实际情况，将通用的组件、逻辑等提取成NPM包，方便以后复用。但这些提取出来的NPM包可能互相之间存在依赖，如果仍然采用 Multirepo 的形式进行管理，则在包的版本管理、依赖管理、调试等诸多方面存在不便。
Monorepo 能很好的解决上述问题，为更加方便的使用 Monorepo 来管理我们的项目，我们需要一些趁手的工具，Lerna + Yarn Workspace 的组合就是这样一件优秀的工具。然而 Lerna 中途经历过较大的改动，其文档也不是那么容易看明白，中文材料大多使用较老版本的 Lerna，使用上和较新版本存在差异。
本文将介绍较新版本的 Lerna 如何结合 Yarn Workspace 管理 Monorepo 项目，后续操作在 Lerna V7 和 V8 中经过实践。

2.Lerna + Yarn Workspace

其实除了 Lerna + Yarn Workspace 的方案外，还有其他方案也可以帮助我们管理 Monorepo 项目，比如 pnpm 等，但我选择 Lerna + Yarn Workspace 一方面是由于习惯了使用 yarn，只要引入 Lerna 即可，另一方面公司的基建对 yarn 也有很好的支持，所以选择了 Lerna + Yarn Workspace。
在使用 Lerna + Yarn Workspace 时，两者的分工有所不同：

  • Yarn 负责依赖管理，在 install 时将子包相同的依赖安装到根目录下的 node_modules 中，避免了在子包中重复安装。同时 Yarn 也可以处理子包之间的相互依赖关系，使用软链的方式连接各个子包。
  • Lerna 则负责子包的发布，包括版本号更新、依赖更新、发布等。

3.入门实践

3.1.初始化

3.1.1.项目初始化

首先你需要初始化 Monorepo 项目，新建一个目录 my-monorepo-project，进入到目录中执行：

yarn init

这一步完成后，项目根目录下会出现 package.json，这里需要将 private 字段设为 true。

3.1.2.Workspaces 初始化

接下来进行 Workspaces 初始化，在根目录新建 packages 文件夹，并在 packages.json 中新增 workspaces 配置：

"workspaces": ["packages/*"
]

workspaces 字段定义了一个包含多个路径的数组，这些路径指向了项目中的各个子包的位置。如上配置就是将 packages 目录下的所有项目都看做是子包。
这一步完成之后，就可以在根目录下执行 yarn 安装依赖了，假设我们的项目目录如下：

/my-monorepo-project
|-- packages
|   |-- package1
|   |-- package2
|   |-- package3
|-- package.json
|-- yarn.lock

其中 package1 依赖了 package2，则 yarn 之后，my-monorepo-project 的根目录下会出现 node_modules 文件夹，在 node_modules 查看各个子包对应的目录，会发现它们是以软链的形式链接到各自的源码目录中。

值得注意的是，此时就算 package1 的 package.json 中没有声明对 package2 的依赖，但也可以直接在 package1 中引用 package2 了。但当我们发布后，由于 package1 没有声明对 package2 的依赖，用户在安装 package1 时不会同时安装 package2，就会造成运行异常。正确的做法仍然需要在 package1 的 package.json 中声明对 package2 的依赖，不过不要通过 yarn workspace package1 add package2的方式添加依赖，这样 package2 会从 npm 上下载，而不是链接到本地源码。

3.1.3.Lerna初始化

现在就可以引入 Lerna 了，在根目录中继续执行：

yarn add lerna -D 
npx lerna init

如此一来，在根目录下就会新增 lerna.json 文件，其内容是：

{"$schema": "node_modules/lerna/schemas/lerna-schema.json","version": "independent","npmClient": "yarn"
}

在较早版本的 Lerna 生成的 lerna.json 文件中，还需要设置 useWorkspaces 字段，不过Lerna 7 和 8 中已经不用设置该字段了。
另外需要注意 version 字段的值。version 可以设置为具体的版本号，比如 0.0.1，此时 Lerna 将采用固定模式（Fixed/Locked mode）管理子包版本，即有的子包将共享同一个版本号。Lerna 默认采用该方式，version 初始值为 0.0.0。
也可以将 version 设置为 independent，表示每个子包都可以独立地管理自己的版本号（Independent mode），当发布时 Lerna 会让你为子包选择版本号。由于我是将已有的项目改造为 Monorepo 项目，各子包已经独立发版很长时间了，所以将 version 改成了 independent。

3.2.开发

完成初始化后，我们就可以开发我们的子包了。在开发过程中，我们可能需要添加第三方依赖，也有可能需要运行子包的 scripts 脚本。我们来看看如何执行这些常见的操作。

3.2.1.添加依赖

如果需要添加第三方依赖，可以将依赖添加到 workspaces 根目录:

# 在任何目录执行
yarn add <依赖名> -W# 或者在根目录中执行
yarn add <依赖名>

这样依赖会被安装到根目录的 node_modules 中，所有子包都可以引用。

如果需要为某个子包单独添加某个依赖，可以执行:

# 在任何目录执行
yarn workspace <子包名> add <依赖名># 或者在进入子包对应的目录中执行
yarn add <依赖名>

这样依赖只会被会被安装到子包对应目录下的 node_modules 中，其他子包不能直接引用。注意子包名指的是子包 package.json 中 name 字段的值，不是子包的目录名。

我们可以通过如下命令查看子包间的依赖关系，防止日后理不清子包的依赖关系：

yarn workspaces info

3.2.2.运行script

如果需要执行某个子包中的脚本，可以执行:

yarn workspace <子包名> run build

这样就会运行子包的 build 命令。

3.3.发布

整个开发过程都是由 Yarn 进行管理，但 Yarn Workspace 不具备发布的能力，这时就需要借助 Lerna 的能力了。

3.3.1.检查更新

需要检查自上次发布以来在 Git 中已经提交但尚未发布的修改，执行:

npx lerna changed

该命令的结果形如：

# 没有未发布的修改
lerna notice cli v7.4.2
lerna info versioning independent
lerna notice Current HEAD is already released, skipping change detection.
lerna info No changed packages found# 有未发布的修改
lerna notice cli v7.4.2
lerna info versioning independent
lerna info Looking for changed packages since package1@0.0.1
package1
package2

该命令的结果不仅包含发生修改的子包本身，还包括依赖了该子包的其他子包。比如 package2 发生修改，则依赖它的 package1 也会被识别为需要发布，因为需要修改 package1 依赖的 package2 的版本。

3.3.2.更新版本号

之前说过，在 lerna.json 中配置 version 为 independent 表示每个子包可以独立地更新版本号。假设我们修改了 package1 的代码，首先需要提交修改，否则发布时会因为没有提交记录而被 Lerna 卡住。
接下来需要更新版本号，这一步不需要直接修改 package.json，而是由 Lerna 帮我们修改，执行：

npx lerna version --no-private

–no-private 表示不更新私有包，因为他们不会被发布。命令执行之后，Lerna 会自动识别需要更新版本的子包（即 lerna changed 的结果），并向用户确认下一个版本号是多少。用户依次确认所有需要更新的子包的新版本号后，Lerna 会打 Tag，并push。
这一步不仅会修改 package.json 中的 version，也会修改依赖的版本。比如 package2 更新了，则在 package1 的 package.json 中，不仅自身的版本号会更新，其依赖的 package1 的版本也会跟着改变。

3.3.3.发布

发布就很简单了，执行：

npx lerna publish from-package

即可将更新的子包发布到NPM。

4.踩坑

我是将已经独立发版一段时间的好几个子包改造为使用 Monorepo 架构进行管理。由于 Lerna 基于 Tag 判断有哪些子包需要发布，由于之前发布子包时没有打Tag，所以执行 npx lerna changed会提示 lerna success found 9 packages ready to publish，意思是所有的子包都要发布。但执行 npx lerna publish from-package时由于本地包和 npm 上的版本相同，会提示 No unpublished release found，意思是没有需要发布的包。
为了解决上述问题，需要补一下Tag，具体方法是执行 npx lerna version --no-private，Lerna 会让填写每个子包的新版本号，没有修改的子包版本号可以保持不变。执行完毕后再执行 npx lerna changed会提示 Current HEAD is already released, skipping change detection... No changed packages found，即达成目的。
随后执行 npx lerna publish from-package，发布需要更新的子包即可。如果没有要发布的子包，这一步也可以不执行。

5.参考

  • Yarn文档
  • Yarn Workspaces
  • Lerna文档
  • Lerna文档翻译
  • Lerna 备忘清单
  • Lerna + Yarn workspace 使用总结

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/730814.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

项目解决方案：多地5G蓄能电站的视频监控联网系统设计方案

项目解决方案：多地5G蓄能电站的视频监控联网系统设计方案

目 录 一、前言 二、系统架构设计 1、系统架构设计说明 2、系统拓扑图 三、关键技术 1. 5G支持技术 2. 视频图像处理技术 3. 数据融合与分析技术 四、功能特点 1. 高效可靠 2. 实时监测 3. 远程控制 4. 故障预测 五、应用前景 一、前言 随着能源…
阅读更多...
C++泛型实现搜索二叉树

C++泛型实现搜索二叉树

文章目录 二叉搜索树查找插入删除实现应用性能分析 二叉搜索树 二叉搜索树&#xff08;BST&#xff0c;Binary Search Tree&#xff09;又称为二叉排序树&#xff0c;空树也算 二叉搜索树有如下性质 若左子树不为空&#xff0c;则左子树上所有节点值小于根节点若右子树不为空…
阅读更多...
2575. 找出字符串的可整除数组（Go语言）

2575. 找出字符串的可整除数组（Go语言）

https://leetcode.cn/problems/find-the-divisibility-array-of-a-string/ 在看题解之前&#xff0c;我的代码是以下这样&#xff1a; package mainimport ("fmt" )func main() {fmt.Println(divisibilityArray("998244353", 3)) }func divisibilityArray…
阅读更多...
供应链管理系统（SCM）：得供应链得天下不是空话。

供应链管理系统（SCM）：得供应链得天下不是空话。

2023-08-26 15:51贝格前端工场 Hi&#xff0c;我是贝格前端工场&#xff0c;优化升级各类管理系统的界面和体验&#xff0c;是我们核心业务之一&#xff0c;欢迎老铁们评论点赞互动&#xff0c;有需求可以私信我们 一、供应链对于企业的重要性 供应链对企业经营的重要性不可…
阅读更多...
使用plasmo框架开发浏览器插件，注入contents脚本和给页面添加UI组件

使用plasmo框架开发浏览器插件，注入contents脚本和给页面添加UI组件

plasmo&#xff1a;GitHub - PlasmoHQ/plasmo: &#x1f9e9; The Browser Extension Framework plasmo是一个开发浏览器插件的框架&#xff0c;支持使用react和vue等技术&#xff0c;而且不用手动管理manifest.json文件&#xff0c;框架会根据你在框架中的使用&#xff0c;自…
阅读更多...
入门了解huggingface实现ALBERT模型相关任务--Token Classification

入门了解huggingface实现ALBERT模型相关任务--Token Classification

目录 AlbertForTokenClassification 主要参数和方法 使用示例 TFAlbertForTokenClassification 参数说明 方法说明 使用示例 FlaxAlbertForTokenClassification 参数说明 __call__ 方法参数 返回值 使用示例 AlbertForTokenClassification AlbertForTokenClassifi…
阅读更多...
ChatGPT高效提问——角色提示

ChatGPT高效提问——角色提示

ChatGPT高效提问——角色提示 角色提示技巧是一种通过给模型提供具体的角色扮演&#xff0c;指导ChatGPT输出的方法。这个技巧对一个具体的上下文或者听众定制生成的文本很有用。 要使用角色提示技巧&#xff0c;你需要提供明确具体的模型扮演的角色。 例如&#xff0c;如果…
阅读更多...
多光谱防伪技术

多光谱防伪技术

近年来，随着机器学习的快速崛起，很快出现新的技术更新，刚开始的多层感知机，到现在的大模型，都是大家探讨的兴趣方向，但是最值得大家感兴趣的那就是多光谱防伪技术的出现，很快各大平台都是争先恐后的集中人才开发新的方向和挖掘新的技术。 多光谱技术是什么呢，当然就是…
阅读更多...
如何在Windows环境下编译OpenOCD

如何在Windows环境下编译OpenOCD

1. 安装Cygwin Windows环境下编译OpenOCD可以是在MinGW-w64/MSYS或Cygwin下&#xff0c;这里选择Cygwin&#xff0c;下载安装Cygwin。 2. 进入OpenOCD源代码目录 打开Cygwin&#xff0c;进入OpenOCD源代码目录&#xff0c;例如代码放在D:\Temp\OpenOCD\openocd-code下&#…
阅读更多...
C++学习笔记:AVL树

C++学习笔记:AVL树

AVL树 什么是AVL树?AVL树节点的定义AVL树的插入平衡因子调整旋转调整左旋转右旋转左右双旋右左双旋 AVL树完整代码实现 什么是AVL树? AVL是1962年,两位俄罗斯数学家G.M.Adelson-Velskii和E.M.Landis 为了解决如果数据有序或接近有序二叉搜索树将退化为单支树&#xff0c;查找…
阅读更多...
限制员工上网行为，如何有效管控员工上网行为? 你一定想不到这个方法！

限制员工上网行为，如何有效管控员工上网行为? 你一定想不到这个方法！

发现员工上班时间刷抖音&#xff1a; 面对这种情况&#xff0c;领导不得火冒三丈&#xff1f;&#xff1f;&#xff1f; 对于员工不恰当的上网行为&#xff0c;非常有可能导致工作效率低下、安全风险增加以及企业形象受损。 因此应该采取一些措施来对员工上网行为进行管理。 …
阅读更多...
第三节：在Sashulin中自定义组件

第三节：在Sashulin中自定义组件

上一节讲解了如何建立一个业务消息流&#xff0c;流程是由组件构成的。目前SMS提供了General、Database、MessageQueue、Socket、WebService、Http、Internet等系列常用组件&#xff0c;如果不满足业务需求&#xff0c;可以进行自定义组件开发。 一、组件开发 1、建立一个Jar…
阅读更多...
C及C++每日练习(3)

C及C++每日练习(3)

选择题&#xff1a; 1.以下程序的输出结果是&#xff08;&#xff09; #include <stdio.h> main() { char a[10] {1, 2, 3, 4, 5, 6, 7, 8, 9, 0}, *p; int i; i 8; p a i; printf("%s\n", p - 3); } A.6 B. 6789 C. 6 D.789 对于本题&#xff0…
阅读更多...
吴恩达机器学习-可选实验室：特征工程和多项式回归（Feature Engineering and Polynomial Regression）

吴恩达机器学习-可选实验室：特征工程和多项式回归（Feature Engineering and Polynomial Regression）

文章目录 目标工具特征工程和多项式回归概述多项式特征选择功能备用视图扩展功能复杂的功能 恭喜! 目标 在本实验中&#xff0c;你将:探索特征工程和多项式回归&#xff0c;它们允许您使用线性回归的机制来拟合非常复杂&#xff0c;甚至非常非线性的函数。 工具 您将利用在以…
阅读更多...
2023最新pytorch安装教程，简单易懂，面向初学者（Anaconda+GPU）

2023最新pytorch安装教程，简单易懂，面向初学者（Anaconda+GPU）

一、前言 目前是2023.1.27,鉴于本人安装过程中踩得坑&#xff0c;安装之前我先给即将安装pytorch的各位提个醒&#xff0c;有以下几点需要注意 1.判断自己电脑是否有GPU 注意这点很重要&#xff0c;本教程面向有NVIDA显卡的电脑&#xff0c;如果你的电脑没有GPU或者使用AMD显…
阅读更多...
.Net Core/.net 6/.Net 8 实现Mqtt服务器

.Net Core/.net 6/.Net 8 实现Mqtt服务器

.Net Core/.net 6/.Net 8 实现Mqtt服务端 Mqtt服务端代码IMqttServer 接口业务类&#xff0c;实现 IMqttServer 接口Program.cs 直接上代码 nuget 引用 MQTTnet Mqtt服务端代码 using MQTTnet; using MQTTnet.Protocol; using MQTTnet.Server;namespace Code.Mqtt {/// <sum…
阅读更多...
STM32day3

STM32day3

1.思维导图 1.总结任务的调度算法&#xff0c;把实现代码再写一下 /* Definitions for myTask02 */ osThreadId_t myTask02Handle; uint32_t myTask02Buffer[ 64 ]; osStaticThreadDef_t myTask02ControlBlock; const osThreadAttr_t myTask02_attributes {.name "myTa…
阅读更多...
代码随想录算法训练营第三十九天|62.不同路径、63. 不同路径 II

代码随想录算法训练营第三十九天|62.不同路径、63. 不同路径 II

62.不同路径 刷题https://leetcode.cn/problems/unique-paths/description/文章讲解https://programmercarl.com/0062.%E4%B8%8D%E5%90%8C%E8%B7%AF%E5%BE%84.html视频讲解https://www.bilibili.com/video/BV1ve4y1x7Eu/?vd_sourceaf4853e80f89e28094a5fe1e220d9062 题解&…
阅读更多...
react的diff源码

react的diff源码

react 的 render 阶段&#xff0c;其中 begin 时会调用 reconcileChildren 函数&#xff0c; reconcileChildren 中做的事情就是 react 知名的 diff 过程 diff 算法介绍 react 的每次更新&#xff0c;都会将新的 ReactElement 内容与旧的 fiber 树作对比&#xff0c;比较出它们…
阅读更多...
零基础学习JS--基础篇--索引集合类

零基础学习JS--基础篇--索引集合类

数组是由名称和索引引用的值构成的有序列表。 JavaScript 中没有明确的数组数据类型。但是&#xff0c;你可以使用预定义的 Array 对象及其方法来处理应用程序中的数组。Array 对象具有以各种方式操作数组的方法&#xff0c;例如连接、反转和排序。它有一个用于确定数组长度的…
阅读更多...
最新文章

Copyright @ 2022~2023