git-trail
v0.1.0
Published
Provides a readable stream alternative to `git-log`, so you can access your git history through Node.
Downloads
3
Readme
git-trail
Provides a readable stream alternative to git-log
, so you can access your git
history through Node.
Installation
npm install git-trail
Usage
trail(directory, [options])
.
var trail = require('git-trail')
, project = __dirname + '/../synthesis'
trail(project, { until: new Date }).on('data', function(commit) {
commit.sha // "bfceb052d8d08db882e75aa0444fe9c51eda76e2"
commit.body // "update URLs for new repo name"
commit.author.email // "[email protected]"
commit.author.name // "Hugh Kennedy"
commit.author.date // Wed Dec 12 20:55:49 2012 +1100
commit.committer.email // "[email protected]"
commit.committer.name // "Hugh Kennedy"
commit.committer.date // Wed Dec 12 20:55:49 2012 +1100
})
Options include:
since
: The starting date to stream logs fromuntil
: The last date to stream logs from
All are optional. Enjoy!