cclog-parser's Introduction

cclog-parser

conventional-changelog log parser

parse changelog file format same as https://github.com/karma-runner/karma/blob/master/CHANGELOG.md

Install

npm install cclog-parser

Useage

INPUT

<a name="0.1.0"></a>
# some thing 


### Bug Fixes

* fixa ([17c2c43](https://abc/commit/abc))
* fixb ([17c2c43](https://abc/commit/abc))


### Features

* feata ([17c2c43](https://abc/commit/abc))
* featb ([17c2c43](https://abc/commit/abc))


<a name="0.0.1"></a>
# some thing 

### Bug Fixes

* fixc ([17c2c43](https://abc/commit/abc))
* fixd ([17c2c43](https://abc/commit/abc))


### Features

* featc ([17c2c43](https://abc/commit/abc))
* featd ([17c2c43](https://abc/commit/abc))

CODE

const parser = require('cclog-parser')
const result = parser(changelog)

OPTIONS

includeDetails: true

toggle commit message detail include

OUTPUT

{
  "versions": [
    "0.1.0",
    "0.0.1"
  ],
  "changes": {
    "0.1.0": {
      "fixes": [
        "fixa ([17c2c43](https://abc/commit/abc))",
        "fixb ([17c2c43](https://abc/commit/abc))"
      ],
      "features": [
        "feata ([17c2c43](https://abc/commit/abc))",
        "featb ([17c2c43](https://abc/commit/abc))"
      ]
    },
    "0.0.1": {
      "fixes": [
        "fixc ([17c2c43](https://abc/commit/abc))",
        "fixd ([17c2c43](https://abc/commit/abc))"
      ],
      "features": [
        "featc ([17c2c43](https://abc/commit/abc))",
        "featd ([17c2c43](https://abc/commit/abc))undefined"
      ]
    }
  }
}