需求
- 假設(shè)主項(xiàng)目是 Angular 技術(shù)棧的,依賴兩個(gè)自研 npm 包雏亚,這兩個(gè)包也依賴 Angular缨硝,現(xiàn)在主項(xiàng)目要升級(jí) Angular 版本,那么這兩個(gè) npm 包也得跟著升級(jí)罢低,且需要升級(jí)兩次(一個(gè)包一次)查辩,可否只升級(jí)一次?
- 假設(shè)有兩個(gè) npm 包A和B网持,A依賴B宜岛,那么每當(dāng)B有更新時(shí),要想讓A用上B的更新功舀,需要B發(fā)版萍倡,然后A升級(jí)B的依賴,可否更簡單些辟汰?
解法就是 lerna列敲,一種多包依賴解決方案,簡單來講:
1帖汞、可以管理公共依賴和單獨(dú)依賴戴而;
2、多package相互依賴直接內(nèi)部 link翩蘸,不必發(fā)版所意;
3、可以單獨(dú)發(fā)布和全體發(fā)布
4催首、多包放一個(gè)git倉庫扶踊,也有利于代碼管理,如配置統(tǒng)一的代碼規(guī)范
最佳實(shí)踐
- 初始化項(xiàng)目時(shí)使用 Independent 模式
Independent 模式可以單獨(dú)發(fā)版翅帜,更靈活
npm i -g lerna
lerna init --independent
成功后姻檀,生成目錄:
- packages(目錄)
- lerna.json(配置文件)
- package.json(工程描述文件)
- 添加子package
cd packages && mkdir moduleA && cd moduleA && touch index.js && npm init
以此方式創(chuàng)建兩個(gè)模塊 moduleA 和 moduleB
- packages
- moduleA
- package.json
- index.js
- moduleB
- package.json
- index.js
- lerna.json
- package.json
- 添加公共依賴
假設(shè) moduleA 和 moduleB 都依賴 lodash
lerna add lodash
這會(huì)給moduleA 和 moduleB 同時(shí)安裝 lodash,出現(xiàn)在各自 package.json 的 dependency 里
- 添加單獨(dú)依賴
假設(shè)moduleA 自己依賴 jquery涝滴,moduleB 自己依賴 zepto
lerna add jquery --scope=@fengyinchao/modulea
lerna add zepto --scope=@fengyinchao/moduleb
注意 scope 的值對(duì)應(yīng)的是 package.json 中的 name 字段
- 添加packages里其它模塊作為自己的依賴
假設(shè)moduleA 依賴 moduleB
lerna add @fengyinchao/moduleb --scope=@fengyinchao/modulea
注意這種依賴不會(huì)添加到 moduleA 的 node_modules 里绣版,但會(huì)添加到 moduleA 的 package.json 中,它會(huì)自動(dòng)檢測到 @fengyinchao/moduleb 隸屬于當(dāng)前項(xiàng)目歼疮,直接采用symlink的方式關(guān)聯(lián)過去
- 全 package 發(fā)布
lerna publish
注意使用 lerna publish命令之前需要將代碼commit并推送到遠(yuǎn)端倉庫(首次發(fā)布時(shí))杂抽,然后可以依次為每個(gè) package 選擇要發(fā)布的版本
- 更新包
給 moduleA 添加一個(gè)依賴 husky
lerna add husky --scope=@fengyinchao/modulea
git add .
git commit -m "test:"
// 查看更改
lerna updated
// 發(fā)布
lerna publish
注意 lerna updated 命令需要提交更改后才會(huì)生效,再次 lerna publish 時(shí)會(huì)直接跳過 moduleB韩脏,只發(fā)布 moduleA
- 卸載包
給 moduleA 移除一個(gè)依賴 husky
lerna exec --scope=@fengyinchao/modulea npm uninstall husky
- 批量運(yùn)行 npm script 腳本
lerna run test # 運(yùn)行所有包的 test 命令
lerna run --scope my-component test # 運(yùn)行 my-component 模塊下的 test
lerna run --parallel watch # 觀看所有包并在更改時(shí)發(fā)報(bào)缩麸,流式處理前綴輸出
- 抽離公共模塊
上面 moduleA 和 moduleB 都依賴了 lodash,且在各自 package 下的node_modules 里都有副本赡矢,這其實(shí)很浪費(fèi)空間杭朱,可以使用 --hoist
lerna bootstrap --hoist
這會(huì)將 packages 里重復(fù)的依賴提取到最外層的 node_modules 里阅仔,同時(shí)最外層的 package.json 也不會(huì)更新 dependency 信息,所以不建議將公用依賴寫到最外層的package.json里弧械,而是重復(fù)寫到每個(gè)子package.json 里八酒,然后用 --hoist 提取出來
- 更新公共依賴
假設(shè)要升級(jí) moduleA 和 moduleB 都依賴的 lodash 版本,不必依次到各子package下升級(jí)刃唐,可以借助 lerna-update-wizard 這個(gè)包來做
// 根目錄執(zhí)行
npm install --save-dev lerna-update-wizard
./node_modules/.bin/lernaupdate
常見錯(cuò)誤
- Current HEAD is already released
第一次發(fā)布失敗后出現(xiàn)
lerna publish from-package
- You must sign up for private packages
包名有前綴時(shí)出現(xiàn)
// package.json 增加配置
"publishConfig": {
"access": "public"
}