lerna使用教程

lerna官網

lerna中文網

Lerna是一個工具，它優化了使用git和npm管理多包存儲庫的工作流。

將大型代碼庫拆分為單獨的獨立版本控制包對於代碼共享非常有用。然而，跨多個存儲庫進行更改是混亂且難以跟蹤的，並且跨存儲庫的測試變得非常復雜

vue,babel,react等都在用。我司也在用。文檔是英文，我便簡單總結一篇，希望對大家有幫助。

需求

• 假設主項目是 Vue 技術棧的，依賴兩個自研 npm 包，這兩個包也依賴 Vue，現在主項目要升級 vue 版本，那么這兩個 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"
  }