Get raw git commits out of your repository using git-log(1)
npm install @marionebl/git-raw-commits> Get raw git commits out of your repository using git-log(1)
``sh`
$ npm install --save git-raw-commits
`js
var gitRawCommits = require('git-raw-commits');
gitRawCommits(options)
.pipe(...);
`
Returns a readable stream. Stream is split to break on each commit.
#### options
Type: object
Please check the available options at http://git-scm.com/docs/git-log.
NOTE: Single dash arguments are not supported because of https://github.com/sindresorhus/dargs/blob/master/index.js#L5.
NOTE: for we can also use pattern, and this module has the following extra options for shortcut of this patter:
##### from
Type: string Default: ''
##### to
Type: string Default: 'HEAD'
This module also have the following additions:
##### format
Type: string Default: '%B'
Please check http://git-scm.com/docs/git-log for format options.
##### debug
Type: function
A function to get debug information.
##### path
Type: string
Filter commits to the path provided.
`sh``
$ npm install --global git-raw-commits
$ git-raw-commits --help # for more details
MIT © Steve Mao
[npm-image]: https://badge.fury.io/js/git-raw-commits.svg
[npm-url]: https://npmjs.org/package/git-raw-commits
[travis-image]: https://travis-ci.org/conventional-changelog/git-raw-commits.svg?branch=master
[travis-url]: https://travis-ci.org/conventional-changelog/git-raw-commits
[appveyor-image]: https://ci.appveyor.com/api/projects/status/4qm3bjmg41k3dsbv/branch/master?svg=true
[appveyor-url]: https://ci.appveyor.com/project/stevemao/git-raw-commits/branch/master
[daviddm-image]: https://david-dm.org/conventional-changelog/git-raw-commits.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/conventional-changelog/git-raw-commits
[coveralls-image]: https://coveralls.io/repos/conventional-changelog/git-raw-commits/badge.svg
[coveralls-url]: https://coveralls.io/r/conventional-changelog/git-raw-commits