Github TODO Scanner

🚀 TODO スキャナ

このツールは、完了する必要のあるタスクを発見するための非常にシンプルなツールです。あなたにはコードがあり、そのコードの中にはTODOがあります。このツールがそれらを見つける手助けをします。

✨ 主な機能

太陽が昇り、コードが待っています。TODOはあなたのリポジトリの中に隠れています。このスキャナは、brutalな効率でそれらを見つけ出します。

• gitリポジトリをスキャンします。
• コメント内の一般的なTODOパターンを探します。
• それらをきれいなインターフェースであなたに報告します。面倒なことは一切ありません。複雑さもありません。

📚 詳細説明

私たちは皆、自分自身にメモを残します。「後でこれを修正する」「これは近道だ」「後でここを見直す」など。しかし、私たちはそれを忘れてしまいます。コードが増え、TODOが増殖し、見えなくなってしまいます。

このツールは、これらの見えなくなったTODOを再び見えるようにします。

🔧 技術詳細

1. gitリポジトリのURLを与えます。
2. リポジトリをクローンします。
3. すべてのテキストファイルをスキャンします。
4. TODO:、# TODO、// TODO のようなパターンを見つけます。
5. それらの隠れ場所をあなたに表示します。

📦 インストール

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アシスタントは直接使用できます。APIはクリーンで、ドキュメントは常に最新です。

表現マニフェストエンドポイント：

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": "修复这个捷径当有时间时。"
    }
  ]
}

📄 ライセンス

TODO Scannerはオープンソースソフトウェアで、MITライセンスで公開されています。

🔗 貢献

どんな貢献も歓迎です！ CONTRIBUTING.md を参照して、どのように貢献できるかを確認してください。

📋 プロジェクトのTODO

• より多くのTODOパターンのサポートを追加する：現在は TODO:、# TODO、// TODO のみをサポートしていますが、将来的には他の一般的なパターンも追加する予定です。
• パフォーマンスを改善する：スキャンアルゴリズムを最適化し、大規模なリポジトリを処理する際により高速かつ効率的に動作するようにします。
• 設定オプションを追加する：ユーザーが無視するファイルやディレクトリをカスタマイズできるようにし、その他の設定を行えるようにします。
• CI/CDパイプラインに統合する：CLIツールを提供し、TODOスキャナを既存の継続的インテグレーション/デリバリーフローに簡単に統合できるようにします。