A simple tool that scans your git repo and generates a list of action items that you did not forget at all...
Executing it inside the git-todos
repo will generate the following file (which you can find here).
- src/main.rs#L10 @mhs: minimum on 3 characters to be parsed
Using cargo install
, installing git-todos
is super easy.
git clone {git_todos_url}
cargo install --path .
To use git-todos
just navigate to your desired git repo and execute it. A file named TODOS.md
will be created,
or modified if it already exists, and filled with a list of pending comments found in the repo.
For now the functionality is very limited. I use Regex expressions to search and match for a desired comment. Take a
look at here and here for the regex and the TodoItem
respectively.
Feel free to open PRs with the desired changes. I will try to respond to all of them.
git-todos is licensed under the MIT license. See LICENSE.txt for more details.