git-heroes

Git Heroes

Get stats on git contributors between two git (release) tags or any other revision range in JSON or MarkDown format.

A great insight and way to thank your community.

Example

Get the contributors between the last 5.0.2 release and the current 5.1.x version of Appcelerator Titanium.

$ git-heroes -c 5_1_X -p 5_0_2_GA -n
| name (16)        | email                           | commits (255) | added (176061) | deleted (347769) | sum (523830) | diff (171708) |
| ---------------- | ------------------------------- | ------------- | -------------- | ---------------- | ------------ | ------------- |
| Chris Barber     | [e-mail]                | 43            | 146762         | 255795           | 402557       | 109033        |
| sgtcoolguy       | [e-mail]      | 11            | 8588           | 88800            | 97388        | 80212         |
| Pedro Enrique    | [e-mail]             | 13            | 6122           | 207              | 6329         | 5915          |
| Feon Sua         | [e-mail] | 13            | 5418           | 30               | 5448         | 5388          |
| Hans Knoechel    | [e-mail]  | 75            | 3026           | 1449             | 4475         | 1577          |
| Hieu Pham        | [e-mail]          | 13            | 2285           | 447              | 2732         | 1838          |
| Ben Hatfield     | [e-mail]      | 11            | 1340           | 441              | 1781         | 899           |
| Ben Bahrenburg   | [e-mail]        | 13            | 994            | 195              | 1189         | 799           |
| Ashraf           | [e-mail]         | 13            | 905            | 114              | 1019         | 791           |
| cheekiatng       | [e-mail]            | 26            | 351            | 193              | 544          | 158           |
| AngelkPetkov     | [e-mail]        | 13            | 226            | 62               | 288          | 164           |
| Manoj Kumar      | [e-mail]        | 2             | 22             | 20               | 42           | 2             |
| Fokke Zandbergen | [e-mail]                 | 5             | 10             | 8                | 18           | 2             |
| Manuel Lehner    | [e-mail]         | 2             | 9              | 5                | 14           | 4             |
| Kota Iguchi      | [e-mail]         | 1             | 2              | 2                | 4            | 0             |
| Praveen Innamuri | [e-mail]      | 1             | 1              | 1                | 2            | 0             |

Install

As global CLI:

[sudo] npm install -g git-heroes

As a dependency:

npm install --save git-heroes

Usage

Run git-heroes -h for usage:

$ git-heroes -h

  Usage: git-heroes [options] [path]

  Options:

    -h, --help                 output usage information
    -V, --version              output the version number
    -p, --previous <revision>  Include commits after a certain revision
    -c, --current <revision>   Include commits for a certain revision
    -s, --sort <by>            Sort by name, email, commits, added, deleted, sum or diff [sum]
    -a, --asc                  Sort ascending instead of default descending
    -o, --output <type>        Output type [md]
    -n, --names                Use both email and name to identify contributors
    -t, --titles               Show commit titles

The [path] will default to the current working directory.

The --previous and --current options are used as revision range for git log as such:

git log --numstat --no-merges --pretty="<COMMIT>%aN<FIELD>%aE<FIELD>%s<FIELD>" <previous>..<current>

You can leave out --current (which will also remove ..) and only use --previous to set any range you'd like.

Module API

The CLI uses the module API which you can also use directly as:

var heroes = require('git-heroes');

heroes(opts, callback);

Issues

Please report issues and features requests in the repo's issue tracker.

License

Distributed under MIT License.