keep-a-changelog 2.5.3 → 2.6.0

package/script/src/Changelog.js

@@ -1,186 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const deps_js_1 = require("./deps.js");
-class Changelog {
-    constructor(title, description = "") {
-        Object.defineProperty(this, "flag", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "title", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "description", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "head", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "HEAD"
-        });
-        Object.defineProperty(this, "footer", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "url", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "releases", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: []
-        });
-        Object.defineProperty(this, "tagNameBuilder", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /** @deprecated: Use tagLinkBuilder() instead */
-        Object.defineProperty(this, "compareLinkBuilder", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "tagLinkBuilder", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "format", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "compact"
-        });
-        this.title = title;
-        this.description = description;
-    }
-    addRelease(release) {
-        this.releases.push(release);
-        this.sortReleases();
-        release.changelog = this;
-        return this;
-    }
-    findRelease(version) {
-        if (!version) {
-            return this.releases.find((release) => !release.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 (this.tagLinkBuilder) {
-            const url = this.url;
-            if (!previous) {
-                return this.tagLinkBuilder(this.url, this.tagName(release));
-            }
-            if (!release.date || !release.version) {
-                return this.tagLinkBuilder(url, this.head, this.tagName(previous));
-            }
-            return this.tagLinkBuilder(url, this.tagName(release), this.tagName(previous));
-        }
-        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);
-        }
-        return `v${release.version}`;
-    }
-    toString() {
-        const t = [];
-        if (this.flag) {
-            t.push(`<!-- ${this.flag} -->`);
-            t.push("");
-        }
-        t.push(`# ${this.title}`);
-        if (this.format === "markdownlint") {
-            t.push("");
-        }
-        const links = [];
-        const compareLinks = [];
-        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](https://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](https://semver.org/).`;
-        if (description) {
-            t.push(description);
-        }
-        this.releases.forEach((release) => {
-            t.push("");
-            t.push(release.toString(this));
-            release.getLinks(this).forEach((link) => {
-                if (!links.includes(link)) {
-                    links.push(link);
-                }
-            });
-            const compareLink = release.getCompareLink(this);
-            if (compareLink) {
-                compareLinks.push(compareLink);
-            }
-        });
-        if (links.length) {
-            t.push("");
-            links.sort(compare);
-            links.forEach((link) => t.push(link));
-        }
-        if (compareLinks.length) {
-            t.push("");
-            compareLinks.forEach((link) => t.push(link));
-        }
-        t.push("");
-        if (this.footer) {
-            t.push("---");
-            t.push("");
-            t.push(this.footer);
-            t.push("");
-        }
-        return t.join("\n");
-    }
-}
-exports.default = Changelog;
-function compare(a, b) {
-    if (a === b) {
-        return 0;
-    }
-    const reg = /^\[#(\d+)\]:/;
-    const aNumber = a.match(reg);
-    const bNumber = b.match(reg);
-    if (aNumber && bNumber) {
-        return parseInt(aNumber[1]) - parseInt(bNumber[1]);
-    }
-    return a < b ? -1 : 1;
-}

package/script/src/Release.d.ts

@@ -1,28 +0,0 @@
-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

@@ -1,226 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const deps_js_1 = require("./deps.js");
-const Change_js_1 = __importDefault(require("./Change.js"));
-class Release {
-    constructor(version, date, description = "") {
-        Object.defineProperty(this, "changelog", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "parsedVersion", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "date", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "yanked", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        Object.defineProperty(this, "description", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "changes", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.setVersion(version);
-        this.setDate(date);
-        this.description = description;
-        this.changes = new Map([
-            ["added", []],
-            ["changed", []],
-            ["deprecated", []],
-            ["removed", []],
-            ["fixed", []],
-            ["security", []],
-        ]);
-    }
-    get version() {
-        return this.parsedVersion ? (0, deps_js_1.format)(this.parsedVersion) : undefined;
-    }
-    compare(release) {
-        if (!this.parsedVersion && release.parsedVersion) {
-            return -1;
-        }
-        if (!release.parsedVersion) {
-            return 1;
-        }
-        if (!this.date && release.date) {
-            return -1;
-        }
-        if (!release.date) {
-            return 1;
-        }
-        if (this.parsedVersion && release.parsedVersion) {
-            return -(0, deps_js_1.compare)(this.parsedVersion, release.parsedVersion);
-        }
-        return 0;
-    }
-    isEmpty() {
-        if (this.description.trim()) {
-            return false;
-        }
-        return Array.from(this.changes.values()).every((change) => !change.length);
-    }
-    setVersion(version) {
-        if (typeof version === "string") {
-            version = (0, deps_js_1.parse)(version);
-        }
-        this.parsedVersion = version;
-        //Re-sort the releases of the parent changelog
-        if (this.changelog) {
-            this.changelog.sortReleases();
-        }
-    }
-    setDate(date) {
-        if (typeof date === "string") {
-            date = new Date(date);
-        }
-        this.date = date;
-    }
-    setYanked(yanked = true) {
-        this.yanked = yanked;
-        return this;
-    }
-    addChange(type, change) {
-        if (!(change instanceof Change_js_1.default)) {
-            change = new Change_js_1.default(change);
-        }
-        if (!this.changes.has(type)) {
-            throw new Error("Invalid change type");
-        }
-        this.changes.get(type).push(change);
-        return this;
-    }
-    added(change) {
-        return this.addChange("added", change);
-    }
-    changed(change) {
-        return this.addChange("changed", change);
-    }
-    deprecated(change) {
-        return this.addChange("deprecated", change);
-    }
-    removed(change) {
-        return this.addChange("removed", change);
-    }
-    fixed(change) {
-        return this.addChange("fixed", change);
-    }
-    security(change) {
-        return this.addChange("security", change);
-    }
-    toString(changelog) {
-        let t = [];
-        const hasCompareLink = this.getCompareLink(changelog) !== undefined;
-        const yanked = this.yanked ? " [YANKED]" : "";
-        const { version } = this;
-        if (version) {
-            if (hasCompareLink) {
-                t.push(`## [${version}] - ${formatDate(this.date)}${yanked}`);
-            }
-            else {
-                t.push(`## ${version} - ${formatDate(this.date)}${yanked}`);
-            }
-        }
-        else {
-            if (hasCompareLink) {
-                t.push(`## [Unreleased]${yanked}`);
-            }
-            else {
-                t.push(`## Unreleased${yanked}`);
-            }
-        }
-        if (changelog?.format === "markdownlint") {
-            t.push("");
-        }
-        if (this.description.trim()) {
-            t.push(this.description.trim());
-            t.push("");
-        }
-        this.changes.forEach((changes, type) => {
-            if (changes.length) {
-                t.push(`### ${type[0].toUpperCase()}${type.substring(1)}`);
-                if (changelog?.format === "markdownlint") {
-                    t.push("");
-                }
-                t = t.concat(changes.map((change) => change.toString()));
-                t.push("");
-            }
-        });
-        return t.join("\n").trim();
-    }
-    getCompareLink(changelog) {
-        if (!changelog?.url) {
-            return;
-        }
-        const index = changelog.releases.indexOf(this);
-        if (index === -1) {
-            return;
-        }
-        let offset = 1;
-        let previous = changelog.releases[index + offset];
-        while (previous && !previous.date) {
-            ++offset;
-            previous = changelog.releases[index + offset];
-        }
-        if (!previous && (!this.version || !this.date)) {
-            return;
-        }
-        const compareLink = changelog.compareLink(previous, this);
-        if (!compareLink) {
-            return;
-        }
-        return `[${this.version || "Unreleased"}]: ${compareLink}`;
-    }
-    getLinks(changelog) {
-        const links = [];
-        if (!changelog.url) {
-            return links;
-        }
-        this.changes.forEach((changes) => changes.forEach((change) => {
-            change.issues.forEach((issue) => {
-                if (!links.includes(issue)) {
-                    links.push(`[#${issue}]: ${changelog.url}/issues/${issue}`);
-                }
-            });
-        }));
-        return links;
-    }
-}
-exports.default = Release;
-function formatDate(date) {
-    if (!date) {
-        return "Unreleased";
-    }
-    const year = date.getUTCFullYear();
-    let month = date.getUTCMonth() + 1;
-    let day = date.getUTCDate();
-    if (month < 10) {
-        month = "0" + month;
-    }
-    if (day < 10) {
-        day = "0" + day;
-    }
-    return `${year}-${month}-${day}`;
-}

package/script/src/deps.d.ts

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

package/script/src/deps.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parse = exports.format = exports.eq = exports.compare = void 0;
-var mod_js_1 = require("../deps/deno.land/std@0.205.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

@@ -1,11 +0,0 @@
-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/src/parser.js

@@ -1,184 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-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),
-};
-/** 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}`);
-    }
-}
-exports.default = parser;
-/** 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);
-    //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.*?)\/(?:-\/)?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

@@ -1,17 +0,0 @@
-/**
- * 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) => string;
-    head: string;
-}
-export default function getSettingsForURL(url: string): Settings | undefined;
-export declare const settings: Settings[];
-export {};