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 瞭解如何參與。