1.0.0 • Published 6 years ago

promised-conventional-commits-parser v1.0.0

Weekly downloads
62
License
MIT
Repository
-
Last release
6 years ago

promised-conventional-commits-parser

This is a promise wrapper around parts of the conventional changelog project. It will give you the json representation given by conventional-commits-parser based on the commits read from git-raw-commits.

All the heavy lifting here is done by the cool project conventional-changelog, you should check it out.

Install

npm install promised-convention-commits-parser

Usage

const parser = require('promised-conventional-commits-parser');

const gitRawOptions = {} // see git-raw-commits documentation
const parserOptions = {} // see conventional-commits-parser documentation

parser(gitRawOptions, parserOptions)
  .then(commits => {
    console.log(commits)
  })