keep-a-changelog 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -7,6 +7,13 @@ 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.
@@ -21,6 +28,8 @@ New version merging Deno and Node code using Deno's `dnt` package.
 
 [#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/bin.js

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
+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 { 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.120.0/flags/mod.js";
-import { parse as parseIni } from "./deps/deno_land/x/ini_v2.1.0/mod.js";
+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",
@@ -22,7 +23,7 @@ try {
         dntShim.Deno.exit(0);
     }
     const changelog = parser(dntShim.Deno.readTextFileSync(file));
-    if (argv['latest-release']) {
+    if (argv["latest-release"]) {
         const release = changelog.releases.find((release) => release.date && release.version);
         if (release) {
             console.log(release.version?.toString());

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

@@ -1,3 +1,5 @@
+// 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

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

@@ -1,3 +1,6 @@
+// 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";

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

@@ -1,3 +1,6 @@
+// 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";

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

@@ -1,5 +1,5 @@
 import * as dntShim from "../../../../_dnt.shims.js";
-import * as eol from '../../std_0.51.0/fs/eol.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;

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`);

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
 

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.1",
+  "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/shim-deno": "~0.1.1"
+    "@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;
+        },
+    });
+}

package/script/bin.js

@@ -0,0 +1,140 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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_2 = require("./mod.js");
+const mod_js_3 = require("./deps/deno.land/std@0.120.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",
+        release: null,
+        url: null,
+        https: true,
+        quiet: false,
+    },
+    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"));
+        save(file, changelog, true);
+        dntShim.Deno.exit(0);
+    }
+    const changelog = (0, mod_js_2.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());
+        }
+        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 (!changelog.url) {
+        if (argv.url) {
+            changelog.url = argv.url;
+        }
+        else {
+            const url = getRemoteUrl(argv.https);
+            if (url) {
+                changelog.url = url;
+            }
+            else {
+                console.error(red('Please, set the repository url with --url="https://github.com/username/repository"'));
+                dntShim.Deno.exit(1);
+            }
+        }
+    }
+    save(file, changelog);
+}
+catch (err) {
+    console.error(red(err.message));
+    if (!argv.quiet) {
+        dntShim.Deno.exit(1);
+    }
+}
+function save(file, changelog, isNew = false) {
+    const url = changelog.url;
+    if (url && url.includes("gitlab.com")) {
+        changelog.head = "master";
+    }
+    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 getRemoteUrl(https = true) {
+    try {
+        const file = (0, mod_js_1.join)(dntShim.Deno.cwd(), ".git", "config");
+        const content = dntShim.Deno.readTextFileSync(file);
+        const data = (0, mod_js_4.parse)(content);
+        const url = data?.['remote "origin"']?.url;
+        if (!url) {
+            return;
+        }
+        const remoteUrl = new URL(url.replace(/^git@([^:]+):(.*)\.git$/, "https://$1/$2"));
+        if (https) {
+            remoteUrl.protocol = "https:";
+        }
+        return remoteUrl.href;
+    }
+    catch (err) {
+        console.error(red(err.message));
+        // Ignore
+    }
+}

package/script/deps/deno.land/std@0.120.0/_util/assert.js

@@ -0,0 +1,18 @@
+"use strict";
+// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assert = exports.DenoStdInternalError = void 0;
+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;

package/script/deps/deno.land/std@0.120.0/_util/os.js

@@ -0,0 +1,43 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, 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.
+// This module is browser compatible.
+const dntShim = __importStar(require("../../../../_dnt.shims.js"));
+exports.osType = (() => {
+    // deno-lint-ignore no-explicit-any
+    const { Deno } = dntShim.dntGlobalThis;
+    if (typeof Deno?.build?.os === "string") {
+        return Deno.build.os;
+    }
+    // deno-lint-ignore no-explicit-any
+    const { navigator } = dntShim.dntGlobalThis;
+    if (navigator?.appVersion?.includes?.("Win") ?? false) {
+        return "windows";
+    }
+    return "linux";
+})();
+exports.isWindows = exports.osType === "windows";