UNPKG

keep-a-changelog

Version:

Parse and generate changelogs following the [keepachangelog](https://keepachangelog.com/) format.

26 lines (25 loc) 952 B
import type Release from "./Release.d.ts"; import type { SemVer } from "./deps.d.ts"; export default class Changelog { flag?: string; title: string; description: string; head: string; footer?: string; url?: string; releases: Release[]; tagNameBuilder?: (release: Release) => string; /** @deprecated: Use tagLinkBuilder() instead */ compareLinkBuilder?: (previous: Release, release: Release) => string; tagLinkBuilder?: (url: string, tag: string, previous?: string, head?: string) => string; format: "compact" | "markdownlint"; bulletStyle: "-" | "*" | "+"; autoSortReleases: boolean; constructor(title: string, description?: string); addRelease(release: Release): this; findRelease(version?: SemVer | string): Release | undefined; sortReleases(): void; compareLink(previous: Release, release: Release): string; tagName(release: Release): string; toString(): string; }