git任务⚔️
把你的代码库变成RPG。GitHub Copilot CLI的MCP服务器。
git任务 扫描您的存储库以查找维护任务——丢失的文档、TODO注释、未测试的文件——并将其作为RPG风格的任务呈现。完成任务以获得经验值、升级和解锁徽章！
快速开始
# 1. Install & register as MCP server
npx git-quest setup
# 2. Open Copilot CLI in any project
copilot
# 3. Start questing!
> scan this repo for quests输出示例
⚔️ QUEST BOARD — 5 quests found!
🌱 Level: Novice | XP: 0 [░░░░░░░░░░] 0% to Apprentice
──────────────────────────────────────────────────
[Quest #1] ★☆☆ 📜 "Scrolls of validateToken"
→ Add JSDoc documentation to `validateToken` in src/auth.ts
→ Reward: +10 XP
→ Hint: Add JSDoc documentation with @param and @returns tags
[Quest #2] ★★☆ 🔍 "The Forgotten Task: refactor to use proper error types"
→ TODO: refactor to use proper error types (src/utils.ts:1)
→ Reward: +15 XP
→ Hint: Implement the change described in the comment
[Quest #3] ★★★ 🐉 "The Untested Dragon: parser"
→ src/parser.ts has no corresponding test file
→ Reward: +25 XP
→ Hint: Create a test file with at least one test case特性
🔍 三台扫描仪
- 缺少文档 (📜 ★☆☆) — 查找没有JSDoc的导出函数/类
- 全猎人 (🔍 ★★☆) — 查找TODO、FIXME、HACK、XXX评论
- 缺失测试 (🐉 ★★★) — 查找没有测试文件的源文件
📊 XP和级别
| 级别 | 需要XP | 图标 |
|---|---|---|
| 新手 | 0 | 🌱 |
| 学徒 | 25 | ⚔️ |
| 旅人 | 75 | 🛡️ |
| 专家 | 150 | 🔮 |
| 大师 | 300 | 👑 |
| 传奇 | 500 | 🐉 |
🏅 徽章
| 徽章 | 要求 |
|---|---|
| 🩸 第一滴血 | 完成你的第一个任务 |
| 📜 Scribe | 文档3功能 |
| 🪲 终结者 | 解决5个TODO |
| 🛡️ Guardian | 创建3个测试文件 |
| 🐉 屠龙者 | 完成一个★★★ 探索 |
| ✨ 完美主义者 | 一次扫描完成所有任务 |
运作原理
- 扫描 --git quest遍历您的项目文件并运行扫描程序以查找维护任务
- 接受 --选择一个任务来完成；获取详细的说明和提示
- 修复 --进行代码改进（添加文档、解决TODO、编写测试）
- 验证 --git任务重新扫描以确认修复、奖励XP和徽章
进度保存在 .git-quest.json 在您的项目根目录中。承诺与您的团队分享进展！
可用工具
| 工具 | 说明 |
|---|---|
scan_quests | 扫描仓库以获取维护任务 |
accept_quest | 按数字接受任务 |
verify_quest | 验证任务完成情况 |
player_stats | 显示级别、经验值、徽章 |
quest_log | 显示任务历史记录 |
演示
A. demo-repo/ 目录中包含故意有缺陷的代码，可生成约15个任务。非常适合测试！
cd demo-repo
copilot
> scan this repo for quests贡献
欢迎投稿！新扫描仪的想法：
- 复杂性分析器（长函数）
- 死码检测器
- 依赖漏洞扫描程序
- 代码样式执行器
许可证
麻省理工学院