Github TODO Scanner

🚀 TODO 扫描器

TODO 扫描器是一款极其简单的工具，用于发现代码中需要完成的任务。当你有代码且其中存在待办事项（TODO）时，此工具能帮你快速找到它们。

🚀 快速开始

TODO 扫描器操作简单，能快速定位代码中的待办事项。下面为你介绍它的使用步骤。

✨ 主要特性

• 高效扫描：以高效的方式扫描 git 仓库，找出隐藏在其中的 TODO。
• 精准匹配：查找注释中的常见 TODO 模式，如 TODO:、# TODO 或 // TODO。
• 简洁界面：将找到的 TODO 以干净整洁的界面呈现给你，无繁琐操作和复杂流程。
• 支持多方式使用：提供 Web 界面、Cloudflare 快速隧道和 API 等多种使用方式。
• 遵循标准：实现了模型上下文协议（MCP）标准，带有参数化 OpenAPI 规范，API 清洁且文档始终保持最新。

📦 安装指南

你可以按照以下步骤安装 TODO 扫描器：

git clone https://github.com/yourusername/repo_scanner.git
cd repo_scanner
pip install -r requirements.txt

💻 使用示例

基础用法

Web 界面

启动服务器：

python app.py

访问 http://localhost:5000 在浏览器中。输入一个 git 仓库 URL，即可查看你的 TODO。

Cloudflare 快速隧道

将扫描器与世界分享，无需打开端口，也无需配置防火墙。只需运行：

./run_with_cloudflared.sh

脚本会启动应用并创建隧道，Cloudflare 会给你一个公共 URL，你的本地扫描器可供任意位置访问，是团队远程协作和演示的完美选择。需要注意的是，隧道是临时的，会在脚本结束时关闭，你的数据将保持私密。

API

该扫描器有一个简洁的 API，你可以在工作流程中使用它：

curl -X POST http://localhost:5000/api/mpco/scan_repository \
  -H "Content-Type: application/json" \
  -d '{"repo_url": "https://github.com/username/repository.git"}'

高级用法

模型上下文协议 OpenAPI

此工具实现了模型上下文协议（MCP）标准，带有一个参数化 OpenAPI 规范，AI 助手可以直接使用它。

表现清单端点：

GET /api/mpco/manifest

OpenAPI 规范：

GET /api/mpco/openapi.json

该 API 使用 OpenAPI 3.0 标准，规范是动态生成的，这意味着文档和实现始终保持同步，不会出现虚假的 API 文档。

示例输出

以下是使用该扫描器的示例输出：

{
  "repo_url": "https://github.com/username/repository.git",
  "repo_name": "repository",
  "todo_count": 42,
  "todos": [
    {
      "file_path": "src/main.py",
      "line_num": 24,
      "todo_text": "# TODO: Fix this hack when we have time",
      "next_line": "修复这个捷径当有时间时。"
    }
  ]
}

📚 详细文档

工作原理

1. 给它一个 git 仓库 URL。
2. 它会克隆仓库。
3. 扫描所有文本文件。
4. 找到类似 TODO:、# TODO 或 // TODO 的模式。
5. 向你展示它们的藏身之处。

项目待办事项

• 添加对更多 TODO 模式的支持：目前只支持 TODO:、# TODO 和 // TODO，未来计划增加其他常见模式。
• 改进性能：优化扫描算法，使其在处理大型仓库时更快更高效。
• 添加配置选项：允许用户自定义忽略文件和目录，以及设置其他偏好。
• 集成到 CI/CD 管道：提供 CLI 工具，方便将 TODO 扫描器集成到现有的持续集成/交付流程中。

📄 许可证

TODO Scanner 是开源软件，使用 MIT 许可证发布。

贡献

欢迎任何贡献！请查看 CONTRIBUTING.md 了解如何参与。