pnpm9.5.0(catalog协议)

catalog(目录协议)

目录是工作区功能,用于将依赖版本范围定义为可重用常量,目录中定义的常量可以在package.json中使用,

结合 pnpm-workspace.yaml使用

  • 定义pnpm-workspace.yaml
    packages:定义多仓库
javascript 复制代码
packages:
  - 'packages/*'

catalog:
  chalk: ^4.1.2

catalogs:
  react16:
    react: ^16.7.0
    react-dom: ^16.7.0
  react17:
    react: ^17.10.0
    react-dom: ^17.10.0

这里有两种方式定义 catalog

  • catalog

普通定义,一一对应,默认值为default

javascript 复制代码
// pnpm-workspace.yaml
catalog:
  chalk: ^4.1.2
javascript 复制代码
// packages/app/package.json
{
  "name": "app",
  "dependencies": {
    "chalk": "catalog:"
  }
}
  • catalogs

具名,将多个catalog整合成一个catalogs

javascript 复制代码
// pnpm-workspace.yaml
catalogs:
  react16:
    react: ^16.7.0
    react-dom: ^16.7.0
  react17:
    react: ^17.10.0
    react-dom: ^17.10.0
javascript 复制代码
// packages/app/package.json
{
  "name": "app",
  "dependencies": {
    "react": "catalog:react18",
    "react-dom": "catalog:react18"
  }
}

优点

monorepo或多包存储库中,许多包是有相同依赖的。目录减少了 package.json文件时的重复,并提供以下好处

  • 维护唯一版本

工作区中最好只有一个版本的依赖项。目录使维护更容易。重复的依赖项可能会在运行时发生冲突并导致错误。

  • 升级简单

升级依赖时,只需要编辑目录,而不用修改各个包中的package.json

  • 更少的合并冲突

由于依赖项变动不需要编辑package.json,这类文件导致的冲突将最小化

运行与发布

在运行时,catalog协议会被删除,发布时会被替换成对应版本

注意事项

使用pnpm update并不能更新pnpm-workspace.yaml依赖项,需要手动选择。

相关推荐
_默_4 小时前
adminPage-vue3依赖DetailsModule版本说明:V1.2.1——1) - 新增span与labelSpan属性
前端·javascript·vue.js·npm·开源
前端郭德纲20 小时前
一些npm总结(持续更新...)
npm
油丶酸萝卜别吃20 小时前
NPM镜像源
前端·npm·node.js
西西小飞龙1 天前
调试、发布自己的 npm 包
前端·npm
绝尘小浪1 天前
mac 安装指定的node和npm版本
前端·macos·npm
脱了格子衬衫1 天前
npm/pnpm/yarn设置国内淘宝源
前端·npm·node.js
郑小憨1 天前
Node.js GET/POST请求、WEB模块使用介绍 (基础介绍 八)
开发语言·前端·javascript·npm·node.js
夜间出没的AGUI2 天前
npm常用函数定义手册(持续更新)
前端·npm·node.js
南城巷陌2 天前
node.js实现自定义npm包并发布
前端·javascript·npm·node.js·npm包
菜鸡码农,喵。3 天前
vite+vue项目创建流程;npm error enoent Could not read package.json异常报错问题
vue.js·npm·json