Todo.txt Autoscan Utility
Example session
Let's say you have some sort of code / text project you are working on, which supports some kind of comments:
Deathstar/doc/usermanual.tex
Deathstar/doc/usermanual.pdf
Deathstar/laser_controller.c
Deathstar/gravitionaltravel_handler.c
Deathstar/...
Now, in all these files you maybe are writing stuff like
// TODO: Make sure laser cannon does not overheat.
After working for a couple of decades on this project, you probably have a few dozen of these comments laying around (at least I do).
This little utility will find all these comments and compile them into a neat todo.txt-compliant todo.txt file.
For example:
(A) +Deathstar @code-c @laser_controller Make sure laser canon does not overheat. (laser_controller.c)
It also has the capability of just modifying any existing todo.txt file. (Note: Since this program is under development and very untested, it might just ruin your entire todo.txt-file. Use with care!)
(A) Research X-wing fighters
+Groceries Buy milk
(A) +Deathstar @code-c @laser_controller Make sure laser canon does not overheat. (laser_controller.c)
Installation
If you have any experience with ruby scripts, you should have no problem figuring out how to run and install this.
Quick n' dirt
- Make sure you have a ruby runtime environment installed.
- Put
todoscan.rb
in your project directory - Execute
todoscan.rb
with your ruby installation.
A file called todo.cfg.yml
and one called todo.txt
should have been created. Open up todo.cfg.yml
to configure the behaviour.
As a git hook
TO-DO: Find out how git-hooks works and write down how to set it up with todoscan
As a subversion hook
TO-DO: Find out how svn-hooks works and write down how to set it up with todoscan
As a sublime-text plugin
TO-DO: Find out how sublime text plugins works and write down how to set it up with todoscan