🚀 快速开始
- 安装插件:在 VS Code 扩展市场搜索 "Yuce Full-Stack Dev Tools" 并安装。
- 打开工具面板:点击 VS Code 状态栏左下角的
$(tools) 预策开发工具 按钮。
- 选择功能:在弹出的面板中,根据分组选择您需要的功能。
✨ 主要功能
🎯 Git Flow 管理
- 自定义 Git Flow:支持
.gflow 文件定义的可视化合并流程
- 智能冲突检测:自动检测合并冲突,无冲突时自动推送
- 实时进度面板:可视化显示执行进度和操作状态
- 统一合并体验:所有合并类型指令都复用 gitflow 的高级功能
- 🛡️ 版本保护机制:针对 cube-front 项目自动防止从高版本向低版本合并
🎨 前端开发工具
- API TypeScript 类型更新:自动更新服务端接口的 TypeScript 类型定义
- SaaS API 类型更新:支持 SaaS 项目的 API 类型同步
- Yuce Icon 图标库:快速访问项目图标资源库
🛠️ SaaS 专用工具
- SaaS 分支管理:支持 saas/develop、saas/test、saas/pre-release 等特殊分支
- 智能合并执行:所有 SaaS 分支合并都具备进度面板和冲突检测功能
🌍 环境管理
- 多环境快速访问:Dev、Test 环境一键打开
- 环境管理插件:安装和配置环境管理工具
🚀 统一合并体验
新特性:所有合并类型的指令现在都复用了 gitflow 中的高级功能:
⚡ 智能执行
- 自动冲突检测:无冲突时自动完成整个合并流程
- 实时进度显示:每个合并操作都有可视化进度面板
- 智能错误处理:精确定位问题并提供解决方案
📊 可视化面板
- 操作状态跟踪:⏳ 待执行 → ⚡ 进行中 → ✅ 已完成
- 进度百分比:实时显示整体完成进度
- 详细操作日志:每步操作的详细信息和状态
🔧 冲突处理
- 智能检测:自动检测合并冲突,无需手动判断
- 非阻塞式处理:遇到冲突时不会弹出模态窗口阻塞工作流程
- 可视化指南:进度面板直接显示详细的冲突解决步骤
- 保持状态:冲突发生时保持合并状态,方便用户解决后继续操作
📋 支持的合并类型
所有以下合并指令都享有完整的 gitflow 高级功能:
- 简单分支合并:当前分支 → develop/test/pre-release
- SaaS 分支合并:当前分支 → saas/develop/test/pre-release
- 版本测试合并:当前分支 → v*.*/test
- Release 逐级合并:release 分支逐步合并到高版本
🛡️ 版本保护机制
专为 cube-front 项目设计的智能版本保护
🔍 自动检测
- 项目识别:自动检测当前项目是否为 cube-front(通过 package.json 中的项目名称)
- 非侵入性:非 cube-front 项目完全不受影响,保持原有合并行为
🚫 保护逻辑
- 版本比较:比较源分支和目标分支 package.json 中的版本号第二位数字(次版本号)
- 阻止回退:如果源分支的次版本号大于目标分支,自动阻止合并操作
- 提前检查:在实际执行 git merge 命令前进行检查,避免产生冲突
📋 适用范围
版本保护机制覆盖所有合并操作:
- ✅ 简单分支合并(当前分支 → develop/test/pre-release)
- ✅ SaaS 分支合并(当前分支 → saas/develop/test/pre-release)
- ✅ 版本测试合并(当前分支 → v*.*/test)
- ✅ Release 逐级合并(release 分支逐步合并到高版本)
- ✅ 自定义 Git Flow 合并
💡 示例场景
源分支版本:2.5.0 (次版本号: 5)
目标分支版本:2.3.0 (次版本号: 3)
结果:🚫 阻止合并,显示详细错误信息
源分支版本:2.3.0 (次版本号: 3)
目标分支版本:2.5.0 (次版本号: 5)
结果:✅ 允许合并,正常执行流程
🔧 错误处理
- 详细提示:显示源分支和目标分支的具体版本信息
- 模态对话框:确保用户看到版本保护错误信息
- 自动恢复:检查失败时自动返回原分支,不影响工作状态
🔧 自定义 Git Flow 配置
- 文件位置:
.vscode/gitflows/your-flow-name.gflow
- 核心语法:
# @description 流程的详细描述,会在选择时显示 (可选)
# 这是普通注释行,会被忽略
source_branch > target_branch (定义一个合并操作)
- 空行会被忽略。
- 执行逻辑:对于每个
source > target ,插件会自动执行 checkout target , pull , merge source 。无冲突则自动 push ,有冲突则暂停等待用户解决。
- 状态图标:面板会显示各操作状态:⏳ 待执行 ⚡ 进行中 ✅ 已完成 ❌ 错误 ⏭️ 跳过。
💡 使用建议
- Git Flow 描述:为
.gflow 文件添加 # @description ,方便团队理解和选择。
- 监控进度:执行 Git Flow 时,保持进度面板打开,实时监控状态。
- 代码提交:在执行任何合并操作前,请确保当前工作区的修改已提交。
执行优化
- 测试流程:先在测试项目中验证流程的正确性
- 命名规范:使用清晰的文件名描述流程用途
- 分步执行:对于复杂流程,考虑分解为多个小流程
- 文档记录:在
.gflow 文件中添加注释说明流程目的
冲突处理
- 保持冷静:遇到冲突时,进度面板会显示详细的处理步骤
- 逐步解决:按照面板提示的步骤依次操作
- 确认解决:完成冲突解决后,记得执行推送操作
- 检查状态:可以通过 VS Code 的源代码管理面板查看文件状态
| |