lerna管理package

PumpkinDylan 發(fā)布于2019-08-23 18:34 / 3063人閱讀

摘要：最近發(fā)現(xiàn)公司一個(gè)項(xiàng)目的目錄組織挺奇怪的，所有的子項(xiàng)目都放在了目錄里，還有這種騷操作特意查了下資料，發(fā)現(xiàn)是一種比較流行的項(xiàng)目管理模式。

最近發(fā)現(xiàn)公司一個(gè)項(xiàng)目的目錄組織挺奇怪的，所有的子項(xiàng)目都放在了packages目錄里，還有這種騷操作？特意查了下資料，發(fā)現(xiàn)是一種比較流行的monorepo項(xiàng)目管理模式。近幾年比較火的React,Vue,Babel都是用的這種模式:

我們平常一般采用的都是multiple repositories的項(xiàng)目管理模式：把一個(gè)大項(xiàng)目拆分成若干個(gè)小項(xiàng)目，每個(gè)小項(xiàng)目都獨(dú)立的放在gitlab上。這種模式其實(shí)也沒(méi)啥不好，但是某些情況下，子項(xiàng)目A依賴子項(xiàng)目B，如果子項(xiàng)目B經(jīng)常改動(dòng)，那么每次B改動(dòng)了，都要修改A，這時(shí)就非常麻煩。在開(kāi)發(fā)一個(gè)前端框架或者UI庫(kù)時(shí)，就經(jīng)常會(huì)遇到上述情況，這時(shí)我們就可以考慮下monorepo。

monorepo說(shuō)到底也只是一個(gè)理念，那么怎么才能實(shí)現(xiàn)這種代碼組織呢？

lerna

yarn中的Workspace

本文主要介紹下lerna的使用

源碼參考

lerna

全局安裝lerna

npm i lerna -g

lerna是基于git的，在github上新建一個(gè)項(xiàng)目learn-lerna

git clone [email protected]:deepred5/learn-lerna.git
cd learn-lerna

初始化項(xiàng)目:

lerna init

lerna會(huì)自動(dòng)創(chuàng)建一個(gè)packages目錄夾，我們以后的項(xiàng)目都新建在這里面。同時(shí)還會(huì)在根目錄新建一個(gè)lerna.json配置文件

{
  "packages": [
    "packages/*"
  ],
  "version": "0.0.0" // 共用的版本，由lerna管理
}

創(chuàng)建package

我們創(chuàng)建兩個(gè)package:

cd packages
mkdir prpr-lerna-core
cd prpr-lerna-core
npm init -y

cd packages
mkdir prpr-lerna-popular
cd prpr-lerna-popular
npm init -y

注意：這兩個(gè)package我們最后都是要發(fā)布到npm上的，所以名字請(qǐng)取特殊些，不能被人用過(guò)

添加依賴

prpr-lerna-popular依賴prpr-lerna-core，這時(shí)有兩種方法添加依賴：

第一種方法是修改prpr-lerna-popular/package.json，添加

{
  "dependencies": {
    "prpr-lerna-core": "^1.0.0"
  }
}

然后運(yùn)行lerna bootstrap

第二種方法是直接使用命令add

lerna add prpr-lerna-core --scope=prpr-lerna-popular

運(yùn)行之后，我們發(fā)現(xiàn)prpr-lerna-popular生成了node_modules，而node_modules里生成了指向prpr-lerna-core的軟鏈，類似npm link的效果:

新建prpr-lerna-core/index.js

const API = "https://yande.re/post/popular_recent.json";

module.exports = {
  API
}

prpr-lerna-popular除了依賴prpr-lerna-core，還可以依賴其他開(kāi)源的庫(kù)，比如我們使用axios

lerna add axios --scope=prpr-lerna-popular

新建prpr-lerna-popular/index.js

const { API } = require("prpr-lerna-core");
const axios = require("axios");

const getPopularImg = () => axios.get(API)

module.exports = getPopularImg;

// 測(cè)試代碼，發(fā)布時(shí)刪除
getPopularImg().then((res) => console.log(res.data.length));

測(cè)試一下:
node packages/prpr-lerna-popular/index.js
正常情況下可以輸出結(jié)果

發(fā)布到npm

首先把所有的代碼提交

cd learn-lerna
git add .
git commit -m "test publish"

注冊(cè)一個(gè)npmjs賬戶

npm login

登入你的賬戶，如果本地npm是淘寶鏡像，一定要換回https://registry.npmjs.org/地址?。?！

lerna publish

運(yùn)行publish，選擇發(fā)布的版本號(hào)

lerna可以幫我們管理版本號(hào)，非常方便!

常用命令

lerna init #初始化
lerna bootstrap #下載依賴包或者生成本地軟連接
lerna add axios #所有包都添加axios
lerna add prpr-lerna-core --scope=prpr-lerna-popular #給包prpr-lerna-popularx添加prpr-lerna-core依賴
lerna list
lerna clean

其他事項(xiàng)

lerna默認(rèn)使用的是集中版本，所有的package共用一個(gè)version。如果希望不同的package擁有自己的版本，可以使用Independent模式

發(fā)布package的名字如果是以@開(kāi)頭的，例如@deepred/core，npm默認(rèn)以為是私人發(fā)布，需要使用npm publish --access public發(fā)布。但是lerna publish不支持該參數(shù)，解決方法參考: issues

參考

淺談monorepo