lerna 使用指南

需求

  • 假设主项目是 Angular 技术栈的,依赖两个自研 npm 包,这两个包也依赖 Angular,现在主项目要升级 Angular 版本,那么这两个 npm 包也得跟着升级,且需要升级两次(一个包一次),可否只升级一次?
  • 假设有两个 npm 包A和B,A依赖B,那么每当B有更新时,要想让A用上B的更新,需要B发版,然后A升级B的依赖,可否更简单些?

解法就是 lerna,一种多包依赖解决方案,简单来讲:
1、可以管理公共依赖和单独依赖;
2、多package相互依赖直接内部 link,不必发版;
3、可以单独发布和全体发布
4、多包放一个git仓库,也有利于代码管理,如配置统一的代码规范

最佳实践

  • 初始化项目时使用 Independent 模式
    Independent 模式可以单独发版,更灵活
npm i -g lerna
lerna init --independent

成功后,生成目录:

- packages(目录)
- lerna.json(配置文件)
- package.json(工程描述文件)
  • 添加子package
cd packages && mkdir moduleA && cd moduleA && touch index.js && npm init

以此方式创建两个模块 moduleA 和 moduleB

- packages
  - moduleA
    - package.json
    - index.js
  - moduleB
    - package.json
    - index.js
- lerna.json
- package.json
  • 添加公共依赖
    假设 moduleA 和 moduleB 都依赖 lodash
lerna add lodash

这会给moduleA 和 moduleB 同时安装 lodash,出现在各自 package.json 的 dependency 里

  • 添加单独依赖
    假设moduleA 自己依赖 jquery,moduleB 自己依赖 zepto
lerna add jquery --scope=@fengyinchao/modulea
lerna add zepto --scope=@fengyinchao/moduleb

注意 scope 的值对应的是 package.json 中的 name 字段

  • 添加packages里其它模块作为自己的依赖
    假设moduleA 依赖 moduleB
lerna add @fengyinchao/moduleb --scope=@fengyinchao/modulea

注意这种依赖不会添加到 moduleA 的 node_modules 里,但会添加到 moduleA 的 package.json 中,它会自动检测到 @fengyinchao/moduleb 隶属于当前项目,直接采用symlink的方式关联过去

  • 全 package 发布
lerna publish

注意使用 lerna publish命令之前需要将代码commit并推送到远端仓库(首次发布时),然后可以依次为每个 package 选择要发布的版本


  • 更新包
    给 moduleA 添加一个依赖 husky
lerna add husky --scope=@fengyinchao/modulea
git add .
git commit -m "test:"
// 查看更改
lerna updated
// 发布
lerna publish

注意 lerna updated 命令需要提交更改后才会生效,再次 lerna publish 时会直接跳过 moduleB,只发布 moduleA

  • 卸载包
    给 moduleA 移除一个依赖 husky
lerna exec --scope=@fengyinchao/modulea  npm uninstall husky
  • 批量运行 npm script 脚本
lerna run test # 运行所有包的 test 命令
lerna run --scope my-component test # 运行 my-component 模块下的 test
lerna run --parallel watch # 观看所有包并在更改时发报,流式处理前缀输出
  • 抽离公共模块
    上面 moduleA 和 moduleB 都依赖了 lodash,且在各自 package 下的node_modules 里都有副本,这其实很浪费空间,可以使用 --hoist
lerna bootstrap --hoist

这会将 packages 里重复的依赖提取到最外层的 node_modules 里,同时最外层的 package.json 也不会更新 dependency 信息,所以不建议将公用依赖写到最外层的package.json里,而是重复写到每个子package.json 里,然后用 --hoist 提取出来

  • 更新公共依赖
    假设要升级 moduleA 和 moduleB 都依赖的 lodash 版本,不必依次到各子package下升级,可以借助 lerna-update-wizard 这个包来做
// 根目录执行
npm install --save-dev lerna-update-wizard
./node_modules/.bin/lernaupdate



常见错误
  • Current HEAD is already released
    第一次发布失败后出现
lerna publish from-package
  • You must sign up for private packages
    包名有前缀时出现
// package.json 增加配置
  "publishConfig": {
    "access": "public"
  }
参考
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343