Github TODO Scanner

🚀 TODO Scanner

A super simple tool to discover tasks that need to be completed. You have code, and there are TODOs in your code. This tool will help you find them.

🚀 Quick Start

📦 Installation

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

💻 Usage Examples

🌐 Web Interface

Start the server:

python app.py

Visit http://localhost:5000 in your browser. Enter a git repository URL and view your TODOs.

🌩️ Cloudflare Quick Tunnel

Share the scanner with the world. No need to open ports. No need to configure firewalls. Just run:

./run_with_cloudflared.sh

The script starts the application, creates a tunnel, and Cloudflare gives you a public URL. Your local scanner is accessible anywhere. It's a perfect solution for remote team collaboration and demonstrations.

The tunnel is temporary. It will terminate when the script ends. Your data remains private.

📡 API

The scanner has a clean API. Use it in your workflow.

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

✨ Features

The sun rises, and the code awaits. TODOs are hidden in your repository. This scanner finds them with brutal efficiency.

It scans git repositories. It looks for common TODO patterns in comments. It reports them to you in a clean interface. No fuss. No complexity.

❓ Why It Matters

We all write notes to ourselves. "Fix this later." "This is a shortcut." "Come back to this." But we forget. The code grows. TODOs multiply. They become invisible.

This tool makes these invisible TODOs visible again.

🔧 Technical Details

1. Provide it with a git repository URL.
2. It clones the repository.
3. It scans all text files.
4. It finds patterns like TODO:, # TODO, or // TODO.
5. It shows you where they are hiding.

📚 Documentation

📜 Model Context Protocol OpenAPI

This tool implements the Model Context Protocol (MCP) standard with a parameterized OpenAPI specification. AI assistants can use it directly. The API is clean, and the documentation is always up-to-date.

Manifest endpoint:

GET /api/mpco/manifest

OpenAPI specification:

GET /api/mpco/openapi.json

The API uses the OpenAPI 3.0 standard. The specification is dynamically generated. This means the documentation and implementation are always in sync. No more false API documentation.

📄 Example Output

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

📄 License

TODO Scanner is open-source software released under the MIT License.

🤝 Contribution

Any contributions are welcome! Please check CONTRIBUTING.md to learn how to contribute.

📋 Project TODOs

• Add support for more TODO patterns: Currently, it only supports TODO:, # TODO, and // TODO. Plans are in place to add other common patterns in the future.
• Improve performance: Optimize the scanning algorithm to make it faster and more efficient when handling large repositories.
• Add configuration options: Allow users to customize ignored files and directories and set other preferences.
• Integrate into CI/CD pipelines: Provide a CLI tool to easily integrate the TODO scanner into existing continuous integration/delivery processes.