@release-notes/changelog-parser
v0.1.2
Published
Parse CHANGELOG.md, HISTORY.md and derivative markdown files into js objects.
Downloads
1,061
Maintainers
a-zReadme
Release Notes Changelog Parser
About
The changelog parser reads CHANGELOG.md files and derivatives and converts them to release notes objects with a standardized schema. This allows further processing of changelog files and provides an unified access to information on version and even atomic modification level.
Installation
$ yarn add @release-notes/changelog-parser
$ npm i --save @release-notes/changelog-parserUsage
const changelogParser = require('@release-notes/changelog-parser');
const fs = require('fs');
const changelog = fs.readFileSync('./CHANGELOG.md');
const releaseNotes = changelogParser.parse(changelog);
const json = releaseNotes.toJSON();The changelog parser returns an instance of ReleaseNotes.
LICENSE
The files in this archive are released under MIT license. You can find a copy of this license in LICENSE.