keep-a-changelog 2.3.0 → 2.4.1

package/esm/deps/deno.land/std@0.203.0/semver/test_comparator.js

@@ -0,0 +1,10 @@
+import { cmp } from "./cmp.js";
+/**
+ * Test to see if a semantic version falls within the range of the comparator.
+ * @param version The version to compare
+ * @param comparator The comparator
+ * @returns True if the version is within the comparators set otherwise false
+ */
+export function testComparator(version, comparator) {
+    return cmp(version, comparator.operator, comparator.semver);
+}

package/esm/deps/deno.land/std@0.203.0/semver/test_range.d.ts

@@ -0,0 +1,8 @@
+import type { SemVer, SemVerRange } from "./types.js";
+/**
+ * Test to see if the version satisfies the range.
+ * @param version The version to test
+ * @param range The range to check
+ * @returns true if the version is in the range
+ */
+export declare function testRange(version: SemVer, range: SemVerRange): boolean;

package/esm/deps/deno.land/std@0.203.0/semver/test_range.js

@@ -0,0 +1,16 @@
+import { gte } from "./gte.js";
+import { lte } from "./lte.js";
+/**
+ * Test to see if the version satisfies the range.
+ * @param version The version to test
+ * @param range The range to check
+ * @returns true if the version is in the range
+ */
+export function testRange(version, range) {
+    for (const r of range.ranges) {
+        if (r.every((c) => gte(version, c.min) && lte(version, c.max))) {
+            return true;
+        }
+    }
+    return false;
+}

package/esm/deps/deno.land/std@0.203.0/semver/types.d.ts

@@ -0,0 +1,44 @@
+/**
+ * The possible release types are used as an operator for the
+ * increment function and as a result of the difference function.
+ */
+export type ReleaseType = "pre" | "major" | "premajor" | "minor" | "preminor" | "patch" | "prepatch" | "prerelease";
+/**
+ * SemVer comparison operators.
+ */
+export type Operator = "" | "=" | "==" | "===" | "!==" | "!=" | ">" | ">=" | "<" | "<=";
+/**
+ * The style to use when formatting a SemVer object into a string
+ */
+export type FormatStyle = "full" | "release" | "primary" | "build" | "pre" | "patch" | "minor" | "major";
+/**
+ * The shape of a valid semantic version comparator
+ * @example >=0.0.0
+ */
+export interface SemVerComparator {
+    operator: Operator;
+    semver: SemVer;
+    min: SemVer;
+    max: SemVer;
+}
+/**
+ * A SemVer object parsed into its constituent parts.
+ */
+export interface SemVer {
+    major: number;
+    minor: number;
+    patch: number;
+    prerelease: (string | number)[];
+    build: string[];
+}
+type SemVerRangeAnd = SemVerComparator[];
+type SemVerRangeOr = SemVerRangeAnd[];
+/**
+ * A type representing a semantic version range. The ranges consist of
+ * a nested array, which represents a set of OR comparisons while the
+ * inner array represents AND comparisons.
+ */
+export interface SemVerRange {
+    ranges: SemVerRangeOr;
+}
+export {};

package/esm/deps/deno.land/std@0.203.0/semver/types.js

@@ -0,0 +1,2 @@
+// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+export {};

package/esm/src/Changelog.d.ts

@@ -1,5 +1,5 @@
 import Release from "./Release.js";
-import { Semver } from "./deps.js";
+import type { SemVer } from "./deps.js";
 export default class Changelog {
     flag?: string;
     title: string;
@@ -9,11 +9,13 @@ export default class Changelog {
     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;
+    findRelease(version?: SemVer | string): Release | undefined;
     sortReleases(): void;
+    compareLink(previous: Release, release: Release): string;
     tagName(release: Release): string;
     toString(): string;
 }

package/esm/src/Changelog.js

@@ -1,4 +1,4 @@
-import { eq } from "./deps.js";
+import { eq, parse } from "./deps.js";
 export default class Changelog {
     constructor(title, description = "") {
         Object.defineProperty(this, "flag", {
@@ -49,6 +49,12 @@ export default 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,
@@ -68,11 +74,26 @@ export default class Changelog {
         if (!version) {
             return this.releases.find((release) => !release.version);
         }
-        return this.releases.find((release) => release.version && eq(release.version, version));
+        if (typeof version === "string") {
+            version = parse(version);
+        }
+        return this.releases.find((release) => release.parsedVersion && 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);
@@ -94,8 +115,8 @@ export default 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/esm/src/Release.d.ts

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

package/esm/src/Release.js

@@ -1,4 +1,4 @@
-import { Semver } from "./deps.js";
+import { compare, format, parse } from "./deps.js";
 import Change from "./Change.js";
 export default class Release {
     constructor(version, date, description = "") {
@@ -8,7 +8,7 @@ export default class Release {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "version", {
+        Object.defineProperty(this, "parsedVersion", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -50,11 +50,14 @@ export default class Release {
             ["security", []],
         ]);
     }
+    get version() {
+        return this.parsedVersion ? 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) {
@@ -63,8 +66,8 @@ export default class Release {
         if (!release.date) {
             return 1;
         }
-        if (this.version && release.version) {
-            return -this.version.compare(release.version);
+        if (this.parsedVersion && release.parsedVersion) {
+            return -compare(this.parsedVersion, release.parsedVersion);
         }
         return 0;
     }
@@ -76,9 +79,9 @@ export default class Release {
     }
     setVersion(version) {
         if (typeof version === "string") {
-            version = new Semver(version);
+            version = parse(version);
         }
-        this.version = version;
+        this.parsedVersion = version;
         //Re-sort the releases of the parent changelog
         if (this.changelog) {
             this.changelog.sortReleases();
@@ -126,12 +129,13 @@ export default 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 {
@@ -175,19 +179,14 @@ export default 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/esm/src/deps.d.ts

@@ -1 +1,2 @@
-export { default as Semver, eq, } from "../deps/deno.land/std@0.173.0/semver/mod.js";
+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/esm/src/deps.js

@@ -1 +1 @@
-export { default as Semver, eq, } from "../deps/deno.land/std@0.173.0/semver/mod.js";
+export { compare, eq, format, parse, } from "../deps/deno.land/std@0.203.0/semver/mod.js";

package/esm/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/esm/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/esm/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/esm/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/esm/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/).

package/package.json

@@ -5,8 +5,8 @@
     "changelog": "./esm/bin.js"
   },
   "name": "keep-a-changelog",
-  "version": "2.3.0",
-  "description": "Node package to parse and generate changelogs following the [keepachangelog](http://keepachangelog.com/en/1.0.0/) format.",
+  "version": "2.4.1",
+  "description": "Node package to parse and generate changelogs following the [keepachangelog](https://keepachangelog.com/) format.",
   "homepage": "https://github.com/oscarotero/keep-a-changelog#readme",
   "license": "MIT",
   "keywords": [

package/script/_dnt.shims.js

@@ -8,7 +8,6 @@ const dntGlobals = {
     Deno: shim_deno_1.Deno,
 };
 exports.dntGlobalThis = createMergeProxy(globalThis, dntGlobals);
-// deno-lint-ignore ban-types
 function createMergeProxy(baseObj, extObj) {
     return new Proxy(baseObj, {
         get(_target, prop, _receiver) {

package/script/deps/deno.land/std@0.203.0/semver/_shared.d.ts

@@ -0,0 +1,42 @@
+import { Operator } from "./types.js";
+export declare function compareNumber(a: number, b: number): 1 | 0 | -1;
+export declare function checkIdentifier(v1: ReadonlyArray<string | number>, v2: ReadonlyArray<string | number>): 1 | 0 | -1;
+export declare function compareIdentifier(v1: ReadonlyArray<string | number>, v2: ReadonlyArray<string | number>): 1 | 0 | -1;
+declare const re: RegExp[];
+declare const src: string[];
+declare const NUMERICIDENTIFIER: number;
+declare const FULL: number;
+declare const XRANGE: number;
+declare const TILDE: number;
+declare const CARET: number;
+declare const COMPARATOR: number;
+declare const HYPHENRANGE: number;
+declare const STAR: number;
+/**
+ * Returns true if the value is a valid SemVer number.
+ *
+ * Must be a number. Must not be NaN. Can be positive or negative infinity.
+ * Can be between 0 and MAX_SAFE_INTEGER.
+ * @param value The value to check
+ * @returns True if its a valid semver number
+ */
+export declare function isValidNumber(value: unknown): value is number;
+export declare const MAX_LENGTH = 256;
+/**
+ * Returns true if the value is a valid semver pre-release or build identifier.
+ *
+ * Must be a string. Must be between 1 and 256 characters long. Must match
+ * the regular expression /[0-9A-Za-z-]+/.
+ * @param value The value to check
+ * @returns True if the value is a valid semver string.
+ */
+export declare function isValidString(value: unknown): value is string;
+/**
+ * Checks to see if the value is a valid Operator string.
+ *
+ * Adds a type assertion if true.
+ * @param value The value to check
+ * @returns True if the value is a valid Operator string otherwise false.
+ */
+export declare function isValidOperator(value: unknown): value is Operator;
+export { CARET, COMPARATOR, FULL, HYPHENRANGE, NUMERICIDENTIFIER, re, src, STAR, TILDE, XRANGE, };