parse-changelog v1.0.2

parse-changelog

Pure-Javascript ChangeLog parser to extract changes for each versions. Currently only supporting ChangeLogs writen using Markdown.

Usage

Install the node module using:

$ npm i parse-changelog

And parse your changelog using:

var fs = require('fs');
var parseChangelog = require('parse-changelog');

var CHANGES = fs.readFileSync('CHANGES.md', { encoding: 'utf-8' });

var changelog = parseChangelog(CHANGES, {
    // ChangeLog contains a main title
    title: true,

    // Extract text as html instead of markdown
    textAsHTML: false
});

> {
    title: "Release notes",
    intro: "All notable changes to this project will be documented in this file.",
    versions: [
        {
            tag: "1.0.0",
            rawNote: "* Fix bug with parser\n* Fix bug at login",
            notes: [
                "Fix bug with parser",
                "Fix bug at login"
            ]
        }
    ]
}