change library

Classes

Change

A single change

Changelog

Release

Section

A release or the unreleased section

Functions

parseChangelog(String markdown, {Document? document}) → Changelog

Parses the Changelog from a markdown string. Pass the document instance to have fine-grained control over markdown parsing, such as extensions and html encoding.

printChangelog(Changelog changelog, {bool keepEmptyUnreleased = false}) → String

Converts the changelog to a markdown string.

printChanges(Section section) → String

Converts the Unreleased/Release section to a markdown string. This is the same as printRelease and printUnreleased but skips the header line and the bottom (non-inline) links section.

printRelease(Release release) → String

Converts the release to a markdown string.

printUnreleased(Section unreleased) → String

Converts the unreleased section to a markdown string.