Hacker News Reader

Comment by Ruud-v-A | Hacker News Reader

Or you could just run `git grep --line-number TODO`.

this will give you any line that has `TODO` in them, whether that was a TODO comment or just an occurrence of that word. An example:

README.md:149: * Must have one of the words: NOTE, OPTIMIZE, TODO, HACK, XXX, FIXME, or BUG

which brought this from the readme file but it was not a "real" to do.

you can then start thinking of passing regex to the grep, and trying to catch all the other annotations like FIXME, NOTE, etc. and then again you need a way to start ignoring certain files, maybe you do not want to check all the files in your node_modules, etc.

All in all, this module is just a little helper that tries to solve all these little issues.

Thanks for the pointer :)

Wouldn't 'git grep --line-number ^TODO' fix that (only match TODO at the start of a line)? Maybe with some whitespace matching if you indent your TODOs?

I don't put my TODO's at the start of lines? Usually only in single-line comments after some code.

I think a script with a few grep invocations for all code files with lines containing TODO/FIXME etc. is about right, takes minutes to set up and will work for all but the most obscure cases.

It'll easily deal with your README.md case.

I'm not convinced that "^\s(//|#|--)\s(TODO|FIXME|XXX)\s*:" (i.e. a fairly simple regex) isn't a plausible way to do what's required of this. All the colors and everything are nice, but a simple bash script sounds eminently doable.

You can easily get the colors and fancy UTF chars with an xargs | printf so a Bash/sh script should do fine.

Ack is also great for stuff like this, and easy to run as a hook or NPM thing https://beyondgrep.com

Reply on news.ycombinator.com