Monorepo单仓多包&独立部署

772 阅读2分钟

仓就是仓库(repository,简称 repo),通常我们使用多个仓库(简称多仓,multi-repo)来管理项目代码,也就是每个仓库负责一个模块或包的编码、构建、测试和发布,代码规模相对较小,所以也称为小型规模仓库(简称小仓)。而单一(mono)仓库(简称单仓,mono-repo)是指在一个仓库中管理多个模块或包,当代码规模达到一定程度后可称为大型规模仓库(简称大仓)。

image.png

1. 目录结构「monorepo」

project-root/
├── packages/                      # 公共模块目录(跨子项目共享)
│   └── shared/                   # 公共模块(可跨子项目复用)
│       ├── api/                  # 公共接口封装
│       ├── utils/                # 工具函数、通用方法
│       ├── components/           # 公共 Vue/React 组件
│       └── styles/               # 公共样式文件,例如变量、mixin等
│
├── apps/                          # 子项目目录,每个子项目独立打包部署
│   ├── mobile/                    # mobile 子项目
│   │   ├── assets/               # 页面专属静态资源(图片、图标等)
│   │   ├── router/               # 页面专属路由配置
│   │   ├── store/                # 页面专属状态管理(vuex、pinia 等)
│   │   ├── views/                # 页面视图组件
│   │   ├── App.vue               # 根组件
│   │   └── main.js               # 入口文件,挂载 App.vue 并初始化子项目        
│   │
│   └── ...                       # 其他子项目,结构同 mobile 子包
│
├── build/                         # webpack 配置、打包脚本、构建工具等
├── package.json                   # 项目依赖、npm scripts、monorepo 配置
└── README.md                      # 项目说明文档

2. 入口、出口以及别名

const path = require("path");
const fs = require("fs");

// 根目录 apps 路径
const appsPath = path.resolve(__dirname, "../apps");

// 获取所有子包目录
const appDirs = fs
  .readdirSync(appsPath, { withFileTypes: true })
  .filter(dirent => dirent.isDirectory())
  .map(dirent => dirent.name);

// 构建子包别名 比如 @mobile @market
const alias = Object.fromEntries(
  appDirs.map(name => [`@${name}`, path.resolve(appsPath, name)])
);

module.exports = { apps: appDirs, alias };
// webpack 入口、出口以及别名
const APP_NAME = process.env.APP_NAME || "mobile";
if (!apps.includes(APP_NAME)) {
  throw new Error(`未找到${APP_NAME}应用,请检查apps目录`);
} else {
  console.log(`🚀 开始编译${APP_NAME}应用`);
}
entry: {
  base: ["core-js/stable", "regenerator-runtime/runtime"],
  main: [resolve(`apps/${APP_NAME}/main.js`)]
},
output: {
  filename: "js/[name].[chunkhash:8].js",
  path: resolve(`${process.env.OUTPUT_DIR || "dist"}/${APP_NAME}`)
},
alias: {
  "@": resolve("packages/shared"),
  "~": resolve(""),
  ...alias
}

3. 子包单独编译

1. 根目录统一管控

// 打包所有子包
"build:prod": "pnpm run -r build:prod",
"build:test": "pnpm run -r build:test",
// 编译单独子包
"dev:mobile": "pnpm --filter mobile dev",
"dev:market": "pnpm --filter market dev",

2. 子包打包配置

{
  "name": "mobile",
  "version": "1.0.0",
  "private": true,
  "scripts": {
    "build:prod": "cross-env NODE_ENV=production BUILD_ENV=prod APP_NAME=mobile webpack --progress --config ../../build/webpack.prod.js",
    "build:test": "cross-env NODE_ENV=production BUILD_ENV=test APP_NAME=mobile webpack --progress --config ../../build/webpack.prod.js",
    "dev": "cross-env NODE_ENV=development BUILD_ENV=dev APP_NAME=mobile webpack serve --progress --config ../../build/webpack.dev.js"
  }
}