keep-a-changelog 2.6.0 → 2.6.1

package/script/src/deps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deps.d.ts","sourceRoot":"","sources":["../../src/src/deps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,yCAAyC,CAAC;AAEzF,YAAY,EAAE,MAAM,EAAE,MAAM,yCAAyC,CAAC"}

package/script/src/deps.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parse = exports.format = exports.equals = exports.compare = void 0;
+var mod_js_1 = require("../deps/jsr.io/@std/semver/1.0.4/mod.js");
+Object.defineProperty(exports, "compare", { enumerable: true, get: function () { return mod_js_1.compare; } });
+Object.defineProperty(exports, "equals", { enumerable: true, get: function () { return mod_js_1.equals; } });
+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,17 @@
+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;
+    /**
+     * If false, releases will not be sorted automatically.
+     * Default is true.
+     */
+    autoSortReleases: boolean;
+}
+/** Parse a markdown string */
+export default function parser(markdown: string, options?: Partial<Options>): Changelog;
+//# sourceMappingURL=parser.d.ts.map

package/script/src/parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/src/parser.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,OAAO,MAAM,cAAc,CAAC;AAEnC,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,cAAc,EAAE,CACd,OAAO,CAAC,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,EACb,WAAW,CAAC,EAAE,MAAM,KACjB,OAAO,CAAC;IACb;;;OAGG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAQD,8BAA8B;AAC9B,MAAM,CAAC,OAAO,UAAU,MAAM,CAC5B,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GACzB,SAAS,CAWX"}

package/script/src/parser.js

@@ -0,0 +1,186 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parser;
+const Changelog_js_1 = __importDefault(require("./Changelog.js"));
+const Release_js_1 = __importDefault(require("./Release.js"));
+const defaultOptions = {
+    releaseCreator: (version, date, description) => new Release_js_1.default(version, date, description),
+    autoSortReleases: true,
+};
+/** Parse a markdown string */
+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_js_1.default("");
+    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/script/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/script/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/script/src/settings.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.settings = void 0;
+exports.default = getSettingsForURL;
+/**
+ * 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);
+    }
+}
+function getSettingsForURL(url) {
+    return exports.settings.find((settings) => settings.pattern.test(url));
+}
+exports.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/script/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/script/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/script/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/script/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/script/test/test.d.ts.map

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

package/esm/keep-a-changelog/bin.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-import "../_dnt.polyfills.js";

package/esm/keep-a-changelog/bin.js

@@ -1,201 +0,0 @@
-#!/usr/bin/env node
-import "../_dnt.polyfills.js";
-import * as dntShim from "../_dnt.shims.js";
-import { join } from "../std/path/mod.js";
-import { Changelog, parser, Release } from "./mod.js";
-import { parseArgs } from "../std/cli/parse_args.js";
-import { parse as parseIni } from "../std/ini/mod.js";
-import getSettingsForURL from "./src/settings.js";
-const argv = parseArgs(dntShim.Deno.args, {
-    default: {
-        file: "CHANGELOG.md",
-        format: "compact",
-        release: null,
-        create: null,
-        url: null,
-        https: true,
-        quiet: false,
-        head: null,
-        combine: false,
-        "bullet-style": "-",
-    },
-    string: ["file", "format", "url", "head", "bullet-style"],
-    boolean: [
-        "https",
-        "init",
-        "latest-release",
-        "quiet",
-        "help",
-        "combine",
-        "no-v-prefix",
-        "no-sort-releases",
-    ],
-    alias: {
-        h: "help",
-    },
-});
-const file = join(dntShim.Deno.cwd(), argv.file);
-try {
-    if (argv.help) {
-        showHelp();
-        dntShim.Deno.exit(0);
-    }
-    if (argv.init) {
-        const changelog = new Changelog("Changelog").addRelease(new Release("0.1.0", new Date(), "First version"));
-        changelog.format = argv.format;
-        changelog.bulletStyle = argv["bullet-style"];
-        save(file, changelog, true);
-        dntShim.Deno.exit(0);
-    }
-    const changelog = parser(dntShim.Deno.readTextFileSync(file), {
-        autoSortReleases: !argv["no-sort-releases"],
-    });
-    changelog.format = argv.format;
-    changelog.bulletStyle = argv["bullet-style"];
-    if (argv["no-v-prefix"]) {
-        changelog.tagNameBuilder = (release) => String(release.version);
-    }
-    if (argv["latest-release"]) {
-        const release = changelog.releases.find((release) => release.date && release.version);
-        if (release) {
-            console.log(release.version?.toString());
-        }
-        dntShim.Deno.exit(0);
-    }
-    if (argv.release) {
-        const release = changelog.releases.find((release) => {
-            if (release.date) {
-                return false;
-            }
-            if (typeof argv.release === "string") {
-                return !release.version || argv.release === release.version.toString();
-            }
-            return !!release.version;
-        });
-        if (release) {
-            release.date = new Date();
-            if (typeof argv.release === "string") {
-                release.setVersion(argv.release);
-            }
-        }
-        else {
-            console.error("Not found any valid unreleased version");
-            dntShim.Deno.exit(1);
-        }
-    }
-    if (argv.combine) {
-        const combinedReleases = changelog.releases.reduce((acc, release) => {
-            if (release.version) {
-                if (acc[release.version]) {
-                    acc[release.version].combineChanges(release.changes);
-                }
-                else {
-                    acc[release.version] = release;
-                }
-            }
-            return acc;
-        }, {});
-        changelog.releases = Object.values(combinedReleases);
-    }
-    if (argv.create) {
-        const version = typeof argv.create === "string" ? argv.create : undefined;
-        const release = changelog.releases.find((release) => {
-            return release.version === version;
-        });
-        if (release) {
-            console.warn("Release already exists.");
-        }
-        else {
-            changelog.addRelease(new Release(version));
-        }
-    }
-    save(file, changelog);
-}
-catch (err) {
-    console.error(red(err.message));
-    if (!argv.quiet) {
-        dntShim.Deno.exit(1);
-    }
-}
-function save(file, changelog, isNew = false) {
-    changelog.url = argv.url || changelog.url || getRemoteUrl(argv.https);
-    if (!changelog.url) {
-        console.error(red('Please, set the repository url with --url="https://github.com/username/repository"'));
-        changelog.url = "https://example.com";
-    }
-    if (changelog.url) {
-        const settings = getSettingsForURL(changelog.url);
-        if (settings) {
-            changelog.head = settings.head;
-            changelog.tagLinkBuilder = settings.tagLink;
-        }
-    }
-    if (argv.head) {
-        changelog.head = argv.head;
-    }
-    dntShim.Deno.writeTextFileSync(file, changelog.toString());
-    if (isNew) {
-        console.log(green("Generated new file"), file);
-    }
-    else {
-        console.log(green("Updated file"), file);
-    }
-}
-function red(message) {
-    return "\u001b[" + 31 + "m" + message + "\u001b[" + 39 + "m";
-}
-function green(message) {
-    return "\u001b[" + 32 + "m" + message + "\u001b[" + 39 + "m";
-}
-function normalizeUrl(url, https) {
-    // remove .git suffix
-    url = url.replace(/\.git$/, "");
-    // normalize git@host urls
-    if (url.startsWith("git@")) {
-        url = url.replace(/^git@([^:]+):(.*)$/, (https ? "https" : "http") + "://$1/$2");
-    }
-    // remove trailing slashes
-    url = url.replace(/\/+$/, "");
-    return new URL(url);
-}
-function getRemoteUrl(https = true) {
-    try {
-        const file = join(dntShim.Deno.cwd(), ".git", "config");
-        const content = dntShim.Deno.readTextFileSync(file);
-        const data = parseIni(content);
-        const origin = data['remote "origin"'];
-        if (!origin?.url) {
-            return;
-        }
-        return normalizeUrl(origin.url, https).href;
-    }
-    catch (err) {
-        console.error(red(err.message));
-        // Ignore
-    }
-}
-function showHelp() {
-    console.log(`keep-a-changelog
-
-Usage: keep-a-changelog [options]
-
-Options:
-  --file, -f          Changelog file (default: CHANGELOG.md)
-  --format            Output format (default: compact)
-  --bullet-style      Bullet point style (default: -)
-  --url               Repository URL
-
-  --init              Initialize a new changelog file
-  --latest-release    Print the latest release version
-
-  --release           Set the date of the specified release
-  --combine           Combine changes from releases with the same version
-  --create            Create a new release
-
-  --no-v-prefix       Do not add a "v" prefix to the version
-  --no-sort-releases  Do not sort releases
-  --head              Set the HEAD link
-  --quiet             Do not print errors
-  --help, -h          Show this help message
-`);
-}

package/esm/keep-a-changelog/mod.d.ts

@@ -1,6 +0,0 @@
-import "../_dnt.polyfills.js";
-import parser from "./src/parser.js";
-import Change from "./src/Change.js";
-import Changelog from "./src/Changelog.js";
-import Release from "./src/Release.js";
-export { Change, Changelog, parser, Release };

package/esm/keep-a-changelog/mod.js

@@ -1,6 +0,0 @@
-import "../_dnt.polyfills.js";
-import parser from "./src/parser.js";
-import Change from "./src/Change.js";
-import Changelog from "./src/Changelog.js";
-import Release from "./src/Release.js";
-export { Change, Changelog, parser, Release };