keep-a-changelog 2.6.0 → 2.6.2

package/esm/src/parser.js

@@ -0,0 +1,180 @@
+import Changelog from "./Changelog.js";
+import Release from "./Release.js";
+const defaultOptions = {
+    releaseCreator: (version, date, description) => new Release(version, date, description),
+    autoSortReleases: true,
+};
+/** Parse a markdown string */
+export default function parser(markdown, options) {
+    const opts = Object.assign({}, defaultOptions, options);
+    const tokens = tokenize(markdown);
+    try {
+        return processTokens(tokens, opts);
+    }
+    catch (error) {
+        throw new Error(`Parse error in the line ${tokens[0][0]}: ${error.message}`);
+    }
+}
+/** Process an array of tokens to build the Changelog */
+function processTokens(tokens, opts) {
+    const changelog = new Changelog("");
+    changelog.flag = getContent(tokens, "flag");
+    changelog.title = getContent(tokens, "h1", true);
+    changelog.description = getTextContent(tokens);
+    changelog.autoSortReleases = opts.autoSortReleases;
+    //Releases
+    let release;
+    while ((release = getContent(tokens, "h2").toLowerCase())) {
+        const matches = release.match(/\[?([^\]]+)\]?\s*-\s*([\d]{4}-[\d]{1,2}-[\d]{1,2})(\s+\[yanked\])?$/);
+        if (matches) {
+            release = opts.releaseCreator(matches[1], matches[2]);
+            release.yanked = !!matches[3];
+        }
+        else if (release.includes("unreleased")) {
+            const matches = release.match(/\[?([^\]]+)\]?\s*-\s*unreleased(\s+\[yanked\])?$/);
+            const yanked = release.includes("[yanked]");
+            release = matches
+                ? opts.releaseCreator(matches[1])
+                : opts.releaseCreator();
+            release.yanked = yanked;
+        }
+        else {
+            throw new Error(`Syntax error in the release title`);
+        }
+        changelog.addRelease(release);
+        release.description = getTextContent(tokens);
+        let type;
+        while ((type = getContent(tokens, "h3").toLowerCase())) {
+            let change;
+            while ((change = getContent(tokens, "li"))) {
+                release.addChange(type, change);
+            }
+        }
+    }
+    //Skip release links
+    let link = getContent(tokens, "link");
+    while (link) {
+        if (!changelog.url) {
+            const matches = link.match(/^\[.*\]\:\s*(http.*?)\/(?:-\/)?(branchCompare|compare)(\/|\?).*$/);
+            if (matches) {
+                changelog.url = matches[1];
+            }
+        }
+        link = getContent(tokens, "link");
+    }
+    //Footer
+    if (getContent(tokens, "hr")) {
+        changelog.footer = getContent(tokens, "p");
+    }
+    if (tokens.length) {
+        throw new Error(`Unexpected content ${JSON.stringify(tokens)}`);
+    }
+    return changelog;
+}
+/** Returns the content of a token */
+function getContent(tokens, type, required = false) {
+    const types = Array.isArray(type) ? type : [type];
+    if (!tokens[0] || types.indexOf(tokens[0][1]) === -1) {
+        if (required) {
+            throw new Error(`Required token missing in: "${tokens[0][0]}"`);
+        }
+        return "";
+    }
+    return tokens.shift()[2].join("\n");
+}
+/** Return the next text content */
+function getTextContent(tokens) {
+    const lines = [];
+    const types = ["p", "li"];
+    while (tokens[0] && types.indexOf(tokens[0][1]) !== -1) {
+        const token = tokens.shift();
+        if (token[1] === "li") {
+            lines.push("- " + token[2].join("\n"));
+        }
+        else {
+            lines.push(token[2].join("\n"));
+        }
+    }
+    return lines.join("\n");
+}
+/** Tokenize a markdown string */
+function tokenize(markdown) {
+    const tokens = [];
+    markdown
+        .trim()
+        .split("\n")
+        .map((line, index, allLines) => {
+        const lineNumber = index + 1;
+        if (line.startsWith("---")) {
+            return [lineNumber, "hr", ["-"]];
+        }
+        if (line.startsWith("# ")) {
+            return [lineNumber, "h1", [line.substr(1).trim()]];
+        }
+        if (line.startsWith("## ")) {
+            return [lineNumber, "h2", [line.substr(2).trim()]];
+        }
+        if (line.startsWith("### ")) {
+            return [lineNumber, "h3", [line.substr(3).trim()]];
+        }
+        if (line.startsWith("-")) {
+            return [lineNumber, "li", [line.substr(1).trim()]];
+        }
+        if (line.startsWith("*")) {
+            return [lineNumber, "li", [line.substr(1).trim()]];
+        }
+        if (line.match(/^\[.*\]\:\s*http.*$/)) {
+            return [lineNumber, "link", [line.trim()]];
+        }
+        if (line.match(/^\[.*\]\:$/)) {
+            const nextLine = allLines[index + 1];
+            if (nextLine && nextLine.match(/\s+http.*$/)) {
+                // We found a multi-line link: treat it like a single line
+                allLines[index + 1] = "";
+                return [lineNumber, "link", [
+                        line.trim() + "\n" + nextLine.trimEnd(),
+                    ]];
+            }
+        }
+        const result = line.match(/^<!--(.*)-->$/);
+        if (result) {
+            return [lineNumber, "flag", [result[1].trim()]];
+        }
+        return [lineNumber, "p", [line.trimEnd()]];
+    })
+        .forEach((line, index) => {
+        const [lineNumber, type, [content]] = line;
+        if (index > 0) {
+            const prevType = tokens[0][1];
+            if (type === "p") {
+                if (prevType === "p") {
+                    return tokens[0][2].push(content);
+                }
+                if (prevType === "li") {
+                    return tokens[0][2].push(content.replace(/^\s\s/, ""));
+                }
+            }
+        }
+        tokens.unshift([lineNumber, type, [content]]);
+    });
+    return tokens
+        .filter((token) => !isEmpty(token[2]))
+        .map((token) => {
+        const content = token[2];
+        while (isEmpty(content[content.length - 1])) {
+            content.pop();
+        }
+        while (isEmpty(content[0])) {
+            content.shift();
+        }
+        return token;
+    })
+        .reverse();
+}
+/** Check if a string or array is empty */
+function isEmpty(val) {
+    if (Array.isArray(val)) {
+        val = val.join("");
+    }
+    return !val || val.trim() === "";
+}

package/esm/src/settings.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Temporary URLPattern shim
+ * @see https://github.com/denoland/dnt/issues/336
+ */
+declare class URLPatternShim {
+    private readonly pattern;
+    constructor(pattern: string | RegExp);
+    test(url: string): boolean;
+}
+export interface Settings {
+    pattern: URLPatternShim;
+    tagLink: (url: string, tag: string, previous?: string, head?: string) => string;
+    head: string;
+}
+export default function getSettingsForURL(url: string): Settings | undefined;
+export declare const settings: Settings[];
+export {};
+//# sourceMappingURL=settings.d.ts.map

package/esm/src/settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/src/settings.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAM,cAAc;IAClB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,OAAO,EAAE,MAAM,GAAG,MAAM;IASpC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;CAG3B;AAED,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,cAAc,CAAC;IACxB,OAAO,EAAE,CACP,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,QAAQ,CAAC,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,MAAM,KACV,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAE3E;AAED,eAAO,MAAM,QAAQ,EAAE,QAAQ,EAwC9B,CAAC"}

package/esm/src/settings.js

@@ -0,0 +1,56 @@
+/**
+ * Temporary URLPattern shim
+ * @see https://github.com/denoland/dnt/issues/336
+ */
+class URLPatternShim {
+    pattern;
+    constructor(pattern) {
+        if (typeof pattern === "string") {
+            pattern = pattern.replace(/\*/g, ".*");
+            pattern = new RegExp(`^${pattern}$`);
+        }
+        this.pattern = pattern;
+    }
+    test(url) {
+        return this.pattern.test(url);
+    }
+}
+export default function getSettingsForURL(url) {
+    return settings.find((settings) => settings.pattern.test(url));
+}
+export const settings = [
+    {
+        pattern: new URLPatternShim("https://github.com/*"),
+        head: "HEAD",
+        tagLink(url, tag, previous) {
+            if (!previous) {
+                return `${url}/releases/tag/${tag}`;
+            }
+            return `${url}/compare/${previous}...${tag}`;
+        },
+    },
+    {
+        pattern: new URLPatternShim("https://gitlab.*/*"),
+        head: "master",
+        tagLink(url, tag, previous) {
+            if (!previous) {
+                return `${url}/-/tags/${tag}`;
+            }
+            return `${url}/-/compare/${previous}...${tag}`;
+        },
+    },
+    {
+        pattern: new URLPatternShim("https://dev.azure.com/*"),
+        head: "master",
+        tagLink(url, tag, previous, head) {
+            if (!previous) {
+                return `${url}?version=GT${tag}`;
+            }
+            let tagPrefix = "GT";
+            if (tag === head) {
+                tagPrefix = "GB";
+            }
+            return `${url}/branchCompare?baseVersion=GT${previous}&targetVersion=${tagPrefix}${tag}`;
+        },
+    },
+];

package/esm/test/Change.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Change.test.d.ts","sourceRoot":"","sources":["../../src/test/Change.test.ts"],"names":[],"mappings":""}

package/esm/test/deps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deps.d.ts","sourceRoot":"","sources":["../../src/test/deps.ts"],"names":[],"mappings":"AAAA,cAAc,0CAA0C,CAAC"}

package/esm/test/fixture/CustomRelease.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomRelease.d.ts","sourceRoot":"","sources":["../../../src/test/fixture/CustomRelease.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD,cAAM,aAAc,SAAQ,OAAO;gBAE/B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EACzB,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,EACpB,WAAW,CAAC,EAAE,MAAM;IAKtB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;CAGpC;AAED,MAAM,CAAC,OAAO,WACZ,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EACzB,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,EACpB,WAAW,CAAC,EAAE,MAAM,iBAGrB"}

package/esm/test/parser.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.test.d.ts","sourceRoot":"","sources":["../../src/test/parser.test.ts"],"names":[],"mappings":""}

package/esm/test/test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../src/test/test.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keep-a-changelog",
-  "version": "2.6.0",
+  "version": "2.6.2",
   "description": "Node package to parse and generate changelogs following the [keepachangelog](https://keepachangelog.com/) format.",
   "keywords": [
     "changelog",
@@ -17,19 +17,19 @@
   "bugs": {
     "url": "https://github.com/oscarotero/keep-a-changelog/issues"
   },
-  "main": "./script/keep-a-changelog/mod.js",
-  "module": "./esm/keep-a-changelog/mod.js",
+  "main": "./script/mod.js",
+  "module": "./esm/mod.js",
   "exports": {
     ".": {
-      "import": "./esm/keep-a-changelog/mod.js",
-      "require": "./script/keep-a-changelog/mod.js"
+      "import": "./esm/mod.js",
+      "require": "./script/mod.js"
     }
   },
   "scripts": {
     "test": "node test_runner.js"
   },
   "bin": {
-    "changelog": "./esm/keep-a-changelog/bin.js"
+    "changelog": "./esm/bin.js"
   },
   "dependencies": {
     "@deno/shim-deno": "~0.18.0"
@@ -38,5 +38,5 @@
     "@types/node": "^20.9.0",
     "picocolors": "^1.0.0"
   },
-  "_generatedBy": "dnt@0.40.0"
+  "_generatedBy": "dnt@dev"
 }

package/script/_dnt.polyfills.d.ts

@@ -1,3 +1,52 @@
+declare global {
+    interface Array<T> {
+        /**
+         * Returns the value of the last element in the array where predicate is true, and undefined
+         * otherwise.
+         * @param predicate find calls predicate once for each element of the array, in ascending
+         * order, until it finds one where predicate returns true. If such an element is found, find
+         * immediately returns that element value. Otherwise, find returns undefined.
+         * @param thisArg If provided, it will be used as the this value for each invocation of
+         * predicate. If it is not provided, undefined is used instead.
+         */
+        findLast<S extends T>(predicate: (this: void, value: T, index: number, obj: T[]) => value is S, thisArg?: any): S | undefined;
+        findLast(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): T | undefined;
+        /**
+         * Returns the index of the last element in the array where predicate is true, and -1
+         * otherwise.
+         * @param predicate find calls predicate once for each element of the array, in ascending
+         * order, until it finds one where predicate returns true. If such an element is found,
+         * findIndex immediately returns that element index. Otherwise, findIndex returns -1.
+         * @param thisArg If provided, it will be used as the this value for each invocation of
+         * predicate. If it is not provided, undefined is used instead.
+         */
+        findLastIndex(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): number;
+    }
+    interface Uint8Array {
+        /**
+         * Returns the value of the last element in the array where predicate is true, and undefined
+         * otherwise.
+         * @param predicate findLast calls predicate once for each element of the array, in descending
+         * order, until it finds one where predicate returns true. If such an element is found, findLast
+         * immediately returns that element value. Otherwise, findLast returns undefined.
+         * @param thisArg If provided, it will be used as the this value for each invocation of
+         * predicate. If it is not provided, undefined is used instead.
+         */
+        findLast<S extends number>(predicate: (value: number, index: number, array: Uint8Array) => value is S, thisArg?: any): S | undefined;
+        findLast(predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any): number | undefined;
+        /**
+         * Returns the index of the last element in the array where predicate is true, and -1
+         * otherwise.
+         * @param predicate findLastIndex calls predicate once for each element of the array, in descending
+         * order, until it finds one where predicate returns true. If such an element is found,
+         * findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1.
+         * @param thisArg If provided, it will be used as the this value for each invocation of
+         * predicate. If it is not provided, undefined is used instead.
+         */
+        findLastIndex(predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any): number;
+    }
+}
+export {};
 declare global {
     interface Object {
         /**
@@ -9,3 +58,4 @@ declare global {
     }
 }
 export {};
+//# sourceMappingURL=_dnt.polyfills.d.ts.map

package/script/_dnt.polyfills.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_dnt.polyfills.d.ts","sourceRoot":"","sources":["../src/_dnt.polyfills.ts"],"names":[],"mappings":"AACA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC,CAAC;QACf;;;;;;;;WAQG;QACH,QAAQ,CAAC,CAAC,SAAS,CAAC,EAClB,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC,EACxE,OAAO,CAAC,EAAE,GAAG,GACZ,CAAC,GAAG,SAAS,CAAC;QACjB,QAAQ,CACN,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,OAAO,EACzD,OAAO,CAAC,EAAE,GAAG,GACZ,CAAC,GAAG,SAAS,CAAC;QAEjB;;;;;;;;WAQG;QACH,aAAa,CACX,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,OAAO,EACzD,OAAO,CAAC,EAAE,GAAG,GACZ,MAAM,CAAC;KACX;IACD,UAAU,UAAU;QAClB;;;;;;;;WAQG;QACH,QAAQ,CAAC,CAAC,SAAS,MAAM,EACvB,SAAS,EAAE,CACP,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,UAAU,KAChB,KAAK,IAAI,CAAC,EACf,OAAO,CAAC,EAAE,GAAG,GACZ,CAAC,GAAG,SAAS,CAAC;QACjB,QAAQ,CACJ,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,KAAK,OAAO,EACvE,OAAO,CAAC,EAAE,GAAG,GACd,MAAM,GAAG,SAAS,CAAC;QAEtB;;;;;;;;WAQG;QACH,aAAa,CACT,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,KAAK,OAAO,EACvE,OAAO,CAAC,EAAE,GAAG,GACd,MAAM,CAAC;KACX;CACF;AA4CD,OAAO,EAAE,CAAC;AAgBV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd;;;;WAIG;QACH,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC;KAC5C;CACF;AAED,OAAO,EAAE,CAAC"}

package/script/_dnt.polyfills.js

@@ -1,5 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+function findLastIndex(self, callbackfn, that) {
+    const boundFunc = that === undefined ? callbackfn : callbackfn.bind(that);
+    let index = self.length - 1;
+    while (index >= 0) {
+        const result = boundFunc(self[index], index, self);
+        if (result) {
+            return index;
+        }
+        index--;
+    }
+    return -1;
+}
+function findLast(self, callbackfn, that) {
+    const index = self.findLastIndex(callbackfn, that);
+    return index === -1 ? undefined : self[index];
+}
+if (!Array.prototype.findLastIndex) {
+    Array.prototype.findLastIndex = function (callbackfn, that) {
+        return findLastIndex(this, callbackfn, that);
+    };
+}
+if (!Array.prototype.findLast) {
+    Array.prototype.findLast = function (callbackfn, that) {
+        return findLast(this, callbackfn, that);
+    };
+}
+if (!Uint8Array.prototype.findLastIndex) {
+    Uint8Array.prototype.findLastIndex = function (callbackfn, that) {
+        return findLastIndex(this, callbackfn, that);
+    };
+}
+if (!Uint8Array.prototype.findLast) {
+    Uint8Array.prototype.findLast = function (callbackfn, that) {
+        return findLast(this, callbackfn, that);
+    };
+}
 // https://github.com/tc39/proposal-accessible-object-hasownproperty/blob/main/polyfill.js
 if (!Object.hasOwn) {
     Object.defineProperty(Object, "hasOwn", {

package/script/_dnt.shims.d.ts

@@ -3,3 +3,4 @@ export { Deno } from "@deno/shim-deno";
 export declare const dntGlobalThis: Omit<typeof globalThis, "Deno"> & {
     Deno: typeof Deno;
 };
+//# sourceMappingURL=_dnt.shims.d.ts.map

package/script/_dnt.shims.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_dnt.shims.d.ts","sourceRoot":"","sources":["../src/_dnt.shims.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAKvC,eAAO,MAAM,aAAa;;CAA2C,CAAC"}

package/script/_dnt.test_shims.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_dnt.test_shims.d.ts","sourceRoot":"","sources":["../src/_dnt.test_shims.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAKvC,eAAO,MAAM,aAAa;;CAA2C,CAAC"}

package/script/bin.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import "./_dnt.polyfills.js";
+//# sourceMappingURL=bin.d.ts.map

package/script/bin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":";AACA,OAAO,qBAAqB,CAAC"}