Legit

Installation

$ gem install legit

Usage

Run legit with no options to see a list of commands and options.

Setting Up a catch-todos pre-commit Hook

1. Add the following to .git/hooks/pre-commit in the desired repository:

#! /bin/bash
legit catch-todos TODO

2. Make the hook executable (git will silently ignore your hook otherwise):

chmod +x .git/hooks/pre-commit

Enable or disable catch-todos with the --enable and --disable options

legit catch-todos --disable     # will not check todos until re-enabled
legit catch-todos --enable      # sets it back to normal

Note: if you use a graphical git tool (such as SourceTree for OS X), you may need read the following:

RVM and similar tools do store executables in custom locations instead of the standard locations for executables such as /usr/bin. Since your .bash_profile (or similar) might not be executed by your GUI tool, you may need to create a symlink to legit in a location that is in the tool's default path. /usr/bin is usually included, so this should do:

sudo ln -s $(which legit) /usr/bin/legit      # find where RVM is storing legit and add a symlink to it in /usr/bin

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request