Skip to content

Statistical summary of various infomation about git committer.

License

Notifications You must be signed in to change notification settings

snowyu/git-commiters.js

Repository files navigation

git-commiters npm

Build Status Code Climate Test Coverage downloads license

A Node.js function module providing committers stats for your git repository.

Statistical summary of various infomation about git committer.

  • list of the committers
  • count of the committers
  • count of commits via committers
  • count of insertions via committers
  • count of deletions via committers

Usage

var gitCommiters = require('git-commiters');

gitCommiters('.', function(err, result){
  if (err)
    console.log(err);
  else
    console.log(result);
});

API

gitCommiters = require('git-commiters')
  • gitCommiters(options, callback): asynchronous get the stats infomation of the git committers
    • options (String|Object): the git's working directory if it's string.
      • cwd (String): the git's working directory.
      • gitDir (String): the git directory(.git).
      • revisionRange (String): Show only commits in the specified revision range. It defaults to HEAD. You can specify a branch too. More details to see gitrevisions
      • path (String): list commiters only for the specified path(file). defaults to all.

License

MIT

About

Statistical summary of various infomation about git committer.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published