chore: Update TODO extraction script to use grep and clean up imports

- Replaced the flake8-todos based extraction with a grep-based approach in `generate_todo_md.py`.
- Updated the pre-commit hook to reflect the new script usage.
- Added TODO comments in `app.py` for future cleanup.
- Removed the old `scripts/generate_todo_md.py` file as it is no longer needed.

TODO.md

@@ -1,7 +1,6 @@
 # 📝 TODOs in Codebase
 
-- `app.py:251`: TD001 Invalid TODO tag: `FIXME`
-- `app.py:251`: TD002 Missing author in TODO; try: `# TODO(<author_name>): ...` or `# TODO @<author_name>: ...`
-- `app.py:251`: TD003 Missing issue link for this TODO
-- `app.py:254`: TD002 Missing author in TODO; try: `# TODO(<author_name>): ...` or `# TODO @<author_name>: ...`
-- `app.py:254`: TD003 Missing issue link for this TODO
+- `./app.py:251:# TODO: Clean up imports.`
+- `./app.py:254:# TODO: This should be fixed`
+
+Keep up the great work! 🚀

app.py

@@ -248,7 +248,10 @@ class ChainlitCallbackHandler(BaseCallbackHandler):
 
 import time
 
-# FIXME Clean up imports.
+# TODO: Clean up imports.
+
+
+# TODO: This should be fixed
 
 
 @cl.on_message

generate_todo_md.py

@@ -1,65 +1,45 @@
 #!/usr/bin/env python3
 """
-Script to generate TODO.md by parsing all TODO-style comments using ruff.
-Run with: uv run python generate_todo_md.py
+Script to generate TODO.md by grepping for TODO/FIXME/HACK comments in Python files.
+Run with: uvx python generate_todo_md.py
 """
 import subprocess
-import sys
 from pathlib import Path
 
 REPO_ROOT = Path(__file__).parent.resolve()
 TODO_MD_PATH = REPO_ROOT / "TODO.md"
 
 
-def run_ruff_todos():
-    """Run ruff to find TODO/FIXME comments in all .py files."""
+def run_grep_todos():
+    """Run grep to find TODO/FIXME/HACK comments in all .py files using shell=True."""
     try:
+        cmd = r'grep -rn "^\s*#\s*\(TODO\|FIXME\|HACK\)" --include="*.py"  --exclude-dir=".venv" --exclude-dir=".git"  .'
         result = subprocess.run(
-            [
-                sys.executable,
-                "-m",
-                "ruff",
-                "check",
-                "--select=TD",
-                str(REPO_ROOT),
-            ],
+            cmd,
             capture_output=True,
             text=True,
-            check=False,
+            shell=True,
+            cwd=REPO_ROOT,
         )
-        return result.stdout.strip()
+        return result.stdout.strip().splitlines()
     except Exception as e:
-        print(f"Error running ruff: {e}")
-        sys.exit(1)
-
-
-def parse_ruff_output(output):
-    """Parse ruff output into a list of TODOs."""
-    todos = []
-    for line in output.splitlines():
-        # Example: app.py:251:1: TD001 TODO: ...
-        parts = line.split(":", 3)
-        if len(parts) == 4:
-            file_path, line_no, col_no, rest = parts
-            rest = rest.strip()
-            if rest.startswith("TD"):  # e.g. TD001 TODO: ...
-                todos.append((file_path.strip(), line_no.strip(), rest))
-    return todos
+        print(f"Error running grep: {e}")
+        return []
 
 
 def write_todo_md(todos):
     with open(TODO_MD_PATH, "w", encoding="utf-8") as f:
         f.write("# 📝 TODOs in Codebase\n\n")
-        if not todos:
+        if not todos or (len(todos) == 1 and todos[0] == ""):
             f.write("No TODOs found! 🎉\n")
             return
-        for file_path, line_no, rest in todos:
-            f.write(f"- `{file_path}:{line_no}`: {rest}\n")
+        for line in todos:
+            f.write(f"- `{line}`\n")
+        f.write("\nKeep up the great work! 🚀\n")
 
 
 def main():
-    output = run_ruff_todos()
-    todos = parse_ruff_output(output)
+    todos = run_grep_todos()
     write_todo_md(todos)
     print(f"Wrote {len(todos)} TODOs to {TODO_MD_PATH}")
 

pyproject.toml

@@ -53,6 +53,8 @@ dependencies = [
     "beautifulsoup4>=4.13.4",
     "pathvalidate>=3.2.3",
     "pydantic-settings>=2.9.1",
+    "flake8-todos>=0.3.1",
+    "ruff>=0.11.0",
 ]
 authors = [{ name = "Marko Budisic", email = "mbudisic@gmail.com" }]
 license = "MIT"
@@ -88,8 +90,12 @@ web = [
 [tool.ruff]
 line-length = 79
 target-version = "py311"
+
+[tool.ruff.lint]
 select = ["E", "F", "I", "N", "W"]
+extend-select = ["TD"]
 ignore = []
+task-tags = ["TODO", "FIXME", "BUG", "HACK", "XXX"]
 
 [tool.ruff.isort]
 known-first-party = ["src"]

scripts/generate_todo_md.py

@@ -1,67 +0,0 @@
-#!/usr/bin/env python3
-"""
-Script to generate TODO.md by parsing all TODO-style comments using flake8-todos.
-Run with: uv run python scripts/generate_todo_md.py
-"""
-import subprocess
-import sys
-from pathlib import Path
-
-REPO_ROOT = Path(__file__).parent.parent.resolve()
-TODO_MD_PATH = REPO_ROOT / "TODO.md"
-
-
-def run_flake8_todos():
-    """Run flake8 with flake8-todos on all .py files in the repo."""
-    try:
-        result = subprocess.run(
-            [
-                sys.executable,
-                "-m",
-                "flake8",
-                "--select=TD",
-                str(REPO_ROOT),
-            ],
-            capture_output=True,
-            text=True,
-            check=False,
-        )
-        return result.stdout.strip()
-    except Exception as e:
-        print(f"Error running flake8-todos: {e}")
-        sys.exit(1)
-
-
-def parse_flake8_output(output):
-    """Parse flake8-todos output into a list of TODOs."""
-    todos = []
-    for line in output.splitlines():
-        # Example: scripts/generate_todo_md.py:10:1: TD003 TODO: something
-        parts = line.split(":", 3)
-        if len(parts) == 4:
-            file_path, line_no, col_no, rest = parts
-            rest = rest.strip()
-            if rest.startswith("TD"):  # e.g. TD003 TODO: ...
-                todos.append((file_path.strip(), line_no.strip(), rest))
-    return todos
-
-
-def write_todo_md(todos):
-    with open(TODO_MD_PATH, "w", encoding="utf-8") as f:
-        f.write("# 📝 TODOs in Codebase\n\n")
-        if not todos:
-            f.write("No TODOs found! 🎉\n")
-            return
-        for file_path, line_no, rest in todos:
-            f.write(f"- `{file_path}:{line_no}`: {rest}\n")
-
-
-def main():
-    output = run_flake8_todos()
-    todos = parse_flake8_output(output)
-    write_todo_md(todos)
-    print(f"Wrote {len(todos)} TODOs to {TODO_MD_PATH}")
-
-
-if __name__ == "__main__":
-    main()

scripts/pre-commit

@@ -1,8 +1,8 @@
 #!/bin/sh
-# Manual pre-commit hook: Generates TODO.md using flake8-todos and stages it.
+# Manual pre-commit hook: Generates TODO.md using grep-based script and stages it.
 # To install: cp scripts/pre-commit .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit
 
-uv run python scripts/generate_todo_md.py
+uvx python generate_todo_md.py
 if [ -f TODO.md ]; then
   git add TODO.md
 fi