All Projects → juliangruber → git-log

juliangruber / git-log

Licence: other
Git log stream using jsgit

Programming Languages

javascript
184084 projects - #8 most used programming language
Makefile
30231 projects

git-log

Git log stream using jsgit.

Example

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

log(__dirname + '/.git').on('data', console.log);
$ node example.js
{ message: 'initial commit\n',
  hash: '9407e380dfff07d86fa1b1c36ec704b2bdd96e9c',
  tree: [ 'c08f6e872c2a0b58afcb0f0ee68e7807875905d4' ],
  date: Wed Sep 04 2013 09:51:17 GMT+0200 (CEST),
  author: { name: 'Julian Gruber', email: '[email protected]' },
  committer: [ { name: 'Julian Gruber', email: '[email protected]' } ] }

API

var stream = log(path)

Create a readable stream that emits commits for the git repository in path, starting from the newest one.

stream.on('data', fn)

For every commit, call fn with an object with keys message, hash, tree, date, author, committer.

Installation

With npm do:

npm install git-log

License

(MIT)

Copyright (c) 2013 Julian Gruber <[email protected]>

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 THE WARRANTIES 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.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].