Skeleton项目中使用PNPM Catalogs管理Zag.js组件版本同步

在Skeleton项目中，团队最近集成了Zag.js库，这是一个提供无头UI组件的工具库。Zag.js的一个特点是每个组件都作为独立的NPM包发布，例如@zag-js/accordion、@zag-js/avatar等。这种架构虽然灵活，但也带来了版本管理的挑战。

问题背景

当项目依赖多个Zag.js组件时，每个组件包都需要保持版本一致。例如：

"@zag-js/accordion": "^0.65.0",
"@zag-js/avatar": "^0.65.0",
"@zag-js/progress": "^0.65.0"

如果这些包的版本不同步，可能会导致类型解析错误或功能异常。手动维护这些版本号既繁琐又容易出错，特别是在大型项目中。

PNPM Catalogs解决方案

Skeleton团队决定采用PNPM的Catalogs功能来解决这个问题。Catalogs允许开发者定义一个版本变量，然后在多个依赖中引用这个变量。当需要更新版本时，只需修改这个变量的值，所有相关依赖都会自动同步更新。

实现步骤

1. 在项目根目录创建或修改pnpm-workspace.yaml文件
2. 定义版本变量，例如：

   catalogs:
     zagVersion: "0.65.0"
   

3. 在package.json中使用变量：

   {
     "dependencies": {
       "@zag-js/accordion": "${zagVersion}",
       "@zag-js/avatar": "${zagVersion}"
     }
   }
   

团队协作要求

为了确保所有团队成员和贡献者都能顺利使用这一功能，项目需要：

1. 明确指定PNPM的最低版本要求
2. 更新贡献者文档，说明Catalogs的使用方法
3. 在CI/CD流程中加入版本一致性检查

技术优势

使用PNPM Catalogs管理依赖版本具有以下优势：

1. 版本一致性：确保所有相关包使用相同版本
2. 维护简便：只需修改一处即可更新所有依赖
3. 减少错误：避免因版本不一致导致的运行时问题
4. 更好的协作：团队成员无需手动同步版本号

这一改进不仅适用于Zag.js组件，也可以扩展到项目中其他需要保持版本同步的依赖组。