git-contributors

$3

A [_Node.js_][nodejs] module providing contribution stats for your git repository.

This module utilize $ git log --pretty=%an to calculate and add the amount
of percental contribution of each committer to the output.

_Note:_

Please be aware that the current checked out branch is inspected.
Currently there is no way to specify a custom branch.

[![Build Status][travis_svg]][travis_link] [![Dependency Status][dm_svg]][dm_url]

[travis_svg]: https://travis-ci.org/davidlinse/git-contributors.js.svg?branch=master
[travis_link]: https://travis-ci.org/davidlinse/git-contributors.js
[dm_svg]: https://david-dm.org/davidlinse/git-contributors.js.svg
[dm_url]: https://david-dm.org/davidlinse/git-contributors.js

#### Usage

``sh
$ npm install -g git-contributors
$ git-contributors.js --help
$ git-contributors.js [options] /path/to/repository-dir/
`

You can also require it somewhere in your node-module,

`js
// your-node-module.js
var GitContributors = require('git-contributors').GitContributors;

var opts = '/path/to/repository-dir';
// or
opts = {cwd: '/path/to/repository-dir', markdown: false};

GitContributors.list(opts, function (err, result) {
if (err) { throw err; }
console.log(JSON.stringify(result, null, 2));
});
`

.. which gives you an _sorted_ array of results:

`js
[
// sorted descending by commits (beautyfied)
{ commits: 200, name: 'Maja', email: 'maja@hive', percent: 76.9 },
{ commits: 50, name: 'Flip', email: 'flip@meadow', percent: 19.2 },
{ commits: 10, name: 'Willi', email: 'willi@sunflower', percent: 3.8 }
]
`

#### Requirements

`sh
$ node --version # 10.28+
$ git --version # 1.7+
`

#### Dependencies
* [commander][commander] (~2.3.0)
* [lodash.js][lodash] (~2.4.1)


#### Tests

`sh
$ npm test
// or
$ grunt test
// or
$ mocha -R list
``


[semver]: http://semver.org
[lodash]: http://lodash.com
[mocha]: http://mochajs.org/
[chai]: http://chaijs.com
[sinon]: http://sinonjs.org
[plato]: https://github.com/es-analysis/plato
[nodejs]: http://nodejs.org
[commander]: https://github.com/visionmedia/commander.js

#### Licence

(The MIT License)

Copyright (c) 2014 David Linse

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy,
modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
THEWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.