在团队开发中,我们经常会有工具包多、项目多,随着团队发展随之而来的问题会越来越多。本次分享用Rush解决以上问题,在实际中探索出 真正的Monorepo 场景的较佳实践。
首先我们来了解一下如何开始Rush
第一步:安装
npm install -g @microsoft/rush
可通过rush h 判断是否安装成功
第二步:初始化
安装成功后,可通过rush init 命令初始化项目
目录结构
第三步:安装依赖
Rush安装依赖有几种方式:
1、rush add -p PACKAGE --dev --all
跟目录执行命令安装所有的包
2、rush add -p PACKAGE --dev
在包里面执行,只安装在当前包中
第四步:rush update
rush update 命令会依据 package.json 文件安装依赖,并按需更新 shrinkwrap 文件(shrinkwrap 文件是存储仓库内所有项目的依赖和版本的中心,它被放到 "common/config/rush"文件夹下)。此命令Rush 会在一次性给仓库内的所有项目安装。 当你从 Git 上拉去文件,或者修改
完 package.json 文件后,需要执行 "rush update" 才能开始工作。如果无需更新,则 "rush update" 会在瞬时完成。
rush update和rush install的区别:
"rush install" 命令会基于 "rush update' 创建/更新的 shrinkwrap 文件来给仓库内的所有项目安装依赖)。
清除依赖可以用rush purge命令,清除node_modules和rush相关依赖。
通过以上流程我们可以得到一个空项目,但是一个完整的monorepo需要完善的发布流程,我们还需要一些配置
rush.json
在rush init的时候生成的rush.json,在projects中配置相关项目,在projects中配置的项目,rush可以识别出,并可执行rush update等相关命令,需要publish的包,可通过配置shouldPublish属性,即可操作发包相关流程。
关于多包发布
在 Rush 中,rush change 是发包流程的起点,会产生changes文件,/common/changes/[packages]/[feature_time].json,流程如下:
rush version 或 rush publish --apply 则会基于生成的 changefile.json 进行版本号的更新,被发布 package 的上层 package 的版本号可能会被更新,rush publish --publish 则会基于 changefile.json 进行对应 package 的发布。
Rush 的发布流程与 Changesets 基本一致 。
rush中发布私有源,需要私有源配置,可通过注入环境变量校验身份信息