Skip to content

Latest commit

 

History

History
185 lines (136 loc) · 10.6 KB

README.md

File metadata and controls

185 lines (136 loc) · 10.6 KB
Raw

parse-git-log NPM version NPM downloads npm total downloads

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

code climate standard code style linux build status windows build status coverage status dependency status

You might also be interested in always-done.

Table of Contents

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install parse-git-log --save

or install using yarn

$ yarn add parse-git-log

Usage

For more use-cases see the tests

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

API

parseGitLog

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

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

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

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: Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… more | homepage
  • 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 | homepage
  • minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | homepage
  • parse-function: Parse a function to an object that has its name, body, args and few more useful properties. Support regular functions… more | homepage
  • parse-github-url: Parse a github URL into an object. | homepage
  • parse-semver: Parse, normalize and validate given semver shorthand (e.g. [email protected]) to object. | homepage
  • 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 | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guidelines 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 too.

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

  1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
  2. Ensure anything is okey by installing the dependencies and run the tests. See "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.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

Charlike Mike Reagent

License

Copyright © 2016, Charlike Mike Reagent. Released under the MIT license.

This file was generated by verb-generate-readme, v0.2.0, on December 24, 2016.
Project scaffolded using charlike cli.