DEV Community

leo108
leo108

Posted on

TODO Reminder CLI: Never Miss a Code Comment Deadline Again

๐Ÿš€ 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                                               โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
Enter fullscreen mode Exit fullscreen mode

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"
  }
]
Enter fullscreen mode Exit fullscreen mode

Try It in 1 Minute

  1. 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"
Enter fullscreen mode Exit fullscreen mode
  1. Run with Docker:
docker run -v $(pwd):/workdir leo108/todo-reminder config.toml
Enter fullscreen mode Exit fullscreen mode

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

Iโ€™d love to hear your thoughts! What features would make this tool indispensable for your workflow?

AWS GenAI LIVE image

How is generative AI increasing efficiency?

Join AWS GenAI LIVE! to find out how gen AI is reshaping productivity, streamlining processes, and driving innovation.

Learn more

Top comments (0)

Billboard image

The Next Generation Developer Platform

Coherence is the first Platform-as-a-Service you can control. Unlike "black-box" platforms that are opinionated about the infra you can deploy, Coherence is powered by CNC, the open-source IaC framework, which offers limitless customization.

Learn more