基于pnpm从0搭建Monorepo工程

image.png

为什么使用Monorepo

公司前端项目大大小小也有数十个了,每个项目都是独立的一个仓库地址,典型的Mutiplerepo

随着项目增多,发现每次起新项目都要重新创建模板然后定义一些项目框架然后在着手开发。

痛点:

  • 每次新项目都需要重新搭建工程
    解决:
  • 用cli做了一键生成项目脚手架解放了一部分劳动力,这个是基于仓库的template模板工程

又来一个痛点:

  • 很多开发过程中的关于基础建设的idea都被封存在各自的项目里,导致template工程没有人持续维护,基本维持刚开始的样子,导致脚手架逐渐落后。

解决:

  • Monorepo 管理方案,可以很大程度改善以上的问题

也方便做很多代码风格质量以及ci相关流程的统一管理,决定也搭建一套自己的Monorepo工程模板

开始

为什么使用pnpm?

pnpm 的特点:快速、高效利用磁盘空间。

它将 workspace 的所有依赖都下载到.pnpm目录下,然后再根据各个 package 的情况,在其目录下通过软连接方式将依赖添加进来,这样所有的依赖只需要下载一次,那么不仅快,而且磁盘体积也小

而且它原生 cli 支持基本的 workspace 管理,这也是我对比下来选择 pnpm 的原因

学习成本低、简单好用

安装pnpm

npm install -g pnpm

创建workspace

pnpm init

根目录创建pnpm-workspace.yaml

packages: 
    - "libs/**"
    - "projects/**"

创建自己的目录结构

├── libs
│   ├── core
│   │   ├── package.json
│   │   └── pnpm-lock.yaml
│   ├── ui
│   │   ├── package.json
│   │   └── pnpm-lock.yaml
│   ├── util
│   │   ├── package.json
│   │   └── pnpm-lock.yaml
├── projects
│   ├── demo
│   │   ├── package.json
│   │   └── pnpm-lock.yaml
├── package.json
├── pnpm-lock.yaml
└── pnpm-workspace.yaml

现在基本上我们已经有一个 mini 版的 workspace 了,至少整个目录结构看上去像那么回事。

使用pnpm cli 管理 workspace

1、配置依赖

比如我们的 core 包:

  • 各种 Base类
  • Http
    那么我们需要给 core 安装 axios 以及 qs

比如我们的 demo 工程:

  • vue
  • vite

以及我们的全局生效的依赖:

  • eslint
  • mocha
  • nyc
  • typescript
  • ...

这里因为该 Monorepo 都是 vue3 + vite 相关技术栈,所以我把相关依赖也一并安装到 root,这样以后新建的 project 就不用重新安装依赖啦!

2、安装依赖

cd libs/core && pnpm i?

No No No!

pnpm 早就帮我们考虑到了,直接根目录就可以指定安装子包的依赖

-F, --filter <package_name> 可以指定目标 package 执行任务

pnpm i -F core

那问题来了,如果多个包都配置好了依赖,想要一键安装怎么办,一个一个包去这样做吗?

还是说pnpm i -F core ui util

三个还好说,三十个呢?

这个时候我们需要了解一下 -r, --recursive 命令可以做到一键递归安装

pnpm i -r

3、根目录执行命令

除了一些全局生效的命令之外,像我们可以按需求配置执行 project 的启动和打包

// root pkg.json
"script": {
    "dev:demo": "pnpm -F demo dev",
    "build:demo": "pnpm -F demo build"
}

// demo pkg.json
"scripts": {
    "dev": "vite",
    "build": "vue-tsc --noEmit && vite build",
    "preview": "vite preview"
}

4、project 关联 libs

安装好依赖之后,我们可以简单写一点代码到core包里面,比如:

// index.ts
export function add(a: number, b: number) {
    return a + b;
}

然后我们在demo工程里执行 pnpm i @libs/core -F demo

我们会发现 demo 的 pkg.json 多了这个

{
    "dependencies": {
        "@libs/core": "workspace:*", // * 代表默认同步最新版本,正常安装完应该是 ^1.0.0
    }
}

我们尝试在文件中导入 core 中 add 方法

import { add } from "@libs/core";

console.log(add(1, 2));

我们就已经成功在项目中引入 libs/core 了

总结

我们通过以上步骤已经可以搭建出一个完整的 Monorepo 工程项目了,接下来就是不断补充内容,丰满羽翼,争取早日投入到生产实践中

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

推荐阅读更多精彩内容