版本管理
本文档说明 keymaster 的版本管理策略以及如何选择和使用不同版本的文档。
📦 当前版本
- @keekuun/keymaster-core:
0.5.0 - @keekuun/keymaster-react:
0.5.0 - @keekuun/keymaster-vue:
0.5.0
💡 提示：文档站点始终显示最新版本的文档。如果你使用的是旧版本，请参考下面的版本兼容性说明。
🔍 查看所有版本
方式一：npm 包页面
访问以下链接查看所有已发布的版本：
- Core: https://www.npmjs.com/package/@keekuun/keymaster-core?activeTab=versions
- React: https://www.npmjs.com/package/@keekuun/keymaster-react?activeTab=versions
- Vue: https://www.npmjs.com/package/@keekuun/keymaster-vue?activeTab=versions
在 npm 页面中，你可以：
- 查看所有历史版本
- 查看每个版本的发布说明
- 查看每个版本的依赖关系
- 下载特定版本的包
方式二：GitHub Releases
访问 GitHub Releases 查看：
- 详细的版本发布说明
- 变更日志（CHANGELOG）
- 下载源代码
方式三：npm 命令行
bash
# 查看所有可用版本
npm view @keekuun/keymaster-react versions
# 查看最新版本
npm view @keekuun/keymaster-react version
# 查看特定版本的详细信息
npm view @keekuun/keymaster-react@0.1.0📋 版本兼容性
语义化版本
keymaster 遵循 语义化版本 规范：
- 主版本号（Major）：不兼容的 API 修改
- 次版本号（Minor）：向下兼容的功能性新增
- 修订号（Patch）：向下兼容的问题修正
版本兼容性矩阵
| Core 版本 | React 版本 | Vue 版本 | 兼容性 |
|---|---|---|---|
| 0.1.x | 0.1.x | 0.1.x | ✅ 完全兼容 |
| 0.2.x | 0.1.x | 0.1.x | ⚠️ 可能不兼容（需检查） |
| 0.1.x | 0.2.x | 0.1.x | ⚠️ 可能不兼容（需检查） |
⚠️ 注意：React 和 Vue 包都依赖 core 包。建议保持三个包的版本号一致，或至少确保依赖的 core 版本兼容。
检查你的版本
bash
# 在项目根目录运行
npm list @keekuun/keymaster-react
npm list @keekuun/keymaster-vue
npm list @keekuun/keymaster-core🔄 版本升级指南
补丁版本升级（0.1.0 → 0.1.1）
通常只包含 bug 修复，建议立即升级：
bash
npm update @keekuun/keymaster-react
npm update @keekuun/keymaster-vue
npm update @keekuun/keymaster-core小版本升级（0.1.x → 0.2.x）
可能包含新功能，但保持向后兼容：
- 查看变更日志：访问 GitHub Releases 查看新功能
- 更新依赖：bash
npm install @keekuun/keymaster-react@latest npm install @keekuun/keymaster-vue@latest npm install @keekuun/keymaster-core@latest - 测试应用：确保所有快捷键功能正常工作
大版本升级（0.x.x → 1.0.0）
可能包含破坏性变更，需要仔细评估：
- 阅读迁移指南：查看 CHANGELOG.md
- 检查破坏性变更：查看是否有 API 变更
- 更新代码：根据迁移指南修改代码
- 全面测试：确保所有功能正常
📚 文档版本说明
文档站点版本
文档站点（https://keymaster-docs.vercel.app）始终显示最新版本的文档。
如果你使用的是旧版本
如果你安装的是旧版本（例如 0.1.0），但文档显示的是新版本（例如 0.1.2），请注意：
- API 可能略有不同：新版本可能添加了新功能，但旧版本可能不支持
- 查看对应版本的 README：在 npm 包页面可以查看每个版本的 README
- 查看 GitHub 历史：在 GitHub 中切换到对应版本的 tag，查看当时的文档
查看历史版本的文档
GitHub Tags：
- 访问 https://github.com/Keekuun/keymaster/tags
- 选择对应的版本 tag（例如
v0.1.0） - 查看该版本的 README 文件
npm 包页面：
- 在 npm 包页面的版本列表中，选择特定版本
- 查看该版本的 README 内容
🐛 版本相关问题
问题 1：安装的版本与文档不匹配
症状：按照文档使用 API，但出现类型错误或运行时错误。
解决方案：
- 检查你安装的版本：
npm list @keekuun/keymaster-react - 查看该版本的 README（在 npm 包页面）
- 或者升级到最新版本：
npm install @keekuun/keymaster-react@latest
问题 2：依赖版本冲突
症状：React 包和 core 包版本不匹配。
解决方案：
bash
# 确保版本一致
npm install @keekuun/keymaster-core@0.1.2
npm install @keekuun/keymaster-react@0.1.2
npm install @keekuun/keymaster-vue@0.1.2问题 3：需要锁定特定版本
如果你需要锁定到特定版本（例如避免自动升级）：
json
{
"dependencies": {
"@keekuun/keymaster-react": "0.1.0",
"@keekuun/keymaster-vue": "0.1.0",
"@keekuun/keymaster-core": "0.1.0"
}
}📝 版本发布流程
关于如何发布新版本，请查看 发布文档。