lerna 使用指南

需求

  • 假設(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"
  }
參考
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末羞迷,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子画饥,更是在濱河造成了極大的恐慌衔瓮,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,695評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件抖甘,死亡現(xiàn)場離奇詭異热鞍,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)单山,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,569評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門碍现,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人米奸,你說我怎么就攤上這事昼接。” “怎么了悴晰?”我有些...
    開封第一講書人閱讀 168,130評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵慢睡,是天一觀的道長。 經(jīng)常有香客問我铡溪,道長漂辐,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 59,648評(píng)論 1 297
  • 正文 為了忘掉前任棕硫,我火速辦了婚禮髓涯,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘哈扮。我一直安慰自己纬纪,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,655評(píng)論 6 397
  • 文/花漫 我一把揭開白布滑肉。 她就那樣靜靜地躺著包各,像睡著了一般。 火紅的嫁衣襯著肌膚如雪靶庙。 梳的紋絲不亂的頭發(fā)上问畅,一...
    開封第一講書人閱讀 52,268評(píng)論 1 309
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼护姆。 笑死矾端,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的卵皂。 我是一名探鬼主播须床,決...
    沈念sama閱讀 40,835評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢(mèng)啊……” “哼渐裂!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起钠惩,我...
    開封第一講書人閱讀 39,740評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤柒凉,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后篓跛,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體膝捞,經(jīng)...
    沈念sama閱讀 46,286評(píng)論 1 318
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,375評(píng)論 3 340
  • 正文 我和宋清朗相戀三年愧沟,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了蔬咬。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,505評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡沐寺,死狀恐怖林艘,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情混坞,我是刑警寧澤狐援,帶...
    沈念sama閱讀 36,185評(píng)論 5 350
  • 正文 年R本政府宣布,位于F島的核電站究孕,受9級(jí)特大地震影響啥酱,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜厨诸,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,873評(píng)論 3 333
  • 文/蒙蒙 一镶殷、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧微酬,春花似錦绘趋、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,357評(píng)論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至忙上,卻和暖如春拷呆,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,466評(píng)論 1 272
  • 我被黑心中介騙來泰國打工茬斧, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留腰懂,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,921評(píng)論 3 376
  • 正文 我出身青樓项秉,卻偏偏與公主長得像绣溜,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子娄蔼,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,515評(píng)論 2 359