keep-a-changelog 2.1.0 → 2.2.1

package/esm/src/Change.js

@@ -1,4 +1,19 @@
 export default class Change {
+    static extractIssues(text, issues) {
+        return text
+            .replace(/(^|[^\\])\[#(\d+)\](?=[^\(]|$)/g, (_, start, index) => {
+            if (!issues.includes(index)) {
+                issues.push(index);
+            }
+            return `${start}[#${index}]`;
+        })
+            .replace(/(^|[\s,])#(\d+)(?=[\s,\.]|$)/g, (_, start, index) => {
+            if (!issues.includes(index)) {
+                issues.push(index);
+            }
+            return `${start}[#${index}]`;
+        });
+    }
     constructor(title, description = "") {
         Object.defineProperty(this, "title", {
             enumerable: true,
@@ -21,21 +36,6 @@ export default class Change {
         this.title = Change.extractIssues(title, this.issues);
         this.description = Change.extractIssues(description, this.issues);
     }
-    static extractIssues(text, issues) {
-        return text
-            .replace(/(^|[^\\])\[#(\d+)\](?=[^\(]|$)/g, (_, start, index) => {
-            if (!issues.includes(index)) {
-                issues.push(index);
-            }
-            return `${start}[#${index}]`;
-        })
-            .replace(/(^|[\s,])#(\d+)(?=[\s,\.]|$)/g, (_, start, index) => {
-            if (!issues.includes(index)) {
-                issues.push(index);
-            }
-            return `${start}[#${index}]`;
-        });
-    }
     toString() {
         let t = this.title.split("\n").map((line) => `  ${line}`.trimEnd());
         t[0] = "-" + t[0].substr(1);

package/esm/src/Changelog.js

@@ -49,6 +49,12 @@ export default class Changelog {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "format", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "compact"
+        });
         this.title = title;
         this.description = description;
     }
@@ -80,6 +86,9 @@ export default class Changelog {
             t.push("");
         }
         t.push(`# ${this.title}`);
+        if (this.format === "markdownlint") {
+            t.push("");
+        }
         const links = [];
         const compareLinks = [];
         const description = this.description.trim() ||
@@ -88,7 +97,6 @@ export default class Changelog {
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).`;
         if (description) {
-            t.push("");
             t.push(description);
         }
         this.releases.forEach((release) => {

package/esm/src/Release.js

@@ -90,6 +90,10 @@ export default class Release {
         }
         this.date = date;
     }
+    setYanked(yanked = true) {
+        this.yanked = yanked;
+        return this;
+    }
     addChange(type, change) {
         if (!(change instanceof Change)) {
             change = new Change(change);
@@ -138,6 +142,9 @@ export default class Release {
                 t.push(`## Unreleased${yanked}`);
             }
         }
+        if (changelog?.format === "markdownlint") {
+            t.push("");
+        }
         if (this.description.trim()) {
             t.push(this.description.trim());
             t.push("");
@@ -145,6 +152,9 @@ export default class Release {
         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("");
             }

package/esm/src/deps.js

@@ -1 +1 @@
-export { default as Semver, eq, } from "../deps/deno.land/x/semver@v1.4.0/mod.js";
+export { default as Semver, eq, } from "../deps/deno.land/std@0.173.0/semver/mod.js";

package/esm/src/parser.js

@@ -19,7 +19,7 @@ function processTokens(tokens, opts) {
     const changelog = new Changelog("");
     changelog.flag = getContent(tokens, "flag");
     changelog.title = getContent(tokens, "h1", true);
-    changelog.description = getContent(tokens, "p");
+    changelog.description = getTextContent(tokens);
     //Releases
     let release;
     while ((release = getContent(tokens, "h2").toLowerCase())) {
@@ -40,7 +40,7 @@ function processTokens(tokens, opts) {
             throw new Error(`Syntax error in the release title`);
         }
         changelog.addRelease(release);
-        release.description = getContent(tokens, "p");
+        release.description = getTextContent(tokens);
         let type;
         while ((type = getContent(tokens, "h3").toLowerCase())) {
             let change;
@@ -71,7 +71,8 @@ function processTokens(tokens, opts) {
 }
 /** Returns the content of a token */
 function getContent(tokens, type, required = false) {
-    if (!tokens[0] || tokens[0][1] !== type) {
+    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]}"`);
         }
@@ -79,6 +80,21 @@ function getContent(tokens, type, required = false) {
     }
     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 = [];

package/esm/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/esm/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/esm/test/changelog.expected.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/)
@@ -7,6 +6,9 @@ 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
 

package/esm/test/changelog.md

@@ -7,6 +7,10 @@ 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
 

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

package/package.json

@@ -6,7 +6,7 @@
     "changelog": "./esm/bin.js"
   },
   "name": "keep-a-changelog",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "Node package to parse and generate changelogs following the [keepachangelog](http://keepachangelog.com/en/1.0.0/) format.",
   "homepage": "https://github.com/oscarotero/keep-a-changelog#readme",
   "license": "MIT",
@@ -25,19 +25,24 @@
   },
   "exports": {
     ".": {
-      "import": "./esm/mod.js",
-      "require": "./script/mod.js",
-      "types": "./types/mod.d.ts"
+      "import": {
+        "types": "./types/mod.d.ts",
+        "default": "./esm/mod.js"
+      },
+      "require": {
+        "types": "./types/mod.d.ts",
+        "default": "./script/mod.js"
+      }
     }
   },
   "scripts": {
     "test": "node test_runner.js"
   },
   "dependencies": {
-    "@deno/shim-deno": "~0.4.3"
+    "@deno/shim-deno": "~0.12.0"
   },
   "devDependencies": {
-    "@types/node": "16.11.26",
-    "chalk": "4.1.2"
+    "@types/node": "^18.11.9",
+    "chalk": "^4.1.2"
   }
-}
+}

package/script/bin.js

@@ -26,28 +26,32 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 require("./_dnt.polyfills.js");
 const dntShim = __importStar(require("./_dnt.shims.js"));
-const mod_js_1 = require("./deps/deno.land/std@0.120.0/path/mod.js");
+const mod_js_1 = require("./deps/deno.land/std@0.173.0/path/mod.js");
 const mod_js_2 = require("./mod.js");
-const mod_js_3 = require("./deps/deno.land/std@0.120.0/flags/mod.js");
+const mod_js_3 = require("./deps/deno.land/std@0.173.0/flags/mod.js");
 const mod_js_4 = require("./deps/deno.land/x/ini@v2.1.0/mod.js");
 const argv = (0, mod_js_3.parse)(dntShim.Deno.args, {
     default: {
         file: "CHANGELOG.md",
+        format: "compact",
         release: null,
         url: null,
         https: true,
         quiet: false,
     },
+    string: ["file", "format", "release", "url"],
     boolean: ["https", "init", "latest-release", "quiet"],
 });
 const file = (0, mod_js_1.join)(dntShim.Deno.cwd(), argv.file);
 try {
     if (argv.init) {
         const changelog = new mod_js_2.Changelog("Changelog").addRelease(new mod_js_2.Release("0.1.0", new Date(), "First version"));
+        changelog.format = argv.format;
         save(file, changelog, true);
         dntShim.Deno.exit(0);
     }
     const changelog = (0, mod_js_2.parser)(dntShim.Deno.readTextFileSync(file));
+    changelog.format = argv.format;
     if (argv["latest-release"]) {
         const release = changelog.releases.find((release) => release.date && release.version);
         if (release) {

package/script/deps/deno.land/std@0.173.0/_util/asserts.js

@@ -0,0 +1,27 @@
+"use strict";
+// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unreachable = exports.assert = exports.DenoStdInternalError = void 0;
+/**
+ * All internal non-test code, that is files that do not have `test` or `bench` in the name, must use the assertion functions within `_utils/asserts.ts` and not `testing/asserts.ts`. This is to create a separation of concerns between internal and testing assertions.
+ */
+class DenoStdInternalError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "DenoStdInternalError";
+    }
+}
+exports.DenoStdInternalError = DenoStdInternalError;
+/** Make an assertion, if not `true`, then throw. */
+function assert(expr, msg = "") {
+    if (!expr) {
+        throw new DenoStdInternalError(msg);
+    }
+}
+exports.assert = assert;
+/** Use this to assert unreachable code. */
+function unreachable() {
+    throw new DenoStdInternalError("unreachable");
+}
+exports.unreachable = unreachable;

package/script/deps/deno.land/{std@0.120.0 → std@0.173.0}/_util/os.js

@@ -23,8 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isWindows = exports.osType = void 0;
-// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
+exports.isLinux = exports.isWindows = exports.osType = void 0;
+// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
 // This module is browser compatible.
 const dntShim = __importStar(require("../../../../_dnt.shims.js"));
 exports.osType = (() => {
@@ -35,9 +35,10 @@ exports.osType = (() => {
     }
     // deno-lint-ignore no-explicit-any
     const { navigator } = dntShim.dntGlobalThis;
-    if (navigator?.appVersion?.includes?.("Win") ?? false) {
+    if (navigator?.appVersion?.includes?.("Win")) {
         return "windows";
     }
     return "linux";
 })();
 exports.isWindows = exports.osType === "windows";
+exports.isLinux = exports.osType === "linux";