前端工程化之多個(gè)項(xiàng)目如何同時(shí)高效管理 — monorepo

monorepo 不僅限于前端啦膜,但此篇博文只談前端。

是什么

wikipedia: In version control systems, a monorepo ("mono" meaning 'single' and "repo" being short for 'repository') is a software development strategy where code for many projects is stored in the same repository.

翻譯過(guò)來(lái)就是:在版本控制系統(tǒng)中淌喻,monorepo 是一種軟件開(kāi)發(fā)策略僧家,其中許多項(xiàng)目的代碼存儲(chǔ)在同一存儲(chǔ)庫(kù)中。

為什么

在公司內(nèi)裸删,如果項(xiàng)目較多八拱,每一個(gè)項(xiàng)目都會(huì)有一個(gè)Git倉(cāng)庫(kù),就會(huì)導(dǎo)致新來(lái)的員工每一次更改項(xiàng)目的時(shí)候都需要從 Git 倉(cāng)庫(kù)上面拉一份代碼下來(lái)比較麻煩涯塔。

那如果將所有的項(xiàng)目放在一個(gè)倉(cāng)庫(kù)一起管理呢肌稻?這就是 monorepo。

優(yōu)點(diǎn)

  1. 對(duì)依賴統(tǒng)一進(jìn)行管理伤塌。
  2. 可以抽取邏輯維護(hù)公共庫(kù)灯萍。
  3. 所有項(xiàng)目統(tǒng)一配置相同的工程配置。

缺點(diǎn)

  1. 需要有比較嚴(yán)格的 CR 規(guī)范每聪。
  2. Git 權(quán)限管理難以控制旦棉。
  3. 版本控制比較麻煩

項(xiàng)目都需要規(guī)范的流程齿风。

怎么做

目前來(lái)說(shuō),前端算是有兩種比較常見(jiàn)的對(duì) monorepo 的方案:

  1. lerna.js
  2. yarn workspace

當(dāng)然绑洛,它們也可以同時(shí)使用救斑。

yarn workspaces

它允許設(shè)置多個(gè)包,即只需運(yùn)行一次 yarn 安裝即可一次性安裝所有包真屯。

package.json文件中添加以下內(nèi)容

{
  "private": true,
  "workspaces": ["workspace-a", "workspace-b"]
}

禁止使用

.yarnrc 文件中添加:

workspaces-experimental false

learn.js

Github 倉(cāng)庫(kù)在:https://github.com/lerna/lerna

Lerna is a tool that optimizes the workflow around managing multi-package repositories with git and npm.

Lerna 是一個(gè)使用 git 和 npm 優(yōu)化管理多包存儲(chǔ)庫(kù)的工作流程的工具脸候。

需要注意的是:lerna 只是一個(gè)優(yōu)化工作流程的工具,并不是一個(gè)部署工具绑蔫。

安裝

# 新建一個(gè)項(xiàng)目
mkdir lerna-demo && cd lerna-demo

# 初始化項(xiàng)目
npm init -y

# 安裝 lerna
yarn add lerna -D

# 初始化 lerna 的項(xiàng)目
npx lerna init

此時(shí)一個(gè)最基本的 lerna 項(xiàng)目算是完成了运沦。

(記得添加 .gitignore )

使用

上述的命令完成之后,現(xiàn)在項(xiàng)目的文件目錄:

CleanShot 2021-06-26 at 15.26.21@2x.png

更改一下 package.json 在其中加一個(gè)字段:

{
  "private": true,
  // ...
}

由于我們管理的是子項(xiàng)目配深,一般不對(duì)父項(xiàng)目進(jìn)行發(fā)布處理携添,所以將 private 設(shè)置為 true

然后在 packages 目錄中新建項(xiàng)目即可篓叶。

lerna 會(huì)自動(dòng)檢測(cè)到 packages 里面的項(xiàng)目進(jìn)行管理烈掠。

packages 目錄中的項(xiàng)目需要注意一件事情:

  • package.json 的 name 字段需要和文件夾的名稱相同。

命令

  • lerna init: 初始化
  • learn list: 列出現(xiàn)在管理的項(xiàng)目
  • lerna diff: 列出最近一次 release 的區(qū)別
  • lerna change: 更改了哪些 package
  • lerna bootstrap: 安裝依賴并且鏈接任何交叉依賴項(xiàng)
  • lerna clean: 清理所有依賴項(xiàng)
  • lerna exec: 在每個(gè) package 執(zhí)行命令
  • lerna run: 在包含 npm script 中的每個(gè) package 執(zhí)行 npm script
  • lerna import: 將 package 導(dǎo)入到具有提交歷史記錄的 monorepo 中
  • lerna link: 將相互依賴的所有 package 符號(hào)鏈接在一起

同時(shí)使用

lernayarn workspace 可以同時(shí)使用

lerna.json 添加:

{
  "packages": [
    "packages/*"
  ],
  "version": "0.0.0",
  "npmClient": "yarn",
  "useWorkspaces": true
}

然后在 package.json 添加:

{
  // ...
  "private": true,
  "workspaces": [
    "packages/*"
  ]
}

區(qū)別

yarn workspace 中有這么一段:

Yarn’s workspaces are the low-level primitives that tools like Lerna can (and do!) use. They will never try to support the high-level feature that Lerna offers, but by implementing the core logic of the resolution and linking steps inside Yarn itself we hope to enable new usages and improve performance.

這個(gè)就是區(qū)別

參考

wikipedia Monorepo: https://en.wikipedia.org/wiki/Monorepo

yarn workspace: https://classic.yarnpkg.com/en/docs/workspaces

lerna github: https://github.com/lerna/lerna

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末缸托,一起剝皮案震驚了整個(gè)濱河市左敌,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌俐镐,老刑警劉巖矫限,帶你破解...
    沈念sama閱讀 216,591評(píng)論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異京革,居然都是意外死亡奇唤,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,448評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門匹摇,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)咬扇,“玉大人,你說(shuō)我怎么就攤上這事廊勃⌒负兀” “怎么了?”我有些...
    開(kāi)封第一講書人閱讀 162,823評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵坡垫,是天一觀的道長(zhǎng)梭灿。 經(jīng)常有香客問(wèn)我,道長(zhǎng)冰悠,這世上最難降的妖魔是什么堡妒? 我笑而不...
    開(kāi)封第一講書人閱讀 58,204評(píng)論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮溉卓,結(jié)果婚禮上皮迟,老公的妹妹穿的比我還像新娘搬泥。我一直安慰自己,他們只是感情好伏尼,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,228評(píng)論 6 388
  • 文/花漫 我一把揭開(kāi)白布忿檩。 她就那樣靜靜地躺著,像睡著了一般爆阶。 火紅的嫁衣襯著肌膚如雪燥透。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書人閱讀 51,190評(píng)論 1 299
  • 那天辨图,我揣著相機(jī)與錄音班套,去河邊找鬼。 笑死故河,一個(gè)胖子當(dāng)著我的面吹牛孽尽,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播忧勿,決...
    沈念sama閱讀 40,078評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼瞻讽!你這毒婦竟也來(lái)了鸳吸?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書人閱讀 38,923評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤速勇,失蹤者是張志新(化名)和其女友劉穎晌砾,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體烦磁,經(jīng)...
    沈念sama閱讀 45,334評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡养匈,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,550評(píng)論 2 333
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了都伪。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片呕乎。...
    茶點(diǎn)故事閱讀 39,727評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖陨晶,靈堂內(nèi)的尸體忽然破棺而出猬仁,到底是詐尸還是另有隱情,我是刑警寧澤先誉,帶...
    沈念sama閱讀 35,428評(píng)論 5 343
  • 正文 年R本政府宣布湿刽,位于F島的核電站,受9級(jí)特大地震影響褐耳,放射性物質(zhì)發(fā)生泄漏诈闺。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,022評(píng)論 3 326
  • 文/蒙蒙 一铃芦、第九天 我趴在偏房一處隱蔽的房頂上張望雅镊。 院中可真熱鬧襟雷,春花似錦、人聲如沸漓穿。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 31,672評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)晃危。三九已至叙赚,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間僚饭,已是汗流浹背震叮。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 32,826評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留鳍鸵,地道東北人苇瓣。 一個(gè)月前我還...
    沈念sama閱讀 47,734評(píng)論 2 368
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像偿乖,于是被迫代替她去往敵國(guó)和親击罪。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,619評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容