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做版本管理。

你可能感兴趣的:(Mono-Repo手把手指南)