lerna-lite 轻量化 monorepo 管理利器
写作背景
微前端是一个新旧项结合挺常见的一种技术,我司也成功借助京东前端团队推出的 micro-app
完成了一主两从 3 个独立项目的完美结合。但随着项目整体 sass 化逐步转型开始,迭代差异化增加就,相对应的造成了项目依赖安装、启动、编译等一系列事项的频率变高,解决这个拖慢研发节奏的问题我想到的方案就是引入 Monorepo 单仓库的管理。
lerna-lite 介绍
lerna-lite 是用来管理和发布同一仓库多 JavaScript
/TypeScript
包的一款工具,与 lerna 相比 lerna-lite 具有更轻量化和模块化的特点,同时 lerna-lite 也是 lerna 的一个有限子集。我们在实际项目中可以采用渐进式的方式按需安装使用。需要注意的一点是 lerna-lite 是不包括 bootstrap
、add
、create
和 link
命令的,所以需要正式使用 lerna-lite 之前配置好项目的包管理器(npm
、pnpm
、yarn
)。
快速开始:
首先要将@lerna-lite/cli
作为开发依赖安装到项目中:
执行 init
命令初始化工作空间,得到一个 lerna.json
配置文件和一个 packages
文件夹;
如果你不打算使用 npm
作为项目的包管理器的话需要更新 lerna.json
配置文件中的 npmClient
;
使用
yarn
配置:"npmClient": "yarn"
使用
pnpm
配置:"npmClient": "pnpm"
命令列表:
PS: 由于 publish
命令依赖于 version
命令,所以在安装 @lerna-lite/publish
后即可获得这两个命令。
一起操练起来:
首先会创建三个独立的前端应用,接着会使用 micro-app
将 Angualr16 的项目改造为微前端的主应用,Vue3 + Vite 和 React + Vite 两个项目当做子应用接入,最后在升级为 Monorepo 。lerna-lite 将会以渐进式的方式在整个过程中逐步引入。
独立前端应用(Multirepo 风格):
Angualr16 应用:
创建应用:
分配启动端口: 修改
start
脚本 ,增加--port
选项,指明端口号;
通过路由组织页面:
PS:文末通过访问 Github 查看项目中的变更文件,已用注释说明;
Vue3 应用:
创建应用
分配启动端口:修改
vite.config.ts
配置文件,增加server.port
选项,指明端口号;
React 应用:
创建应用
分配启动端口:同 Vue3 应用,指明端口号;
微前端改造(MicroApp):
以下针对对前端的改造全部在 Angualr16 主应用中进行;
安装并初始化:
安装npm i @micro-zoe/micro-app --save
;
支持 WebComponent:
页面嵌入子应用:
PS:子应用使用 vite
作为基础框架,需要主动切换到 iframe
沙箱;
lerna-lite(Monorepo 风格):
按快速开始的的流程创建 simple-micro-app
项目且默认使用 npm
包管理器,执行 init
命令后将独立的三个前端应用移动到对应的目录。
PS:pnpm
包管理器需要依据团队使用熟练度来进行落地。
查看本地应用:
安装:
npm i -D @lerna-lite/list
;添加脚本:
PS:查看包括私有的所有 JavaScript
/TypeScript
包;
删除 node_module:
安装:
npm i -D @lerna-lite/exec
;添加脚本:
PS:一次性删除 packages
中每个应用的 node_module
文件夹;
安装应用依赖:
添加脚本:
PS:一次性安装 packages
中每个应用的依赖;
启动所有应用:
安装:
npm i -D @lerna-lite/run
;添加脚本:
PS:需要将 angular16
项目中的 start
脚本名修改为 dev
,与其他两个应用保持一致的启动命令;
创建新版本:
安装:
npm i -D @lerna-lite/version
;添加脚本:
PS:执行 version 脚本前需要保证所有的变更都已经提交;
操作过程:
生成 CHANGELOG:
修改 version 脚本:
PS:使用 angular 预设在创建新版本时生成 CHANGELOG.md 文件;
查看变更的应用:
安装:
npm i -D @lerna-lite/changed
;添加脚本:
PS:执行 changed
查看距离上次发布版本所有包;
操作过程:
查看变更的内容:
安装:
npm i -D @lerna-lite/diff
;添加脚本:
PS:执行 diff
查看距离上次发布版本所有变化的内容;
操作过程:
总结:
从一开始的三个独立的前端应用通过 micro-app
将代码从业务的层面整合到了一起,但由于此时还是 Multirepo 风格,所以对于开发维护和管理上还是存在一定的负担,每一次的迭代、BUG 修复或提交代码都需要多次 cd
到项目路径,逐个执行不同的命令,通过 lerna-lite 将它们从代码仓库的层面继续整合将大大优化拖慢研发节奏的问题。
micro-app 在不同的技术栈和不同的基础框架会有不一样的要求,更多内容可以访问 https://github.com/micro-zoe/micro-app 查看学习。
lerna-lite 的
publish
和watch
两个命名以及其他命令的更多选项可以到 https://github.com/lerna-lite/lerna-lite 查看学习。
PS:源码访问 https://github.com/OSpoon/simple-micro-app 获取;
版权声明: 本文为 InfoQ 作者【小鑫同学】的原创文章。
原文链接:【http://xie.infoq.cn/article/4b9c213c088726c6a4f212861】。文章转载请联系作者。
评论