pear-changelog

1.0.1 • Public • Published

changelog

A couple of functions to parse and compare changelogs buffers for the Holepunch platform

Format

The format of the changelog is fairly simple

arbitrary mardown here as a header

## release title
arbitrary markdown here

## release title
arbitrary markdown here

There is a header of unspecified shape, and various release entries, that use the format

## title
content

Usage

The module contains a couple of functions:

const { parse, diff } = require('changelog')

the parse function returns an array of releases. Each release is another array, with index 0 being the title of the release, and index 1 being the entire body of the release (in markdown, including the title). If it receives anything other than a string or a buffer with the correct format, it will return an empty array.

the diff function compares two arrays of releases, and return a new array with the releases that are in the first array but not in the second one.

const log1 = `
# Changelog

## newer entry
content

## older entry
content
`

const log2 = `
# Changelog

## older entry
content
`
const bLog1 = Buffer.from(log1)

const bLog2 = Buffer.from(log2)

const pLog1 = parse(bLog1)

const pLog2 = parse(bLog2)

console.log(pLog2)

// this prints [ [ 'older entry', '\n## older entry\ncontent\n' ] ]

const difference = diff(pLog1, pLog2)

console.log(difference)

// this prints [ [ 'newer entry', '\n## newer entry\ncontent\n' ] ]

License

This project is licensed under the Apache 2.0 license.

Readme

Keywords

none

Package Sidebar

Install

npm i pear-changelog

Weekly Downloads

143

Version

1.0.1

License

Apache-2.0

Unpacked Size

15.8 kB

Total Files

6

Last publish

Collaborators

  • mafintosh
  • davidmarkclements