git-pending

git-pending

Git plugin to list todo, fixme, testme and docme comments with verbose details

Installation

Run the command below to install the plugin

npm install -g git-pending

Usage

Open any git repository and run below command

git pending

This will list all the pending TODO, FIXME, TESTME and DOCME comments

Options

Here is the list of options that you can pass to modify the output of git pending

git pending [--oneline|-o ]
            [--type|-t <fixme|testme|docme|todo>]
            [--author|-a <author>]
            [--no-stats]

Examples

Here is the list of sample usage examples

Comments by Single Author

If you don't pass --author flag, it will show you the comments from everyone

git pending --author kamran --oneline

Comments with Commit Details

Not passing --oneline flag will give you the detailed output with commit that introduced the comment

git pending --author kamran

Comments of Specific Type

Use --type flag to specify the type of comments you need. Possible values (TODO, FIXME, TESTME, DOCME)

git pending --type TODO
git pending --type TESTME
git pending --type FIXME
git pending --type DOCME

More Examples

# List all the TODO, FIXME, DOCME or TESTME comments
git pending

# List comments without stats
git pending --no-stats

# Lists the comments with only date
git pending --oneline

# Lists only the fixme comments
git pending --type fixme

# Lists the comments from specific author
git pending --author kamran

# Lists the specific type of comments from specific author
git pending --type fixme --author kamran 

# Provide options in short form
git pending -t fixme -a kamran -o

License

MIT © Kamran Ahmed