全栈研发工具同步插件
一个为Cursor和CatPaw IDE设计的VSCode插件，提供一键同步全栈研发工具的功能。
✨ 功能特性
🎯 智能IDE检测
- 自动检测当前运行的IDE类型（Cursor/CatPaw）
- 根据不同IDE自动调整命令参数
📋 Git分支管理
- 获取远程仓库分支列表
- 支持分支选择和记忆功能
- 智能缓存，提升加载速度
🚀 一键同步功能
- 插件安装 (
-p): 安装全栈研发工具插件
- 仅同步Rules (
-r): 同步开发规则到当前项目
- 仅同步MCP (
-m): 同步MCP配置
- 一键同步全栈研发工具 (
-rm): 同步所有工具和配置
🎨 美观的用户界面
- 适配VSCode主题系统
- 响应式设计，支持不同尺寸
- 流畅的动画和交互效果
📦 安装
- 打开VSCode/Cursor/CatPaw IDE
- 进入扩展商店
- 搜索"全栈研发工具同步"
- 点击安装
🎮 使用方法
打开插件面板
- 在侧边栏找到"研发工具同步"面板
- 或使用命令面板 (
Ctrl+Shift+P) 搜索相关命令
基本操作流程
- 选择分支: 在下拉菜单中选择目标分支
- 选择操作: 点击相应的功能按钮
- 执行命令: 插件会在终端中自动执行相应命令
操作说明
| 功能按钮 |
需要项目 |
说明 |
| 📦 插件安装 |
❌ |
全局安装，无需打开特定项目 |
| 📋 仅同步Rules |
✅ |
需要打开项目工程才能执行 |
| ⚙️ 仅同步MCP |
❌ |
全局MCP配置，无需特定项目 |
| 🚀 一键同步全栈研发工具 |
✅ |
需要打开项目工程才能执行 |
🔧 工作原理
插件通过以下方式工作：
- IDE检测: 通过环境变量、执行路径等多种方式检测当前IDE
- 分支获取: 连接远程Git仓库获取分支列表
- 命令构建: 根据IDE类型和选择的分支构建相应命令
- 终端执行: 在VSCode终端中执行构建的命令
生成的命令示例
# Cursor IDE - master分支 - 插件安装
curl -fsSL https://s3plus.sankuai.com/agent-public/AI_Coding/setup/install_plugin_mcp_rule.sh | zsh -s -- -p
# CatPaw IDE - feature分支 - 全栈同步
curl -fsSL https://s3plus.sankuai.com/agent-public/AI_Coding/setup/install_plugin_mcp_rule.sh | zsh -s -- -rm --ide catpaw --branch feature/xxx
⌨️ 快捷键
Ctrl/Cmd + R: 刷新分支列表Ctrl/Cmd + Enter: 执行全栈同步F1: 显示帮助信息
⚙️ 设置和配置
插件会自动记住您的分支选择，无需额外配置。
缓存管理
- 分支信息缓存5分钟自动刷新
- 可手动点击刷新按钮立即更新
- 支持清除缓存功能
🔍 故障排除
常见问题
Q: 无法获取分支列表
A: 请检查：
- 网络连接是否正常
- SSH密钥配置是否正确
- 是否有访问远程仓库的权限
Q: IDE检测显示"Unknown IDE"
A: 这不会影响功能使用，插件会使用默认的Cursor配置
Q: 执行命令失败
A: 请检查：
- 是否已安装必要的命令行工具（curl, zsh, git）
- 终端权限是否正常
- 网络连接是否稳定
📋 日志系统
插件内置了专业的日志系统，帮助你快速定位问题：
📺 查看日志的三种方式
- 插件界面: 点击侧边栏插件面板底部的"📋"按钮
- 命令面板:
Ctrl+Shift+P → 搜索"显示日志面板"
- 输出窗口: 查看 → 输出 → 选择"全栈研发工具同步"
🎛️ 日志级别
- DEBUG: 详细的执行流程和性能统计
- INFO: 重要操作和状态变更
- WARN: 需要注意的问题
- ERROR: 严重错误和异常
🔧 调试技巧
# 启用详细调试日志
Ctrl+Shift+P → "研发工具同步: 启用调试日志"
# 清除历史日志
Ctrl+Shift+P → "研发工具同步: 清除日志"
日志格式示例：
[14:35:21.123] [INFO] [全栈研发工具同步] [GitService] 👤 用户操作: 刷新分支列表
[14:35:21.156] [DEBUG] [全栈研发工具同步] [GitService] 从缓存加载分支
└─ 详细信息: {"count": 5}
💡 提示: 有了专业的日志系统，你可以轻松追踪每个操作的执行过程！详细使用方法请参考日志指南文档
🚀 最佳实践
- 定期刷新分支: 建议在开始工作前刷新分支列表
- 选择正确分支: 确保选择的分支与当前开发需求匹配
- 检查网络环境: 在公司网络环境中使用以确保最佳体验
📋 系统要求
- VSCode 1.60.0 或更高版本
- 支持的操作系统: macOS, Windows, Linux
- 网络连接（用于获取分支和执行下载）
- Git 客户端
🤝 贡献指南
欢迎提交Issue和Pull Request来改进这个插件！
开发环境设置
# 克隆仓库
git clone <repository-url>
# 安装依赖
cd apps/toolsPlugin
npm install
# 编译TypeScript
npm run compile
# 在VSCode中按F5启动调试
📄 许可证
MIT License
📞 支持与反馈
如果您遇到问题或有建议，请：
- 查看本文档的故障排除部分
- 在仓库中提交Issue
- 联系开发团队
享受高效的全栈开发体验！ 🎉
| |
