# @release-notes/changelog-parser

> Parse CHANGELOG.md, HISTORY.md and derivative markdown files into js objects.

Latest version **0.1.2** (published 2017-12-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @release-notes/changelog-parser
pnpm add @release-notes/changelog-parser
yarn add @release-notes/changelog-parser
bun add @release-notes/changelog-parser
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2017-12-19 |
| First published | 2017-12-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Alrik Zachert |
| Maintainers | a-z |
| Keywords | release notes, release-notes, releasenotes, changelog, changelog.md, history.md, parser |

## Links

- npm: https://www.npmjs.com/package/@release-notes/changelog-parser
- Repository: https://github.com/release-notes/changelog-parser
- Homepage: https://release-notes.com
- Issues: https://github.com/release-notes/changelog-parser/issues
- npm.io page: https://npm.io/package/@release-notes/changelog-parser

## Dependencies (1)

- [@release-notes/node](https://npm.io/package/@release-notes/node.md) ^0.3.0

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2017-12-19
- 0.1.1 — 2017-12-17
- 0.1.0 — 2017-12-14

## README

# Release Notes Changelog Parser

[![Subscribe to Release Notes](https://release-notes.com/badges/v1.svg)](https://release-notes.com/@release-notes/changelog-parser)
[![NPM Package](https://img.shields.io/npm/v/@release-notes/changelog-parser.svg)](https://www.npmjs.com/package/@release-notes/changelog-parser)
[![MIT license](https://img.shields.io/github/license/release-notes/changelog-parser.svg)](LICENSE)

## 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

```bash
$ yarn add @release-notes/changelog-parser
$ npm i --save @release-notes/changelog-parser
```

## Usage

```js
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](https://github.com/release-notes/release-notes-node/blob/develop/lib/models/ReleaseNotes.js).

---

### LICENSE

The files in this archive are released under MIT license.
You can find a copy of this license in [LICENSE](LICENSE).

---
_Source: https://npm.io/package/@release-notes/changelog-parser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._