keep-a-changelog 2.0.0-beta → 2.1.0

package/CHANGELOG.md

@@ -7,7 +7,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.1.0] - 2022-04-03
+### Added
+- Support for `[YANKED]` releases [#25]
+
+### Fixed
+- Updated dependencies
+
+## [2.0.1] - 2022-01-09
+### Fixed
+- Updated deps.
+- `release` and `latest-release` args [#23].
+
 ## [2.0.0] - 2021-12-08
-New version merging Deno and Node code. There are no changes.
+New version merging Deno and Node code using Deno's `dnt` package.
+
+### Changed
+- Code converted to TypeScript.
+- Added the link of the first version [#21].
+
+[#21]: https://github.com/oscarotero/keep-a-changelog/issues/21
+[#23]: https://github.com/oscarotero/keep-a-changelog/issues/23
+[#25]: https://github.com/oscarotero/keep-a-changelog/issues/25
 
+[2.1.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.0.1...v2.1.0
+[2.0.1]: https://github.com/oscarotero/keep-a-changelog/compare/v2.0.0...v2.0.1
 [2.0.0]: https://github.com/oscarotero/keep-a-changelog/releases/tag/v2.0.0

package/README.md

@@ -22,7 +22,7 @@ console.log(changelog.toString());
 ## Usage in Deno
 
 ```js
-import { parser } from "https://deno.land/x/changelog@2.0.0/mod.ts";
+import { parser } from "https://deno.land/x/changelog@v2.0.0/mod.ts";
 
 //Parse a changelog file
 const changelog = parser(await Deno.readTextFile("CHANGELOG.md"));
@@ -34,7 +34,10 @@ console.log(changelog.toString());
 ### Create a new changelog
 
 ```js
-import { Changelog, Release } from "https://deno.land/x/changelog@2.0.0/mod.ts";
+import {
+  Changelog,
+  Release,
+} from "https://deno.land/x/changelog@v2.0.0/mod.ts";
 
 const changelog = new Changelog("My project")
   .addRelease(

package/esm/_dnt.polyfills.js

@@ -0,0 +1,15 @@
+// https://github.com/tc39/proposal-accessible-object-hasownproperty/blob/main/polyfill.js
+if (!Object.hasOwn) {
+    Object.defineProperty(Object, "hasOwn", {
+        value: function (object, property) {
+            if (object == null) {
+                throw new TypeError("Cannot convert undefined or null to object");
+            }
+            return Object.prototype.hasOwnProperty.call(Object(object), property);
+        },
+        configurable: true,
+        enumerable: false,
+        writable: true,
+    });
+}
+export {};

package/esm/_dnt.shims.js

@@ -0,0 +1,62 @@
+import { Deno } from "@deno/shim-deno";
+export { Deno } from "@deno/shim-deno";
+const dntGlobals = {
+    Deno,
+};
+export const dntGlobalThis = createMergeProxy(globalThis, dntGlobals);
+// deno-lint-ignore ban-types
+function createMergeProxy(baseObj, extObj) {
+    return new Proxy(baseObj, {
+        get(_target, prop, _receiver) {
+            if (prop in extObj) {
+                return extObj[prop];
+            }
+            else {
+                return baseObj[prop];
+            }
+        },
+        set(_target, prop, value) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            baseObj[prop] = value;
+            return true;
+        },
+        deleteProperty(_target, prop) {
+            let success = false;
+            if (prop in extObj) {
+                delete extObj[prop];
+                success = true;
+            }
+            if (prop in baseObj) {
+                delete baseObj[prop];
+                success = true;
+            }
+            return success;
+        },
+        ownKeys(_target) {
+            const baseKeys = Reflect.ownKeys(baseObj);
+            const extKeys = Reflect.ownKeys(extObj);
+            const extKeysSet = new Set(extKeys);
+            return [...baseKeys.filter((k) => !extKeysSet.has(k)), ...extKeys];
+        },
+        defineProperty(_target, prop, desc) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            Reflect.defineProperty(baseObj, prop, desc);
+            return true;
+        },
+        getOwnPropertyDescriptor(_target, prop) {
+            if (prop in extObj) {
+                return Reflect.getOwnPropertyDescriptor(extObj, prop);
+            }
+            else {
+                return Reflect.getOwnPropertyDescriptor(baseObj, prop);
+            }
+        },
+        has(_target, prop) {
+            return prop in extObj || prop in baseObj;
+        },
+    });
+}

package/esm/bin.js

@@ -1,32 +1,34 @@
 #!/usr/bin/env node
-import * as denoShim from "deno.ns";
-import { join } from "./deps/deno_land/std_0.113.0/path/mod.js";
+import "./_dnt.polyfills.js";
+import * as dntShim from "./_dnt.shims.js";
+import { join } from "./deps/deno.land/std@0.120.0/path/mod.js";
 import { Changelog, parser, Release } from "./mod.js";
-import { parse as parseFlag } from "./deps/deno_land/std_0.113.0/flags/mod.js";
-import { parse as parseIni } from "./deps/deno_land/x/ini_v2.1.0/mod.js";
-const argv = parseFlag(denoShim.Deno.args, {
+import { parse as parseFlag } from "./deps/deno.land/std@0.120.0/flags/mod.js";
+import { parse as parseIni } from "./deps/deno.land/x/ini@v2.1.0/mod.js";
+const argv = parseFlag(dntShim.Deno.args, {
     default: {
         file: "CHANGELOG.md",
+        release: null,
         url: null,
         https: true,
         quiet: false,
     },
     boolean: ["https", "init", "latest-release", "quiet"],
 });
-const file = join(denoShim.Deno.cwd(), argv.file);
+const file = join(dntShim.Deno.cwd(), argv.file);
 try {
     if (argv.init) {
         const changelog = new Changelog("Changelog").addRelease(new Release("0.1.0", new Date(), "First version"));
         save(file, changelog, true);
-        denoShim.Deno.exit(0);
+        dntShim.Deno.exit(0);
     }
-    const changelog = parser(denoShim.Deno.readTextFileSync(file));
-    if (argv.latestRelease) {
+    const changelog = parser(dntShim.Deno.readTextFileSync(file));
+    if (argv["latest-release"]) {
         const release = changelog.releases.find((release) => release.date && release.version);
         if (release) {
             console.log(release.version?.toString());
         }
-        denoShim.Deno.exit(0);
+        dntShim.Deno.exit(0);
     }
     if (argv.release) {
         const release = changelog.releases.find((release) => {
@@ -46,7 +48,7 @@ try {
         }
         else {
             console.error("Not found any valid unreleased version");
-            denoShim.Deno.exit(1);
+            dntShim.Deno.exit(1);
         }
     }
     if (!changelog.url) {
@@ -60,7 +62,7 @@ try {
             }
             else {
                 console.error(red('Please, set the repository url with --url="https://github.com/username/repository"'));
-                denoShim.Deno.exit(1);
+                dntShim.Deno.exit(1);
             }
         }
     }
@@ -69,7 +71,7 @@ try {
 catch (err) {
     console.error(red(err.message));
     if (!argv.quiet) {
-        denoShim.Deno.exit(1);
+        dntShim.Deno.exit(1);
     }
 }
 function save(file, changelog, isNew = false) {
@@ -77,7 +79,7 @@ function save(file, changelog, isNew = false) {
     if (url && url.includes("gitlab.com")) {
         changelog.head = "master";
     }
-    denoShim.Deno.writeTextFileSync(file, changelog.toString());
+    dntShim.Deno.writeTextFileSync(file, changelog.toString());
     if (isNew) {
         console.log(green("Generated new file"), file);
     }
@@ -93,8 +95,8 @@ function green(message) {
 }
 function getRemoteUrl(https = true) {
     try {
-        const file = join(denoShim.Deno.cwd(), ".git", "config");
-        const content = denoShim.Deno.readTextFileSync(file);
+        const file = join(dntShim.Deno.cwd(), ".git", "config");
+        const content = dntShim.Deno.readTextFileSync(file);
         const data = parseIni(content);
         const url = data?.['remote "origin"']?.url;
         if (!url) {

package/esm/deps/{deno_land/std_0.113.0 → deno.land/std@0.120.0}/_util/os.js

@@ -1,12 +1,14 @@
-import * as denoShim from "deno.ns";
+// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
+// This module is browser compatible.
+import * as dntShim from "../../../../_dnt.shims.js";
 export const osType = (() => {
     // deno-lint-ignore no-explicit-any
-    const { Deno } = ({ ...denoShim, ...globalThis });
+    const { Deno } = dntShim.dntGlobalThis;
     if (typeof Deno?.build?.os === "string") {
         return Deno.build.os;
     }
     // deno-lint-ignore no-explicit-any
-    const { navigator } = ({ ...denoShim, ...globalThis });
+    const { navigator } = dntShim.dntGlobalThis;
     if (navigator?.appVersion?.includes?.("Win") ?? false) {
         return "windows";
     }

package/esm/deps/{deno_land/std_0.113.0 → deno.land/std@0.120.0}/path/glob.js

@@ -339,7 +339,7 @@ export function normalizeGlob(glob, { globstar = false } = {}) {
     return normalize(glob.replace(badParentPattern, "\0")).replace(/\0/g, "..");
 }
 /** Like join(), but doesn't collapse "**\/.." when `globstar` is true. */
-export function joinGlobs(globs, { extended = false, globstar = false } = {}) {
+export function joinGlobs(globs, { extended = true, globstar = false } = {}) {
     if (!globstar || globs.length == 0) {
         return join(...globs);
     }

package/esm/deps/{deno_land/std_0.113.0 → deno.land/std@0.120.0}/path/posix.js

@@ -1,4 +1,7 @@
-import * as denoShim from "deno.ns";
+// Copyright the Browserify authors. MIT License.
+// Ported from https://github.com/browserify/path-browserify/
+// This module is browser compatible.
+import * as dntShim from "../../../../_dnt.shims.js";
 import { CHAR_DOT, CHAR_FORWARD_SLASH } from "./_constants.js";
 import { _format, assertPath, encodeWhitespace, isPosixPathSeparator, normalizeString, } from "./_util.js";
 export const sep = "/";
@@ -17,7 +20,7 @@ export function resolve(...pathSegments) {
             path = pathSegments[i];
         else {
             // deno-lint-ignore no-explicit-any
-            const { Deno } = ({ ...denoShim, ...globalThis });
+            const { Deno } = dntShim.dntGlobalThis;
             if (typeof Deno?.cwd !== "function") {
                 throw new TypeError("Resolved a relative path without a CWD.");
             }

package/esm/deps/{deno_land/std_0.113.0 → deno.land/std@0.120.0}/path/win32.js

@@ -1,4 +1,7 @@
-import * as denoShim from "deno.ns";
+// Copyright the Browserify authors. MIT License.
+// Ported from https://github.com/browserify/path-browserify/
+// This module is browser compatible.
+import * as dntShim from "../../../../_dnt.shims.js";
 import { CHAR_BACKWARD_SLASH, CHAR_COLON, CHAR_DOT, CHAR_QUESTION_MARK, } from "./_constants.js";
 import { _format, assertPath, encodeWhitespace, isPathSeparator, isWindowsDeviceRoot, normalizeString, } from "./_util.js";
 import { assert } from "../_util/assert.js";
@@ -15,7 +18,7 @@ export function resolve(...pathSegments) {
     for (let i = pathSegments.length - 1; i >= -1; i--) {
         let path;
         // deno-lint-ignore no-explicit-any
-        const { Deno } = ({ ...denoShim, ...globalThis });
+        const { Deno } = dntShim.dntGlobalThis;
         if (i >= 0) {
             path = pathSegments[i];
         }

package/esm/deps/{deno_land/x/ini_v2.1.0 → deno.land/x/ini@v2.1.0}/ini.js

@@ -1,6 +1,6 @@
-import * as denoShim from "deno.ns";
-import * as eol from '../../std_0.51.0/fs/eol.js';
-const isWindows = denoShim.Deno.build.os == "windows";
+import * as dntShim from "../../../../_dnt.shims.js";
+import * as eol from '../../std@0.51.0/fs/eol.js';
+const isWindows = dntShim.Deno.build.os == "windows";
 const EOL = isWindows ? eol.EOL.CRLF : eol.EOL.LF;
 export const parse = decode;
 export const stringify = encode;

package/esm/mod.js

@@ -1,3 +1,4 @@
+import "./_dnt.polyfills.js";
 import parser from "./src/parser.js";
 import Change from "./src/Change.js";
 import Changelog from "./src/Changelog.js";

package/esm/src/Release.js

@@ -20,6 +20,12 @@ export default class Release {
             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,
@@ -115,20 +121,21 @@ export default class Release {
     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)}`);
+                t.push(`## [${this.version}] - ${formatDate(this.date)}${yanked}`);
             }
             else {
-                t.push(`## ${this.version} - ${formatDate(this.date)}`);
+                t.push(`## ${this.version} - ${formatDate(this.date)}${yanked}`);
             }
         }
         else {
             if (hasCompareLink) {
-                t.push("## [Unreleased]");
+                t.push(`## [Unreleased]${yanked}`);
             }
             else {
-                t.push("## Unreleased");
+                t.push(`## Unreleased${yanked}`);
             }
         }
         if (this.description.trim()) {

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/x/semver@v1.4.0/mod.js";

package/esm/src/parser.js

@@ -23,15 +23,18 @@ function processTokens(tokens, opts) {
     //Releases
     let release;
     while ((release = getContent(tokens, "h2").toLowerCase())) {
-        const matches = release.match(/\[?([^\]]+)\]?\s*-\s*([\d]{4}-[\d]{1,2}-[\d]{1,2})$/);
+        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$/);
+            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`);
@@ -82,7 +85,7 @@ function tokenize(markdown) {
     markdown
         .trim()
         .split("\n")
-        .map((line, index) => {
+        .map((line, index, allLines) => {
         const lineNumber = index + 1;
         if (line.startsWith("---")) {
             return [lineNumber, "hr", ["-"]];
@@ -105,6 +108,16 @@ function tokenize(markdown) {
         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()]];

package/esm/test/changelog.expected.md

@@ -6,11 +6,11 @@ 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]
 ### Added
 - Test
 
-## [2.0.0] - Unreleased
+## [2.0.0] - Unreleased [YANKED]
 ### Added
 - None
 - Test with issue link [#1]
@@ -100,7 +100,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/esm/test/changelog.md

@@ -6,13 +6,13 @@ 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]
 
 ### Added
 
 - Test
 
-## [2.0.0] - unreleased
+## [2.0.0] - unreleased [Yanked]
 
 ### Added
 
@@ -122,7 +122,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
 
@@ -179,9 +179,12 @@ and this project adheres to
 - Good examples and basic guidelines, including proper date formatting.
 - Counter-examples: "What makes unicorns cry?"
 
-[Unreleased]: 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
+[Unreleased]:
+  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

package/package.json

@@ -1,12 +1,12 @@
 {
   "module": "./esm/mod.js",
-  "main": "./umd/mod.js",
+  "main": "./script/mod.js",
   "types": "./types/mod.d.ts",
   "bin": {
     "changelog": "./esm/bin.js"
   },
   "name": "keep-a-changelog",
-  "version": "2.0.0-beta",
+  "version": "2.1.0",
   "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",
@@ -26,7 +26,7 @@
   "exports": {
     ".": {
       "import": "./esm/mod.js",
-      "require": "./umd/mod.js",
+      "require": "./script/mod.js",
       "types": "./types/mod.d.ts"
     }
   },
@@ -34,10 +34,10 @@
     "test": "node test_runner.js"
   },
   "dependencies": {
-    "deno.ns": "0.7.3"
+    "@deno/shim-deno": "~0.4.3"
   },
   "devDependencies": {
-    "@types/node": "16.11.1",
+    "@types/node": "16.11.26",
     "chalk": "4.1.2"
   }
-}
+}

package/script/_dnt.polyfills.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// https://github.com/tc39/proposal-accessible-object-hasownproperty/blob/main/polyfill.js
+if (!Object.hasOwn) {
+    Object.defineProperty(Object, "hasOwn", {
+        value: function (object, property) {
+            if (object == null) {
+                throw new TypeError("Cannot convert undefined or null to object");
+            }
+            return Object.prototype.hasOwnProperty.call(Object(object), property);
+        },
+        configurable: true,
+        enumerable: false,
+        writable: true,
+    });
+}

package/script/_dnt.shims.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dntGlobalThis = exports.Deno = void 0;
+const shim_deno_1 = require("@deno/shim-deno");
+var shim_deno_2 = require("@deno/shim-deno");
+Object.defineProperty(exports, "Deno", { enumerable: true, get: function () { return shim_deno_2.Deno; } });
+const dntGlobals = {
+    Deno: shim_deno_1.Deno,
+};
+exports.dntGlobalThis = createMergeProxy(globalThis, dntGlobals);
+// deno-lint-ignore ban-types
+function createMergeProxy(baseObj, extObj) {
+    return new Proxy(baseObj, {
+        get(_target, prop, _receiver) {
+            if (prop in extObj) {
+                return extObj[prop];
+            }
+            else {
+                return baseObj[prop];
+            }
+        },
+        set(_target, prop, value) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            baseObj[prop] = value;
+            return true;
+        },
+        deleteProperty(_target, prop) {
+            let success = false;
+            if (prop in extObj) {
+                delete extObj[prop];
+                success = true;
+            }
+            if (prop in baseObj) {
+                delete baseObj[prop];
+                success = true;
+            }
+            return success;
+        },
+        ownKeys(_target) {
+            const baseKeys = Reflect.ownKeys(baseObj);
+            const extKeys = Reflect.ownKeys(extObj);
+            const extKeysSet = new Set(extKeys);
+            return [...baseKeys.filter((k) => !extKeysSet.has(k)), ...extKeys];
+        },
+        defineProperty(_target, prop, desc) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            Reflect.defineProperty(baseObj, prop, desc);
+            return true;
+        },
+        getOwnPropertyDescriptor(_target, prop) {
+            if (prop in extObj) {
+                return Reflect.getOwnPropertyDescriptor(extObj, prop);
+            }
+            else {
+                return Reflect.getOwnPropertyDescriptor(baseObj, prop);
+            }
+        },
+        has(_target, prop) {
+            return prop in extObj || prop in baseObj;
+        },
+    });
+}