# 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][].

Latest version **1.0.0** (published 2017-11-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install promised-conventional-commits-parser
pnpm add promised-conventional-commits-parser
yarn add promised-conventional-commits-parser
bun add promised-conventional-commits-parser
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-11-14 |
| First published | 2017-11-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Rolf Erik Lekang |
| Maintainers | relekang |

## Links

- npm: https://www.npmjs.com/package/promised-conventional-commits-parser
- npm.io page: https://npm.io/package/promised-conventional-commits-parser

## Dependencies (3)

- [through2](https://npm.io/package/through2.md) ^2.0.3
- [git-raw-commits](https://npm.io/package/git-raw-commits.md) ^1.3.0
- [conventional-commits-parser](https://npm.io/package/conventional-commits-parser.md) ^2.0.1

## Recent versions

- 1.0.0 (latest) — 2017-11-14

## README

# 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

```javascript
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)
  })

```

[conventional-changelog]: https://github.com/conventional-changelog/conventional-changelog
[conventional-commits-parser]: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser
[git-raw-commits]: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-raw-commits

---
_Source: https://npm.io/package/promised-conventional-commits-parser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._