`todo-md` is a small pre-commit hook implemented in Bash that maintains `TODO.md` file in your repo

https://codeberg.org/lig/todo-md

Hey! I've just released todo-md v1 🚀. Keep your tasks organized with todo-md!

The pre-commit hook automatically maintains a TODO.md file by scanning your staged files for TODO: comments. You do not need complicated task trackers bloated with features anymore:) Let your code speak for itself!

Get it now: https://codeberg.org/lig/todo-md

#TODOmd #DevTools #PreCommit #Automation #OpenSource #Git #Todo​

57 points · 13 comments · view on lemmy.world

13 Comments

jonne@infosec.pub · 16 pts · 1y (2 replies)

But when I put @todo in my code, the point is to never revisit it. I don't want to be reminded every time I open the repo!

lig@lemmings.world · 5 pts · 1y (1 reply)

This one isn't for you then :)

jonne@infosec.pub · 6 pts · 1y

Haha, nice work on it tho.

OsrsNeedsF2P@lemmy.ml · 6 pts · 1y

That's actually pretty neat

nomen_dubium@startrek.website · 5 pts · 1y (1 reply)

excellent! i can now remove my eternal TODO to write this myself :D

lig@lemmings.world · 3 pts · 1y

You're welcome:)

Kissaki@programming.dev · 5 pts · 1y (4 replies)

Maybe you want to scan for FIXME: too?

lig@lemmings.world · 2 pts · 1y (3 replies)

That could be an option. Care to fill an issue?:)

Kissaki@programming.dev · 3 pts · 1y (2 replies)

https://codeberg.org/lig/todo-md/issues/4

I didn't create one because I won't be using the project, but suggested it here for your consideration. :)

Outside of work-in-progress or exploration branches, I don't commit or merge TODOs. Typically, I consider them merge/land blockers. Because most of the time, they're never resolved. And in that case, I much prefer documentation and statements; reasoning of why it is the way it is, or opportunities.

nik9000@programming.dev · 2 pts · 1y

In projects I work on we use NOCOMMIT for these blockers and they'll fail the build. It's honestly lovely to have something to leave yourself a note that the build catches for you.

pupbiru@aussie.zone · 1 pts · 1y

a TODO can often be expressed in a throw NotImplementedError or similar, but a comment is where danger lies

Kalcifer@sh.itjust.works · 3 pts · 1y

Neat!

emaro@nerdculture.de · 1 pts · 1y

@lig that looks neat!