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)
- 對(duì)依賴統(tǒng)一進(jìn)行管理伤塌。
- 可以抽取邏輯維護(hù)公共庫(kù)灯萍。
- 所有項(xiàng)目統(tǒng)一配置相同的工程配置。
缺點(diǎn)
- 需要有比較嚴(yán)格的 CR 規(guī)范每聪。
- Git 權(quán)限管理難以控制旦棉。
- 版本控制比較麻煩
項(xiàng)目都需要規(guī)范的流程齿风。
怎么做
目前來(lái)說(shuō),前端算是有兩種比較常見(jiàn)的對(duì) monorepo 的方案:
當(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)目的文件目錄:
更改一下 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í)使用
lerna
和 yarn 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