nodejs项目Monorepo模式的基础操作

简单说明

Monorepo(一仓多包),主要是指nodejs环境下的项目,简单说就是在一个git代码仓库下,把项目拆分为多个package,可以分别开发但又互相协作。

举例

一个nodejs环境下的全站项目,需要前后端分离,这很自然的就会产生一个情况,前后端后使用一些共同的定义,比如复杂的接口参数。这时,把这些接口参数的定义,放到一个公共的地方,就是一个很自然很合理的做法。这就是Monorepo的一个基础使用场景。 技术上,Monorepo需要使用pnpm的workspace。

项目搭建过程

shell 复制代码
// 首先全局安装pnpm
npm install -g pnpm

// 创建项目基本目录
mkdir prj_root
// 在项目根目录下init
pnpm init

// 如果确定的话,可以先安装一些公用的包在根目录 比如vite
pnpm add vite -w
pnpm add -D typescript -w
pnpm add -D @types/node -w

// 创建tsconfig
pnpm tsc --init

// 创建pnpm的workspace管理文件
touch pnpm-workspace.yaml

pnpm-workspace.yaml中写入

yaml 复制代码
packages:
    - 'packages/*'

下面进行子包的操作

共享库 shared

shell 复制代码
// 创建packages目录,在其中进行多包的操作
cd prj_root && mkdir packages

// 先创建共享库
cd packages && mkdir shared && pnpm init && pnpm tsc --init

// 创建 src/index.ts
// 先写一个简单的interface 代码不贴了
    
// 

后端 backend

shell 复制代码
cd packages && mkdir backend && pnpm init && pnpm tsc --init
 

子包的tsconfig要继承根目录的tsconfig

json 复制代码
{
  "extends": "../../tsconfig.json",
  "compilerOptions": {
    "outDir": "./dist",
    "rootDir": "./src"
  }
}

添加共享包

shell 复制代码
// 通过workspace方式添加
pnpm add @agent4/shared@workspace:*

前端frontend

shell 复制代码
// 前端子包操作
相关推荐
feixing_fx6 小时前
第一个 JS 程序:在浏览器控制台和 Node 中分别运行
开发语言·前端·javascript·前端框架·ecmascript
feixing_fx8 小时前
变量与声明:let、const、var 的选择边界
开发语言·前端·javascript·前端框架
JavaGuide10 小时前
Cloudflare 开源的这套神级安全审计 Skill 太好用了!
前端·后端
孟健11 小时前
用 unslop 拯救 AI 生成网页的塑料感,7 分钟重构落地实测
前端·人工智能·ai编程
feixing_fx11 小时前
JavaScript 是什么:从浏览器脚本到通用编程语言
开发语言·前端·javascript·前端框架·ecmascript
丘山望岳11 小时前
【开发工具】 cluade code常用快捷键
前端
小巫编程室12 小时前
我造了一个 Java 能力包:让 AI 直接调用你的业务代码
java·前端·后端
小y的笔记12 小时前
JavaScript URL 状态同步
前端·javascript
十有八七12 小时前
手搓 Agent(五):学会翻书——RAG,先查资料再回答
前端·人工智能·后端
Swot12 小时前
产品 RAG 知识库与 AI 顾问 设计与实现
前端·后端