JS前端架构pnpm怎么构建Monorepo方式管理demo

今天小编给大家分享一下JS前端架构pnpm怎么构建Monorepo方式管理demo的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。

什么是Monorepo?什么是pnpm?

Q:什么是Monorepo?

A:Monorepo是一种项目管理方式,就是把多个项目放在一个仓库里面,可以参考神三元大佬的一篇文章:现代前端工程为什么越来越离不开 Monorepo?,这篇文章中介绍了Monorepo的概念、收益以及MulitRepo的弊端。

Q:什么是pnpm?

A:pnpm就是一个包管理工具,原生支持Monorepo,比npm和yarn更快一些,其他的可以参考官网和另一篇文章:为什么现在我更推荐 pnpm 而不是 npm/yarn?

搞一个Monorepo的demo玩玩

现在我们就开始使用pnpm来构建一个Monorepo,在正事开始之前,你先需要保证你的电脑中具有Node.js,我的版本的是16.9.0

首先你需要有pnpm这个工具,安装的话可以从官网找方法,或者直接使用npm安装,命令如下:

npm i pnpm -g

现在我们开始搞事情。

第一步,创建一个项目的根目录,这里就叫monorepo-demo,咋创建都可,这里使用的是命令:

mkdir monorepo-demo

第二步,初始化package.json,这个没啥说的,命令如下:

pnpm init

这里我对内容做了一点修改,package.json的内容如下:

{
  "name": "monorepo-demo",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "type": "module",
  "keywords": [],
  "author": "ywanzhou",
  "license": "MIT"
}

这里我主要添加了一个type字段,这里我使用ESModule模块化规范。

第三步,创建pnpm-workspace.yaml文件,这个文件定义了工作空间的根目录,内容如下:

packages:
  - 'packages/ **'

现在我们就可以在packages中创建多个项目了,目录结构如下:

monorepo-demo
├── package.json
├── packages
│   ├── components
│   │   ├── index.js
│   │   └── package.json
│   ├── core
│   │   ├── index.js
│   │   └── package.json
│   ├── utils
│   │   ├── index.js
│   │   └── package.json
├── pnpm-lock.yaml
└── pnpm-workspace.yaml

第四步,编写每个项目的package.json,其实主要是编写一下名称,方便以后使用,这里我的如下:

{
  "name": "@packages/components",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "type": "module",
  "license": "ISC",
  "dependencies": {
    "lodash": "^4.17.21",
    "@packages/utils": "workspace:^1.0.0"
  }
}

剩余的两个名称分别为@packages/core@packages/utils

其实到这基本工作就准备好了,现在介绍一下如何安装依赖,如何在packageA中引用packageB。

安装依赖

就这个demo来说,我们如果在根目录下安装依赖的话,这个依赖可以在所有的packages中使用,如果我们需要为具体的一个package安装依赖怎么办?

cd到package的所在目录嘛?漏,大漏特漏,我们可以通过下面这个命令:

pnpm --filter <package_selector> <command>

例如我们需要在@packages/components安装lodash,命令如下:

pnpm -F @packages/components add lodash

-F等价于--filter

现在我们在往@packages/utils中安装一个dayjs,命令如下:

pnpm --filter @packages/utils add dayjs

packageA中引用packageB

现在我们就来实现package间的相互引用,首先我们在@packages/utils/index.js中写入如下内容:

import dayjs from 'dayjs'
export function format(time, f = 'YYYY-MM-DD') {
  return dayjs(time).format(f)
}

然后我们执行如下命令:

pnpm -F @packages/components add @packages/utils@*

这个命令表示在@packages/components安装@packages/utils,其中的@*表示默认同步最新版本,省去每次都要同步最新版本的问题。

安装完成后@packages/components/package.json内容如下:

{
  "name": "@packages/components",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "type": "module",
  "license": "ISC",
  "dependencies": {
    "@packages/utils": "workspace: *",
    "lodash": "^4.17.21"
  }
}

然后我们在@packages/components/index.js写入如下内容:

import { format } from '@packages/utils'
console.log(format(new Date()))

然后我们在项目根目录运行如下命令

node packages/components

即可打印出当前的日期。

以上就是“JS前端架构pnpm怎么构建Monorepo方式管理demo”这篇文章的所有内容,感谢各位的阅读!相信大家阅读完这篇文章都有很大的收获,小编每天都会为大家更新不同的知识,如果还想学习更多的知识,请关注本站行业资讯频道。

相关推荐:

为什么在大型Python项目中推荐使用Monorepo环境管理?

Monorepo是应对跨子包频繁修改、版本对齐成本高、CI耗时爆炸等痛点的止损方案;需统一依赖管理、确保本地与CI环境一致,并严守子包独立测试边界。 Monorepo不是“更先进”,而是对特定规模和协作模式的项目更可控——当Python项目中出现跨子包频繁修改、版本对齐成本高、CI耗时爆炸或本地开发...

Python hatch vs poetry monorepo 支持

hatch默认不识别monorepo子包,需显式配置workspace.members;poetry需子包声明include才能安装;二者运行命令时工作目录策略不同,ci中应显式指定--cwd。 hatch在monorepo里默认不识别子包 hatch默认把整个仓库当做一个项目,pyproject....

Python 多包 monorepo 的管理工具

poetry默认将当前目录视为项目根,pyproject.toml所在处即主包位置;monorepo中需cd进子包目录或用--directory指定路径执行poetryadd,否则依赖误写入顶层配置。 poetryadd为什么总装到root包而不是子包? 因为Poetry默认把当前目录当项目根,py...

PythonPlotly交互式图表教程_动态数据展示实战

Plotly是Python中制作交互式图表的首选工具,支持缩放、悬停、拖拽等交互功能,三步即可创建图表:准备数据、调用px.line等函数、用fig.show()显示或write_html导出;支持动画、实时刷新与用户交互驱动更新;可定制悬停信息、适配移动端并保障离线使用。 用Plotly快速创建可...

Python路径操作教程_ospath与pathlib详解

优先选pathlib用于新项目,os.path适合轻量脚本;前者面向对象、链式调用、IDE支持好,后者函数式、兼容性强、无需实例化。 Python中处理文件路径,os.path和pathlib是最常用的两个模块。前者是传统函数式风格,兼容性好;后者是面向对象设计,更直观、更现代。选哪个?不是非此即彼...

Python单元测试项目实战教程_覆盖率分析与断言应用

Python单元测试需兼顾覆盖率与精准断言:用pytest-cov生成HTML报告查漏补缺,聚焦missedlines;用原生assert验证返回值、异常和状态变化;通过parametrize覆盖边界与异常场景;在CI中设fail_under阈值强制保障质量。 写Python单元测试不只是让代码“跑...

Python项目重构策略_逐步演进解析【教程】

Python项目重构是持续优化可维护性、可读性和可扩展性的过程,需小步快跑、测试护航、目标明确;优先改进命名与结构,补关键单元测试,解耦依赖,渐进升级技术债。 Python项目重构不是一次性的大手术,而是围绕可维护性、可读性和可扩展性持续优化的过程。关键在于小步快跑、测试护航、目标明确——每次改动只...

Python接口数据校验_防止脏数据解析【教程】

Python接口数据校验核心是精准拦截非法输入,用Pydantic定义请求模型实现类型与业务规则校验,分层处理参数级、业务级和外部依赖级验证,并统一返回前端友好的错误结构。 Python接口数据校验的核心,是提前拦截非法、缺失或格式错误的输入,避免后续逻辑因脏数据崩溃或产生错误结果。关键不在于“全量...