keep-a-changelog 2.0.1 → 2.2.1

package/script/src/Release.js

@@ -0,0 +1,227 @@
+"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, "version", {
+            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", []],
+        ]);
+    }
+    compare(release) {
+        if (!this.version && release.version) {
+            return -1;
+        }
+        if (!release.version) {
+            return 1;
+        }
+        if (!this.date && release.date) {
+            return -1;
+        }
+        if (!release.date) {
+            return 1;
+        }
+        if (this.version && release.version) {
+            return -this.version.compare(release.version);
+        }
+        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 = new deps_js_1.Semver(version);
+        }
+        this.version = 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]" : "";
+        if (this.version) {
+            if (hasCompareLink) {
+                t.push(`## [${this.version}] - ${formatDate(this.date)}${yanked}`);
+            }
+            else {
+                t.push(`## ${this.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) {
+            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 (!this.date) {
+            return `[${this.version}]: ${changelog.url}/compare/${changelog.tagName(previous)}...${changelog.head}`;
+        }
+        return `[${this.version}]: ${changelog.url}/compare/${changelog.tagName(previous)}...${changelog.tagName(this)}`;
+    }
+    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.js

@@ -0,0 +1,9 @@
+"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; } });
+Object.defineProperty(exports, "eq", { enumerable: true, get: function () { return mod_js_1.eq; } });

package/script/src/parser.js

@@ -0,0 +1,184 @@
+"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/{umd → script}/test/changelog.custom.type.md

@@ -1,5 +1,4 @@
 # 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/)

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

@@ -0,0 +1,208 @@
+# 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).
+
+## [Unreleased] [YANKED]
+
+This is a brand new releases with:
+- Configuration is now done within the Web client, for authorized users.
+
+### Added
+
+- Test
+
+## [2.0.0] - Unreleased [YANKED]
+
+### Added
+
+- None
+- Test with issue link [#1]
+- Test with issue link [#4] in the middle of the text
+  - [#3] Test with issue link in the beginning of the text
+  - Test with issue dot [#2], [#10].
+    - Test with no issue link #123b
+    - Test with `package#2.0`
+
+## [1.0.0] - 2017-06-20
+
+### Added
+
+- New visual identity by @tylerfortune8.
+- Version navigation.
+- Links to latest released version in previous versions.
+- "Why keep a changelog?" section.
+- "Who needs a changelog?" section.
+- "How do I make a changelog?" section.
+- "Frequently Asked Questions" section.
+- New "Guiding Principles" sub-section to "How do I make a changelog?".
+- Simplified and Traditional Chinese translations from @tianshuo.
+- German translation from @mpbzh & @Art4.
+- Italian translation from @azkidenz.
+- Swedish translation from @magol.
+- Turkish translation from @karalamalar.
+- French translation from @zapashcanon.
+- Brazilian Portugese translation from @aisamu.
+- Polish translation from @amielucha.
+- Russian translation from @aishek.
+- Czech translation from @h4vry.
+- Slovak translation from @jkostolansky.
+
+### Changed
+
+- Start using "changelog" over "change log" since it's the common usage.
+- Start versioning based on the current English version at 0.3.0 to help
+  translation authors keep things up-to-date.
+- Rewrite "What makes unicorns cry?" section.
+- Rewrite "Ignoring Deprecations" sub-section to clarify the ideal scenario.
+- Improve "Commit log diffs" sub-section to further argument against them.
+- Merge "Why can’t people just use a git log diff?" with "Commit log diffs"
+- Fix typos in Simplified Chinese and Traditional Chinese translations.
+- Fix typos in Brazilian Portugese translation.
+- Fix typos in Turkish translation.
+- Fix typos in Czech translation.
+- Fix typos in Swedish translation.
+- Improve phrasing in French translation.
+- Fix phrasing and spelling in German translation.
+
+### Removed
+
+- Section about "changelog" vs "CHANGELOG".
+
+## [0.3.0] - 2015-12-03
+
+### Added
+
+- RU translation from @aishek.
+- pt-BR translation from @tallesl.
+- es-ES translation from @ZeliosAriex.
+
+## [0.2.0] - 2015-10-06
+
+### Changed
+
+- Remove exclusionary mentions of "open source" since this project can benefit
+  both "open" and "closed" source projects equally.
+
+## [0.1.0] - 2015-10-06
+
+### Added
+
+- Answer "Should you ever rewrite a change log?".
+
+### Changed
+
+- Improve argument against commit logs.
+- Start following [SemVer](http://semver.org) properly.
+
+## [0.0.8] - 2015-02-17
+
+### Changed
+
+- Update year to match in every README example.
+- Reluctantly stop making fun of Brits only, since most of the world writes
+  dates in a strange way.
+
+### Fixed
+
+- Fix typos in recent README changes.
+- Update outdated unreleased diff link.
+
+## [0.0.7] - 2015-02-16
+
+### Added
+
+- Link, and make it obvious that date format is ISO 8601.
+
+### Changed
+
+- Clarified the section on "Is there a standard change log format?".
+
+### Fixed
+
+- Fix Markdown links to tag comparison URL with footnote-style links.
+
+## [0.0.6] - 2014-12-12 [YANKED]
+
+### Added
+
+- README section on "yanked" releases.
+
+## [0.0.5] - 2014-08-09
+
+### Added
+
+- Markdown links to version tags on release headings.
+- Unreleased section to gather unreleased changes and encourage note keeping
+  prior to releases.
+
+## [0.0.4] - 2014-08-09
+
+### Added
+
+- Better explanation of the difference between the file ("CHANGELOG") and its
+  function "the change log".
+
+### Changed
+
+- Refer to a "change log" instead of a "CHANGELOG" throughout the site to
+  differentiate between the file and the purpose of the file — the logging of
+  changes.
+
+### Removed
+
+- Remove empty sections from CHANGELOG, they occupy too much space and create
+  too much noise in the file. People will have to assume that the missing
+  sections were intentionally left out because they contained no notable
+  changes.
+
+## [0.0.3] - 2014-08-09
+
+### Added
+
+- "Why should I care?" section mentioning The Changelog podcast.
+
+## [0.0.2] - 2014-07-10
+
+### Added
+
+- Explanation of the recommended reverse chronological release ordering.
+
+## [0.0.1] - 2014-05-31
+
+### Added
+
+- This CHANGELOG file to hopefully serve as an evolving example of a
+  standardized open source project CHANGELOG.
+- CNAME file to enable GitHub Pages custom domain
+- README now contains answers to common questions about CHANGELOGs
+- Good examples and basic guidelines, including proper date formatting.
+- Counter-examples: "What makes unicorns cry?"
+
+[#1]: https://github.com/olivierlacan/keep-a-changelog/issues/1
+[#2]: https://github.com/olivierlacan/keep-a-changelog/issues/2
+[#3]: https://github.com/olivierlacan/keep-a-changelog/issues/3
+[#4]: https://github.com/olivierlacan/keep-a-changelog/issues/4
+[#10]: https://github.com/olivierlacan/keep-a-changelog/issues/10
+
+[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
+[2.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0
+[0.3.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.8...v0.1.0
+[0.0.8]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.7...v0.0.8
+[0.0.7]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.6...v0.0.7
+[0.0.6]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.5...v0.0.6
+[0.0.5]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.4...v0.0.5
+[0.0.4]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.3...v0.0.4
+[0.0.3]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.2...v0.0.3
+[0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2
+[0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1
+
+---
+
+This is a footer

package/{umd → script}/test/changelog.expected.md

@@ -1,16 +1,18 @@
 # 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).
 
-## [Unreleased]
+## [Unreleased] [YANKED]
+This is a brand new releases with:
+- Configuration is now done within the Web client, for authorized users.
+
 ### Added
 - Test
 
-## [2.0.0] - Unreleased
+## [2.0.0] - Unreleased [YANKED]
 ### Added
 - None
 - Test with issue link [#1]
@@ -100,7 +102,7 @@ and this project adheres to
 ### Fixed
 - Fix Markdown links to tag comparison URL with footnote-style links.
 
-## [0.0.6] - 2014-12-12
+## [0.0.6] - 2014-12-12 [YANKED]
 ### Added
 - README section on "yanked" releases.
 

package/{umd → script}/test/changelog.md

@@ -6,13 +6,17 @@ 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).
 
-## [Unreleased]
+## [Unreleased] [Yanked]
+This is a brand new releases with:
+
+
+- Configuration is now done within the Web client, for authorized users.
 
 ### Added
 
 - Test
 
-## [2.0.0] - unreleased
+## [2.0.0] - unreleased [Yanked]
 
 ### Added
 
@@ -122,7 +126,7 @@ and this project adheres to
 
 - Fix Markdown links to tag comparison URL with footnote-style links.
 
-## [0.0.6] - 2014-12-12
+## [0.0.6] - 2014-12-12 [YANKED]
 
 ### Added
 

package/{umd → script}/test/empty.expected.md

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