keep-a-changelog 2.4.1 → 2.5.0

package/CHANGELOG.md

@@ -1,16 +1,26 @@
-<!-- deno-fmt-ignore-file -->
-
 # Changelog
 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/).
 
-## [3.4.1] - 2023-10-10
+## [2.5.0] - 2023-11-07
+### Added
+- Automatic detection of github and gitlab urls and build the links accordingly [#35]
+- New option --head to set the HEAD name [#37]
+
+### Changed
+- Deprecated function `compareLinkBuilder`, use `tagLinkBuilder` instead
+
+### Fixed
+- Trailing slash of the remote url is now removed [#36]
+- Updated dependencies
+
+## [2.4.1] - 2023-10-10
 ### Fixed
 - Breaking changes after updating `semver` package
 
-## [3.4.0] - 2023-10-10
+## [2.4.0] - 2023-10-10
 ### Added
 - New function `compareLinkBuilder` [#33].
 
@@ -65,9 +75,13 @@ New version merging Deno and Node code using Deno's `dnt` package.
 [#30]: https://github.com/oscarotero/keep-a-changelog/issues/30
 [#31]: https://github.com/oscarotero/keep-a-changelog/issues/31
 [#33]: https://github.com/oscarotero/keep-a-changelog/issues/33
+[#35]: https://github.com/oscarotero/keep-a-changelog/issues/35
+[#36]: https://github.com/oscarotero/keep-a-changelog/issues/36
+[#37]: https://github.com/oscarotero/keep-a-changelog/issues/37
 
-[3.4.1]: https://github.com/oscarotero/keep-a-changelog/compare/v3.4.0...v3.4.1
-[3.4.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.3.0...v3.4.0
+[2.5.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.4.1...v2.5.0
+[2.4.1]: https://github.com/oscarotero/keep-a-changelog/compare/v2.4.0...v2.4.1
+[2.4.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.3.0...v2.4.0
 [2.3.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.2.1...v2.3.0
 [2.2.1]: https://github.com/oscarotero/keep-a-changelog/compare/v2.2.0...v2.2.1
 [2.2.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.1.0...v2.2.0

package/README.md

@@ -139,7 +139,7 @@ It reads the CHANGELOG.md file and override it with the new format:
 Deno:
 
 ```sh
-deno install --allow-read --allow-write --name changelog https://deno.land/x/changelog/bin.ts
+deno install --allow-read --allow-write -fr --name changelog https://deno.land/x/changelog/bin.ts
 ```
 
 Node:
@@ -182,7 +182,7 @@ And return the latest released version:
 
 ```sh
 changelog --latest-release
-> 0.3.1
+> 2.0.0
 ```
 
 Available options:
@@ -198,3 +198,4 @@ Available options:
 | `--release`        | Updated the latest unreleased version with the current date. Use `--release=X.Y.Z` to set a number if the version doesn't have it.                                                                             |
 | `--create`         | Create a new Unreleased version. Use `--create=X.Y.Z` to specify a version number or just `--create` for a version without number.                                                                             |
 | `--quiet`          | Do not output error messages                                                                                                                                                                                   |
+| `--head`           | Customize the `head` reference                                                                                                                                                                                 |

package/esm/bin.js

@@ -5,6 +5,7 @@ import { join } from "./deps/deno.land/std@0.189.0/path/mod.js";
 import { Changelog, parser, Release } from "./mod.js";
 import { parse as parseFlag } from "./deps/deno.land/std@0.189.0/flags/mod.js";
 import { parse as parseIni } from "./deps/deno.land/x/ini@v2.1.0/mod.js";
+import getSettingsForURL from "./src/settings.js";
 const argv = parseFlag(dntShim.Deno.args, {
     default: {
         file: "CHANGELOG.md",
@@ -14,8 +15,9 @@ const argv = parseFlag(dntShim.Deno.args, {
         url: null,
         https: true,
         quiet: false,
+        head: null,
     },
-    string: ["file", "format", "url"],
+    string: ["file", "format", "url", "head"],
     boolean: ["https", "init", "latest-release", "quiet"],
 });
 const file = join(dntShim.Deno.cwd(), argv.file);
@@ -60,21 +62,6 @@ try {
         const version = typeof argv.create === "string" ? argv.create : undefined;
         changelog.addRelease(new Release(version));
     }
-    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) {
@@ -84,9 +71,20 @@ catch (err) {
     }
 }
 function save(file, changelog, isNew = false) {
-    const url = changelog.url;
-    if (url && url.includes("gitlab.com")) {
-        changelog.head = "master";
+    changelog.url = argv.url || changelog.url || getRemoteUrl(argv.https);
+    if (!changelog.url) {
+        console.error(red('Please, set the repository url with --url="https://github.com/username/repository"'));
+        changelog.url = "https://example.com";
+    }
+    if (changelog.url) {
+        const settings = getSettingsForURL(changelog.url);
+        if (settings) {
+            changelog.head = settings.head;
+            changelog.tagLinkBuilder = settings.tagLink;
+        }
+    }
+    if (argv.head) {
+        changelog.head = argv.head;
     }
     dntShim.Deno.writeTextFileSync(file, changelog.toString());
     if (isNew) {
@@ -115,7 +113,8 @@ function getRemoteUrl(https = true) {
         if (https) {
             remoteUrl.protocol = "https:";
         }
-        return remoteUrl.href;
+        // remove trailing slashes
+        return remoteUrl.href.replace(/\/+$/, "");
     }
     catch (err) {
         console.error(red(err.message));

package/esm/src/Changelog.d.ts

@@ -9,7 +9,9 @@ export default class Changelog {
     url?: string;
     releases: Release[];
     tagNameBuilder?: (release: Release) => string;
+    /** @deprecated: Use tagLinkBuilder() instead */
     compareLinkBuilder?: (previous: Release, release: Release) => string;
+    tagLinkBuilder?: (url: string, tag: string, previous?: string) => string;
     format: "compact" | "markdownlint";
     constructor(title: string, description?: string);
     addRelease(release: Release): this;

package/esm/src/Changelog.js

@@ -49,12 +49,19 @@ export default class Changelog {
             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,
@@ -86,6 +93,16 @@ export default class Changelog {
         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)}`;
         }

package/esm/src/deps.d.ts

@@ -1,2 +1,2 @@
-export { compare, eq, format, parse, } from "../deps/deno.land/std@0.203.0/semver/mod.js";
-export type { SemVer } from "../deps/deno.land/std@0.203.0/semver/mod.js";
+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/esm/src/deps.js

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

package/esm/src/settings.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 {};

package/esm/src/settings.js

@@ -0,0 +1,47 @@
+/**
+ * Temporary URLPattern shim
+ * @see https://github.com/denoland/dnt/issues/336
+ */
+class URLPatternShim {
+    constructor(pattern) {
+        Object.defineProperty(this, "pattern", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        if (typeof pattern === "string") {
+            pattern = pattern.replace(/\*/g, ".*");
+            pattern = new RegExp(`^${pattern}$`);
+        }
+        this.pattern = pattern;
+    }
+    test(url) {
+        return this.pattern.test(url);
+    }
+}
+export default function getSettingsForURL(url) {
+    return settings.find((settings) => settings.pattern.test(url));
+}
+export const settings = [
+    {
+        pattern: new URLPatternShim("https://github.com/*"),
+        head: "HEAD",
+        tagLink(url, tag, previous) {
+            if (!previous) {
+                return `${url}/releases/tag/${tag}`;
+            }
+            return `${url}/compare/${previous}...${tag}`;
+        },
+    },
+    {
+        pattern: new URLPatternShim("https://gitlab.*/*"),
+        head: "master",
+        tagLink(url, tag, previous) {
+            if (!previous) {
+                return `${url}/-/tags/${tag}`;
+            }
+            return `${url}/-/compare/${previous}...${tag}`;
+        },
+    },
+];

package/package.json

@@ -5,7 +5,7 @@
     "changelog": "./esm/bin.js"
   },
   "name": "keep-a-changelog",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "description": "Node package to parse and generate changelogs following the [keepachangelog](https://keepachangelog.com/) format.",
   "homepage": "https://github.com/oscarotero/keep-a-changelog#readme",
   "license": "MIT",

package/script/bin.js

@@ -23,6 +23,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 require("./_dnt.polyfills.js");
 const dntShim = __importStar(require("./_dnt.shims.js"));
@@ -30,6 +33,7 @@ const mod_js_1 = require("./deps/deno.land/std@0.189.0/path/mod.js");
 const mod_js_2 = require("./mod.js");
 const mod_js_3 = require("./deps/deno.land/std@0.189.0/flags/mod.js");
 const mod_js_4 = require("./deps/deno.land/x/ini@v2.1.0/mod.js");
+const settings_js_1 = __importDefault(require("./src/settings.js"));
 const argv = (0, mod_js_3.parse)(dntShim.Deno.args, {
     default: {
         file: "CHANGELOG.md",
@@ -39,8 +43,9 @@ const argv = (0, mod_js_3.parse)(dntShim.Deno.args, {
         url: null,
         https: true,
         quiet: false,
+        head: null,
     },
-    string: ["file", "format", "url"],
+    string: ["file", "format", "url", "head"],
     boolean: ["https", "init", "latest-release", "quiet"],
 });
 const file = (0, mod_js_1.join)(dntShim.Deno.cwd(), argv.file);
@@ -85,21 +90,6 @@ try {
         const version = typeof argv.create === "string" ? argv.create : undefined;
         changelog.addRelease(new mod_js_2.Release(version));
     }
-    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) {
@@ -109,9 +99,20 @@ catch (err) {
     }
 }
 function save(file, changelog, isNew = false) {
-    const url = changelog.url;
-    if (url && url.includes("gitlab.com")) {
-        changelog.head = "master";
+    changelog.url = argv.url || changelog.url || getRemoteUrl(argv.https);
+    if (!changelog.url) {
+        console.error(red('Please, set the repository url with --url="https://github.com/username/repository"'));
+        changelog.url = "https://example.com";
+    }
+    if (changelog.url) {
+        const settings = (0, settings_js_1.default)(changelog.url);
+        if (settings) {
+            changelog.head = settings.head;
+            changelog.tagLinkBuilder = settings.tagLink;
+        }
+    }
+    if (argv.head) {
+        changelog.head = argv.head;
     }
     dntShim.Deno.writeTextFileSync(file, changelog.toString());
     if (isNew) {
@@ -140,7 +141,8 @@ function getRemoteUrl(https = true) {
         if (https) {
             remoteUrl.protocol = "https:";
         }
-        return remoteUrl.href;
+        // remove trailing slashes
+        return remoteUrl.href.replace(/\/+$/, "");
     }
     catch (err) {
         console.error(red(err.message));

package/script/src/Changelog.d.ts

@@ -9,7 +9,9 @@ export default class Changelog {
     url?: string;
     releases: Release[];
     tagNameBuilder?: (release: Release) => string;
+    /** @deprecated: Use tagLinkBuilder() instead */
     compareLinkBuilder?: (previous: Release, release: Release) => string;
+    tagLinkBuilder?: (url: string, tag: string, previous?: string) => string;
     format: "compact" | "markdownlint";
     constructor(title: string, description?: string);
     addRelease(release: Release): this;

package/script/src/Changelog.js

@@ -51,12 +51,19 @@ class Changelog {
             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,
@@ -88,6 +95,16 @@ class Changelog {
         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)}`;
         }

package/script/src/deps.d.ts

@@ -1,2 +1,2 @@
-export { compare, eq, format, parse, } from "../deps/deno.land/std@0.203.0/semver/mod.js";
-export type { SemVer } from "../deps/deno.land/std@0.203.0/semver/mod.js";
+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,7 +1,7 @@
 "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.203.0/semver/mod.js");
+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; } });

package/script/src/settings.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 {};

package/script/src/settings.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.settings = void 0;
+/**
+ * Temporary URLPattern shim
+ * @see https://github.com/denoland/dnt/issues/336
+ */
+class URLPatternShim {
+    constructor(pattern) {
+        Object.defineProperty(this, "pattern", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        if (typeof pattern === "string") {
+            pattern = pattern.replace(/\*/g, ".*");
+            pattern = new RegExp(`^${pattern}$`);
+        }
+        this.pattern = pattern;
+    }
+    test(url) {
+        return this.pattern.test(url);
+    }
+}
+function getSettingsForURL(url) {
+    return exports.settings.find((settings) => settings.pattern.test(url));
+}
+exports.default = getSettingsForURL;
+exports.settings = [
+    {
+        pattern: new URLPatternShim("https://github.com/*"),
+        head: "HEAD",
+        tagLink(url, tag, previous) {
+            if (!previous) {
+                return `${url}/releases/tag/${tag}`;
+            }
+            return `${url}/compare/${previous}...${tag}`;
+        },
+    },
+    {
+        pattern: new URLPatternShim("https://gitlab.*/*"),
+        head: "master",
+        tagLink(url, tag, previous) {
+            if (!previous) {
+                return `${url}/-/tags/${tag}`;
+            }
+            return `${url}/-/compare/${previous}...${tag}`;
+        },
+    },
+];