Monorepo与pnpm最佳实践

本文将介绍如何使用 pnpm 及 Monorepo 实现高效的代码构建和发布流程。

什么是 Monorepo?

Monorepo 是一种将多个项目统一放在一个代码仓库中进行集中管理的方式,适用于项目间耦合度高、共享代码较多的场景

Vue 为例,其源码采用 Monorepo 管理模式,代码仓库中包含多个子项目,如 reactivityruntime-corecompiler-core 等。每个子项目拥有独立的 package.json,可单独安装、运行与测试。

这种管理方式带来的好处包括:

  • 便于团队协作:不同团队在同一代码库中开发,统一规范和流程,避免重复造轮子
  • 提升代码复用率:子项目间可以直接相互引用,无需通过发布依赖包的方式
  • 统一版本与质量控制:更易对各模块进行集中测试、构建与发布,保障整体代码质量
  • 降低开发复杂度:避免多仓库切换与依赖同步问题,提高开发效率

构建 Monorepo 项目

  1. 全局安装

    npm install pnpm -g

  2. 创建 monorepo 仓库:

bash 复制代码
mkdir monorepo && cd monorepo
pnpm init
  1. 在根目录下添加 pnpm-workspace.yaml 文件,告诉 pnpm 当前 Monorepo 中哪些目录属于 workspace
makefile 复制代码
packages:
  - "apps/*"				这是存放"业务应用"的地方,通常是最终运行的项目,比如后台、前台、小程序等。
  - "packages/*"		这是存放"可复用模块/工具库/组件"的地方,所有 apps/ 中的项目可以直接使用它们。
  1. 添加项目
bash 复制代码
mkdir apps && cd apps

# apps-a
mkdir apps-a && cd apps-a
pnpm init

# apps-b
mkdir ../apps-b && cd ../apps-b
pnpm init
  1. 安装依赖
csharp 复制代码
// 安装依赖
pnpm install

// 安装包到根
pnpm add xxx -w

// 安装项目到特定项目
pnpm --filter apps-b add name@version -D

具体的可以看文档:pnpm.io/zh/cli/add

  1. 启动项目
scss 复制代码
// 不需要进到特定的项目来操作
// xxxx  子项目package配置的name名称
pnpm --filter xxxx start 

安装包的原则:

  1. 一般公共的包都是安装到最外层 ,除了版本原因等需要"覆盖的"则安装到特定的项目里
  2. 所有的项目都需要package.json,package.json的name一般是以"@"作为开头,比如@falcon-covoy,这块需要改;
  3. apps-aapps-bpackage.json都是单独的,需要提取公共的包到最外层的package.json
  4. 项目需要完善的部分:Changesets、Semantic-release、Turbopack、Sonar、Commitlint、Sentry报警、Sentry Transcation业务统计等工具
相关推荐
Mike_jia7 分钟前
Memos:知识工作者的理想开源笔记系统
前端
前端大白话8 分钟前
前端崩溃瞬间救星!10 个 JavaScript 实战技巧大揭秘
前端·javascript
loveoobaby9 分钟前
Shadertoy着色器移植到Three.js经验总结
前端
蓝易云12 分钟前
在Linux、CentOS7中设置shell脚本开机自启动服务
前端·后端·centos
浩龙不eMo12 分钟前
前端获取环境变量方式区分(Vite)
前端·vite
土豆骑士23 分钟前
monorepo 实战练习
前端
土豆骑士25 分钟前
monorepo最佳实践
前端
见青..25 分钟前
【学习笔记】文件包含漏洞--本地远程包含、伪协议、加密编码
前端·笔记·学习·web安全·文件包含
学习OK呀41 分钟前
后端上手学习React Router基础知识
前端
宁静_致远43 分钟前
React Native 技术栈:基于 macOS 开发平台的 iOS 应用开发指南
前端·javascript·react native