git-raw-commits
Get raw git commits out of your repository using git-log(1)
Last updated 5 years ago by bcoe .
MIT · Repository · Bugs · Original npm
$ cnpm install git-raw-commits 
SYNC missed versions from official npm registry.

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(gitOpts, [execOpts])

Returns a readable stream. Stream is split to break on each commit.

gitOpts

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 pattern:

gitOpts.from

Type: string Default: ''

gitOpts.to

Type: string Default: 'HEAD'

This module also have the following additions:

gitOpts.format

Type: string Default: '%B'

Please check http://git-scm.com/docs/git-log for format options.

gitOpts.debug

Type: function

A function to get debug information.

gitOpts.path

Type: string

Filter commits to the path provided.

execOpts

Options to pass to git childProcess

Type: object

execOpts.cwd

Type: string

Current working directory to execute git in

CLI

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

License

MIT © Steve Mao

Current Tags

  • 2.0.11                                ...           latest (4 years ago)
  • 2.0.8                                ...           next (5 years ago)

7 Versions

  • 2.0.11                                ...           4 years ago
  • 2.0.10                                ...           5 years ago
  • 2.0.8                                ...           5 years ago
  • 2.0.9                                ...           5 years ago
  • 2.0.7                                ...           5 years ago
  • 1.3.6                                ...           7 years ago
  • 2.0.0                                ...           7 years ago
Maintainers (2)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (5)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2013 - present © cnpmjs.org