๐ 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
Iโd love to hear your thoughts! What features would make this tool indispensable for your workflow?
Top comments (0)