Hey, do you like TODO
s? Yeah, we all probably like them a little too much...
Why write actual code when you could just leave a TODO
?
Well, fear no more about losing track of those desired code changes. This tool
is a git post-commit hook that warns you about TODO
s that you left in your
code.
Here's a list of TODOs you added in this commit:
------------------------------------------------
+ todo_tools.py | # TODO(@zeb[2016-08-04]): pls check if werks
+ todo_tools.py | # TODO(@zeb[2015-08-04]): This should fail
+ todo_tools.py | # TODO: copy instance of running file to given directory
+ todo_tools.py | # TODO: consolidate saving
+ todo_tools.py | if potential_todos: # TODO: test
+ todo_tools.py | print('') # print newline for prettiness # TODO: ask user
These might be TODOs. Did you mean to do them?
-----------------------------------------------
+ README.md | # TODO Tools (y/N)
We have three different ways to install this.
Note, you do not have to do this to use the full installation. The manual
installation method works without cluttering your $PATH
. If you don't care
about that, by all means make your life easier and use pip
or setuptools
.
[Coming Soon]
β¬β[william@fillory:~/todo-tools]
β°β>$ pip install todo_tools --user
Clone this repository using git clone
, and then run ./bin/todo -i <desired installation repository root>
to install it as a post-commit hook. For example:
β¬β[william@fillory:~/todo-tools]
β°β>$ git clone https://github.com/willzfarmer/todo-tools
β¬β[william@fillory:~/todo-tools]
β°β>$ cd todo-tools
β¬β[william@fillory:~/todo-tools]
β°β>$ ./bin/todo -i ~/myawesomerepo
And it's enabled on that repository! Woo!
β¬β[william@fillory:~/todo-tools]
β°β>$ python setup.py install --user
β¬β[william@fillory:~/todo-tools]
β°β>$ todo --install-to-bashrc