@marionebl/git-raw-commits

Get raw git commits out of your repository using git-log(1)

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
120Jun 27, 2016Feb 24, 2015Minified + gzip package size for @marionebl/git-raw-commits in KB

Readme

NPM version Build Status: Linux Build Status: Windows Dependency Status Coverage Status

Get raw git commits out of your repository using git-log(1)

Install

$ npm install --save git-raw-commits

Usage

var gitRawCommits = require('git-raw-commits');

gitRawCommits(options)
  .pipe(...);

API

gitRawCommits([options])

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 <revision range> we can also use <from>..<to> 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.

CLI

$ npm install --global git-raw-commits
$ git-raw-commits --help # for more details

License

MIT © Steve Mao

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.