contributors-from-git

Get an array of contributors from a git working tree

Usage no npm install needed!

<script type="module">
  import contributorsFromGit from 'https://cdn.skypack.dev/contributors-from-git';
</script>

README

contributors-from-git

Get an array of contributors from a git working tree.
Requires git 1.7+. Forked from git-contributors to reduce its scope (no output formatters, command-line interface, sorting or filtering).

npm Node version Build Status JavaScript Style Guide

Usage

npm install contributors-from-git

var contributors = require('contributors-from-git')

contributors('.', function (err, result) {
  if (err) throw err
  console.log(result)
})

This yields an array of contributors:

[
  { commits: 40, name: 'Maja',  email: 'maja@hive' },
  { commits: 10, name: 'Flip',  email: 'flip@meadow' },
  { commits: 80, name: 'Willi', email: 'willi@sunflower' }
]

API

contributors(dir, callback)

The dir argument must resolve to a git working tree.

License

MIT © 2019 Vincent Weevers, © 2014 David Linse.