Mono-Repo手把手指南

什么是mono-repo?

mono-repo:多个项目package放在一个仓库中。区别与muti-repo:多个项目放在多个仓库中。
(在muti-repo中不同repo需要项目依赖时,常见技术手段:submodule/subtree等,后面详细介绍。)
mono-repo 优缺点:
好处:

  • 减少repo,便于开发修改,多个项目开发周期一起(统一规范)
  • 不同package间依赖方便

缺点:

  • 一个项目代码体积会增加,初次配置交复杂。
  • 项目不同package 安全性问题

常见 monorepo方案:

yarn monorepo

yarn中引入workspace 概念实现mono-repo,具体操作:

  • 执行yarn install 初始化
  • package.json 中添加workspace,添加monorepo子项目文件夹


    image.png
  • 根package.json 指定workspace(private:true标明改monorepo项目不会发到npm公网,workspace可以为正则)


    image.png
  • 为个子项目添加 dependecy(最好使用yarn add 可以提取公共依赖到根node_moudules,)
{
  "name": "workspace-b",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {
    "@ea/utils": "^0.3.3",
    "cross-env": "5.0.5",
    "lodash": "^4.17.21",
    "@kk/workspace-a": "^1.0.0"
  },
  "author": "",
  "license": "ISC"
}

{
  "name": "@kk/workspace-a",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {
    "@ea/utils": "^0.3.3",
    "cross-env": "5.0.5",
    "lodash": "^4.17.21"
  },
  "author": "",
  "license": "ISC"
}

注意点:不要npm ,yarn混用,yarn可以提取公共依赖到root node_modules中。混用后执行yarn(yarn install) 可以重新链接依赖
更多workspace相关操作详见:https://yarn.bootcss.com/docs/cli/workspace/

yarn核心原理:自动生成一些软连接在node_modules中
常用命令:

yarn (等于yarn install)   //统一依赖,提取公共
yarn init   //初始化
yarn workspaces info  查看依赖
yarn workspaces run xxx 为所有工作区执行命令
yarn workspace [workspace name] [command] 为特定工作区执行命令

learn monorepo

具体操作:

  • 执行lerna init初始化项目
    image.png
  • 执行 lerna create 添加package
    image.png
  • 执行 lerna add 为特定package或这所有package添加依赖
    注意默认lerna add会在每个子package中添加依赖,执行
    lerna bootstrap --hoist回重新提取公共依赖

对比:lerna 善于版本管理,yarn monorepo 更方便点。
常用命令:

lerna init  //初始化learn项目
lerna create // 新增package
lerna add // 增加依赖
lerna bootstrap  // 链接依赖
lerna clean // 删除所有node_modules文件
lerna publish //发布

最佳实践:

1,关联性强的项目组成monorepo(开发时相互关联)。可以统一依赖管理,开发周期在一起。
2,复杂基础库,组件库可以单独monorepo。业务库依赖他们。
3,不同package 公共逻辑部分(整个业务通用抽离为npm包,monorepo内部通用抽离share package)。
4,yarn 做monorepo,lerna做版本管理。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,372评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,368评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,415评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,157评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,171评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,125评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,028评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,887评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,310评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,533评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,690评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,411评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,004评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,812评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,693评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,577评论 2 353

推荐阅读更多精彩内容