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閱讀 228,546評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,570評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,505評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,017評論 1 313
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,786評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,219評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,287評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,438評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,971評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,796評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,995評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,540評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,230評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,662評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,918評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,697評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,991評論 2 374