TODO Reminder CLI: Never Miss a Code Comment Deadline Again

leo108 — Tue, 18 Feb 2025 13:17:14 +0000

🚀 Introducing TODO Reminder - Your new codebase watchdog!

Are you tired of forgotten TODOs quietly lurking in your code? This handy CLI tool helps you:

✅ Tracks due dates in TODO comments
✅ Identifies improperly formatted TODOs
✅ Supports 12+ popular languages (Rust, JS, Python, etc)
✅ Generates clickable links in table reports
✅ Provides JSON output for easier automation (think Slack or PR integrations)

Quick Example Output

Clickable Table Report

╭──────┬─────────┬────────────┬───────┬──────────────────────────────────────────────────────────────────────────╮
│ Line ┆ Type    ┆ Due Date   ┆ Owner ┆ src/demo.rs                                                              │
╞══════╪═════════╪════════════╪═══════╪══════════════════════════════════════════════════════════════════════════╡
│ 1    ┆ Overdue ┆ 2023-12-31 ┆ alice ┆ // TODO: 2023-12-31 @alice Refactor this function to improve performance │
├╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ 2    ┆ Format  ┆            ┆       ┆ // TODO not a valid format                                               │
╰──────┴─────────┴────────────┴───────┴──────────────────────────────────────────────────────────────────────────╯

Integration Friendly JSON Output

[
  {
    "comment": "// TODO: 2023-12-31 @alice Refactor this function to improve performance",
    "due_date": "2023-12-31",
    "file": "src/demo.rs",
    "line": 1,
    "owner": "alice",
    "type": "Overdue"
  },
  {
    "comment": "// TODO not a valid format",
    "file": "src/demo.rs",
    "line": 2,
    "type": "InvalidFormat"
  }
]

Try It in 1 Minute

Create a minimal config.toml:

[parameters]
editor_url = "vscode://file/%%file%%:%%line%%"  # Clickable links for VSCode

[[rules]]
# Directory to scan, relative to the configuration file
path = "src"
language = "rust"

Run with Docker:

docker run -v $(pwd):/workdir leo108/todo-reminder config.toml

Why I Built This

I love leaving TODO notes in the code (especially when I’m short on time), but it’s easy to forget them. With TODO Reminder, you can quickly run a scan before releases or during CI checks to ensure no important tasks slip through. It’s also great for teams, because each TODO is assigned an owner and a due date, and the tool makes it visible when tasks are overdue.

GitHub: ⭐leo108/todo-reminder