keep-a-changelog 2.2.1 → 2.4.1

package/script/src/Change.d.ts

@@ -0,0 +1,8 @@
+export default class Change {
+    title: string;
+    description: string;
+    issues: string[];
+    static extractIssues(text: string, issues: string[]): string;
+    constructor(title: string, description?: string);
+    toString(): string;
+}

package/script/src/Changelog.d.ts

@@ -0,0 +1,21 @@
+import Release from "./Release.js";
+import type { SemVer } from "./deps.js";
+export default class Changelog {
+    flag?: string;
+    title: string;
+    description: string;
+    head: string;
+    footer?: string;
+    url?: string;
+    releases: Release[];
+    tagNameBuilder?: (release: Release) => string;
+    compareLinkBuilder?: (previous: Release, release: Release) => string;
+    format: "compact" | "markdownlint";
+    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;
+}

package/script/src/Changelog.js

@@ -51,6 +51,12 @@ class Changelog {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "compareLinkBuilder", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "format", {
             enumerable: true,
             configurable: true,
@@ -70,11 +76,26 @@ class Changelog {
         if (!version) {
             return this.releases.find((release) => !release.version);
         }
-        return this.releases.find((release) => release.version && (0, deps_js_1.eq)(release.version, version));
+        if (typeof version === "string") {
+            version = (0, deps_js_1.parse)(version);
+        }
+        return this.releases.find((release) => release.parsedVersion && (0, deps_js_1.eq)(release.parsedVersion, version));
     }
     sortReleases() {
         this.releases.sort((a, b) => a.compare(b));
     }
+    compareLink(previous, release) {
+        if (this.compareLinkBuilder) {
+            return this.compareLinkBuilder(previous, release);
+        }
+        if (!previous) {
+            return `${this.url}/releases/tag/${this.tagName(release)}`;
+        }
+        if (!release.date || !release.version) {
+            return `${this.url}/compare/${this.tagName(previous)}...${this.head}`;
+        }
+        return `${this.url}/compare/${this.tagName(previous)}...${this.tagName(release)}`;
+    }
     tagName(release) {
         if (this.tagNameBuilder) {
             return this.tagNameBuilder(release);
@@ -96,8 +117,8 @@ class Changelog {
         const description = this.description.trim() ||
             `All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).`;
+The format is based on [Keep a Changelog](https://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](https://semver.org/).`;
         if (description) {
             t.push(description);
         }

package/script/src/Release.d.ts

@@ -0,0 +1,28 @@
+import Change from "./Change.js";
+import Changelog from "./Changelog.js";
+import type { SemVer } from "./deps.js";
+export default class Release {
+    changelog?: Changelog;
+    parsedVersion?: SemVer;
+    date?: Date;
+    yanked: boolean;
+    description: string;
+    changes: Map<string, Change[]>;
+    constructor(version?: string | SemVer, date?: string | Date, description?: string);
+    get version(): string | undefined;
+    compare(release: Release): number;
+    isEmpty(): boolean;
+    setVersion(version?: string | SemVer): void;
+    setDate(date?: Date | string): void;
+    setYanked(yanked?: boolean): this;
+    addChange(type: string, change: Change | string): this;
+    added(change: Change | string): this;
+    changed(change: Change | string): this;
+    deprecated(change: Change | string): this;
+    removed(change: Change | string): this;
+    fixed(change: Change | string): this;
+    security(change: Change | string): this;
+    toString(changelog?: Changelog): string;
+    getCompareLink(changelog?: Changelog): string | undefined;
+    getLinks(changelog: Changelog): string[];
+}

package/script/src/Release.js

@@ -13,7 +13,7 @@ class Release {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "version", {
+        Object.defineProperty(this, "parsedVersion", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -55,11 +55,14 @@ class Release {
             ["security", []],
         ]);
     }
+    get version() {
+        return this.parsedVersion ? (0, deps_js_1.format)(this.parsedVersion) : undefined;
+    }
     compare(release) {
-        if (!this.version && release.version) {
+        if (!this.parsedVersion && release.parsedVersion) {
             return -1;
         }
-        if (!release.version) {
+        if (!release.parsedVersion) {
             return 1;
         }
         if (!this.date && release.date) {
@@ -68,8 +71,8 @@ class Release {
         if (!release.date) {
             return 1;
         }
-        if (this.version && release.version) {
-            return -this.version.compare(release.version);
+        if (this.parsedVersion && release.parsedVersion) {
+            return -(0, deps_js_1.compare)(this.parsedVersion, release.parsedVersion);
         }
         return 0;
     }
@@ -81,9 +84,9 @@ class Release {
     }
     setVersion(version) {
         if (typeof version === "string") {
-            version = new deps_js_1.Semver(version);
+            version = (0, deps_js_1.parse)(version);
         }
-        this.version = version;
+        this.parsedVersion = version;
         //Re-sort the releases of the parent changelog
         if (this.changelog) {
             this.changelog.sortReleases();
@@ -131,12 +134,13 @@ class Release {
         let t = [];
         const hasCompareLink = this.getCompareLink(changelog) !== undefined;
         const yanked = this.yanked ? " [YANKED]" : "";
-        if (this.version) {
+        const { version } = this;
+        if (version) {
             if (hasCompareLink) {
-                t.push(`## [${this.version}] - ${formatDate(this.date)}${yanked}`);
+                t.push(`## [${version}] - ${formatDate(this.date)}${yanked}`);
             }
             else {
-                t.push(`## ${this.version} - ${formatDate(this.date)}${yanked}`);
+                t.push(`## ${version} - ${formatDate(this.date)}${yanked}`);
             }
         }
         else {
@@ -180,19 +184,14 @@ class Release {
             ++offset;
             previous = changelog.releases[index + offset];
         }
-        if (!previous) {
-            if (!this.version || !this.date) {
-                return;
-            }
-            return `[${this.version}]: ${changelog.url}/releases/tag/${changelog.tagName(this)}`;
-        }
-        if (!this.version) {
-            return `[Unreleased]: ${changelog.url}/compare/${changelog.tagName(previous)}...${changelog.head}`;
+        if (!previous && (!this.version || !this.date)) {
+            return;
         }
-        if (!this.date) {
-            return `[${this.version}]: ${changelog.url}/compare/${changelog.tagName(previous)}...${changelog.head}`;
+        const compareLink = changelog.compareLink(previous, this);
+        if (!compareLink) {
+            return;
         }
-        return `[${this.version}]: ${changelog.url}/compare/${changelog.tagName(previous)}...${changelog.tagName(this)}`;
+        return `[${this.version || "Unreleased"}]: ${compareLink}`;
     }
     getLinks(changelog) {
         const links = [];

package/script/src/deps.d.ts

@@ -0,0 +1,2 @@
+export { compare, eq, format, parse, } from "../deps/deno.land/std@0.203.0/semver/mod.js";
+export type { SemVer } from "../deps/deno.land/std@0.203.0/semver/mod.js";

package/script/src/deps.js

@@ -1,9 +1,8 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.eq = exports.Semver = void 0;
-var mod_js_1 = require("../deps/deno.land/std@0.173.0/semver/mod.js");
-Object.defineProperty(exports, "Semver", { enumerable: true, get: function () { return __importDefault(mod_js_1).default; } });
+exports.parse = exports.format = exports.eq = exports.compare = void 0;
+var mod_js_1 = require("../deps/deno.land/std@0.203.0/semver/mod.js");
+Object.defineProperty(exports, "compare", { enumerable: true, get: function () { return mod_js_1.compare; } });
 Object.defineProperty(exports, "eq", { enumerable: true, get: function () { return mod_js_1.eq; } });
+Object.defineProperty(exports, "format", { enumerable: true, get: function () { return mod_js_1.format; } });
+Object.defineProperty(exports, "parse", { enumerable: true, get: function () { return mod_js_1.parse; } });

package/script/src/parser.d.ts

@@ -0,0 +1,11 @@
+import Changelog from "./Changelog.js";
+import Release from "./Release.js";
+export interface Options {
+    /**
+     * Custom function to create Release instances.
+     * Needed if you want to use a custom Release class.
+     */
+    releaseCreator: (version?: string, date?: string, description?: string) => Release;
+}
+/** Parse a markdown string */
+export default function parser(markdown: string, options?: Options): Changelog;

package/script/test/changelog.custom.type.md

@@ -1,9 +1,8 @@
 # Changelog - demo
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to
-[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 ### Maintenance

package/script/test/changelog.expected.linted.md

@@ -2,9 +2,8 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to
-[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased] [YANKED]
 
@@ -96,7 +95,7 @@ This is a brand new releases with:
 ### Changed
 
 - Improve argument against commit logs.
-- Start following [SemVer](http://semver.org) properly.
+- Start following [SemVer](https://semver.org) properly.
 
 ## [0.0.8] - 2015-02-17
 

package/script/test/changelog.expected.md

@@ -1,9 +1,8 @@
 # Changelog - demo
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to
-[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased] [YANKED]
 This is a brand new releases with:
@@ -80,7 +79,7 @@ This is a brand new releases with:
 
 ### Changed
 - Improve argument against commit logs.
-- Start following [SemVer](http://semver.org) properly.
+- Start following [SemVer](https://semver.org) properly.
 
 ## [0.0.8] - 2015-02-17
 ### Changed

package/script/test/changelog.md

@@ -2,9 +2,8 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to
-[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased] [Yanked]
 This is a brand new releases with:
@@ -97,7 +96,7 @@ This is a brand new releases with:
 ### Changed
 
 - Improve argument against commit logs.
-- Start following [SemVer](http://semver.org) properly.
+- Start following [SemVer](https://semver.org) properly.
 
 ## [0.0.8] - 2015-02-17
 

package/script/test/empty.expected.md

@@ -1,5 +1,5 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).
+The format is based on [Keep a Changelog](https://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](https://semver.org/).