https://github.com/tunnckocore/parse-git-log

Parse a `git log` output of a repository into an object with useful commit data. Supports plugins, streaming, promises and callback APIs.
https://github.com/tunnckocore/parse-git-log
Last synced: about 1 year ago
JSON representation
Parse a `git log` output of a repository into an object with useful commit data. Supports plugins, streaming, promises and callback APIs.
Host: GitHub
URL: https://github.com/tunnckocore/parse-git-log
Owner: tunnckoCore
License: mit
Created: 2015-05-08T16:35:18.000Z (about 11 years ago)
Default Branch: master
Last Pushed: 2023-01-12T05:06:36.000Z (over 3 years ago)
Last Synced: 2025-04-11T12:43:43.676Z (about 1 year ago)
Language: JavaScript
Homepage: http://j.mp/1AL1Vst
Size: 396 KB
Stars: 12
Watchers: 2
Forks: 2
Open Issues: 12
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project

README

          # parse-git-log [![NPM version](https://img.shields.io/npm/v/parse-git-log.svg?style=flat)](https://www.npmjs.com/package/parse-git-log) [![NPM downloads](https://img.shields.io/npm/dm/parse-git-log.svg?style=flat)](https://npmjs.org/package/parse-git-log) [![npm total downloads][downloads-img]][downloads-url]

> Parse a `git log` output of a repository into an object with useful commit data. Supports plugins, streaming, promises and callback APIs.

[![code climate][codeclimate-img]][codeclimate-url] 

[![standard code style][standard-img]][standard-url] 

[![linux build status][travis-img]][travis-url] 

[![windows build status][appveyor-img]][appveyor-url] 

[![coverage status][coveralls-img]][coveralls-url] 

[![dependency status][david-img]][david-url]

You might also be interested in [always-done](https://github.com/hybridables/always-done#readme).

## Table of Contents

- [Install](#install)

- [Usage](#usage)

- [API](#api)

  * [parseGitLog](#parsegitlog)

  * [.promise](#promise)

- [Related](#related)

- [Contributing](#contributing)

- [Building docs](#building-docs)

- [Running tests](#running-tests)

- [Author](#author)

- [License](#license)

_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_

## Install

Install with [npm](https://www.npmjs.com/)

```

$ npm install parse-git-log --save

```

or install using [yarn](https://yarnpkg.com)

```

$ yarn add parse-git-log

```

## Usage

> For more use-cases see the [tests](test.js)

```js

const parseGitLog = require('parse-git-log')

```

## API

### [parseGitLog](index.js#L63)

> Parses an advanced `git log` output using streams. Allows custom `plugin` function to be passed to update/modify the commit object (which is [vfile][]). It also emits `data` and `commit` events, so you may not need such `plugin` function. But in case you want to do some more parsing and interesting stuff, this `plugin` function allows you to do cool things. That `plugin` function is called with "transform stream" context and this is also passed as first argument. When you return a function from that plugin, it is called with [vfile][] object (commit object) as first argument.

**Params**

* `[cwd]` **{String}**: path to where is the `.git` folder; defaults to `process.cwd()`    

* `[plugin]` **{Function}**: smart plugin function, passed with `stream, file` signature, if returns another function, that function is passed with `file` object which represent each commit object.    

* `returns` **{Stream}**: transform stream, using [through2][] behind  

**Events**

* `emits`: `commit` passed with [vfile][] object for each commit  

* `emits`: `data` same as `commit` event; passed with [vfile][] object for each commit  

**Example**

```js

const parseGitLog = require('parse-git-log')

// optionally pass `cwd` as first argument

parseGitLog()

  .once('error', (err) => console.error('err:', err))

  .on('commit', (commit) => console.log('commit:', commit))

  .once('finish', () => console.log('done'))

```

### [.promise](index.js#L263)

> Thin Promise wrapper over the streaming API.

**Params**

* `[cwd]` **{String}**: path to where is the `.git` folder; defaults to `process.cwd()`    

* `[plugin]` **{Function}**: smart plugin function, passed with `stream, file` signature, if returns another function, that function is passed with `file` object which represent each commit object.    

* `returns` **{Promise}**: resolves array of [vfile][] commit objects, otherwise rejected promise  

**Example**

```js

const parseGitLog = require('parse-git-log')

parseGitLog.promise('../foo-bar')

  .then((commits) => {

    console.log('list of commit objects:')

    commits.forEach((commit) => console.log('commit:', commit))

  })

  .catch(console.error)

```

## Related

- [always-done](https://www.npmjs.com/package/always-done): Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… [more](https://github.com/hybridables/always-done#readme) | [homepage](https://github.com/hybridables/always-done#readme "Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement for [async-done][] - pass 100% of its tests plus more")

- [each-promise](https://www.npmjs.com/package/each-promise): Iterate over promises, promise-returning or async/await functions in series or parallel. Support settle (fail-fast), concurrency (limiting) and hooks system (start… [more](https://github.com/tunnckocore/each-promise#readme) | [homepage](https://github.com/tunnckocore/each-promise#readme "Iterate over promises, promise-returning or async/await functions in series or parallel. Support settle (fail-fast), concurrency (limiting) and hooks system (start, beforeEach, afterEach, finish)")

- [minibase](https://www.npmjs.com/package/minibase): Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… [more](https://github.com/node-minibase/minibase#readme) | [homepage](https://github.com/node-minibase/minibase#readme "Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing [base][] plugins.")

- [parse-function](https://www.npmjs.com/package/parse-function): Parse a function to an object that has its name, body, args and few more useful properties. Support regular functions… [more](https://github.com/tunnckocore/parse-function#readme) | [homepage](https://github.com/tunnckocore/parse-function#readme "Parse a function to an object that has its name, body, args and few more useful properties. Support regular functions, async/await, arrow and generator functions.")

- [parse-github-url](https://www.npmjs.com/package/parse-github-url): Parse a github URL into an object. | [homepage](https://github.com/jonschlinkert/parse-github-url "Parse a github URL into an object.")

- [parse-semver](https://www.npmjs.com/package/parse-semver): Parse, normalize and validate given semver shorthand (e.g. gulp@v3.8.10) to object. | [homepage](https://github.com/tunnckocore/parse-semver#readme "Parse, normalize and validate given semver shorthand (e.g. gulp@v3.8.10) to object.")

- [try-catch-core](https://www.npmjs.com/package/try-catch-core): Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and… [more](https://github.com/hybridables/try-catch-core#readme) | [homepage](https://github.com/hybridables/try-catch-core#readme "Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and used in higher-level libs such as [always-done][] to handle completion of anything.")

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/parse-git-log/issues/new).  

Please read the [contributing guidelines](CONTRIBUTING.md) for advice on opening issues, pull requests, and coding standards.  

If you need some help and can spent some cash, feel free to [contact me at CodeMentor.io](https://www.codementor.io/tunnckocore?utm_source=github&utm_medium=button&utm_term=tunnckocore&utm_campaign=github) too.

**In short:** If you want to contribute to that project, please follow these things

1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md](CHANGELOG.md) and [.verb.md](.verb.md) files. See ["Building docs"](#building-docs) section.

2. Ensure anything is okey by installing the dependencies and run the tests. See ["Running tests"](#running-tests) section.

3. Always use `npm run commit` to commit changes instead of `git commit`, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy.

4. Do NOT bump the version in package.json. For that we use `npm run release`, which is [standard-version][] and follows Conventional Changelog idealogy.

Thanks a lot! :)

## Building docs

Documentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run `verb` command like that

```

$ npm install verbose/verb#dev verb-generate-readme --global && verb

```

_Please don't edit the README directly. Any changes to the readme must be made in [.verb.md](.verb.md)._

## Running tests

Clone repository and run the following in that cloned directory

```

$ npm install && npm test

```

## Author

**Charlike Mike Reagent**

+ [github/tunnckoCore](https://github.com/tunnckoCore)

+ [twitter/tunnckoCore](http://twitter.com/tunnckoCore)

+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)

## License

Copyright © 2016, [Charlike Mike Reagent](http://i.am.charlike.online). Released under the [MIT license](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on December 24, 2016._  

_Project scaffolded using [charlike][] cli._

[always-done]: https://github.com/hybridables/always-done

[async-done]: https://github.com/gulpjs/async-done

[base]: https://github.com/node-base/base

[charlike]: https://github.com/tunnckocore/charlike

[commitizen]: https://github.com/commitizen/cz-cli

[dezalgo]: https://github.com/npm/dezalgo

[once]: https://github.com/isaacs/once

[standard-version]: https://github.com/conventional-changelog/standard-version

[through2]: https://github.com/rvagg/through2

[verb-generate-readme]: https://github.com/verbose/verb-generate-readme

[verb]: https://github.com/verbose/verb

[vfile]: https://github.com/wooorm/vfile

[downloads-url]: https://www.npmjs.com/package/parse-git-log

[downloads-img]: https://img.shields.io/npm/dt/parse-git-log.svg

[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/parse-git-log

[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/parse-git-log.svg

[travis-url]: https://travis-ci.org/tunnckoCore/parse-git-log

[travis-img]: https://img.shields.io/travis/tunnckoCore/parse-git-log/master.svg?label=linux

[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/parse-git-log

[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/parse-git-log/master.svg?label=windows

[coveralls-url]: https://coveralls.io/r/tunnckoCore/parse-git-log

[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/parse-git-log.svg

[david-url]: https://david-dm.org/tunnckoCore/parse-git-log

[david-img]: https://img.shields.io/david/tunnckoCore/parse-git-log.svg

[standard-url]: https://github.com/feross/standard

[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/tunnckocore/parse-git-log

Awesome Lists containing this project

README
