keep-a-changelog 2.5.3 → 2.6.0

package/CHANGELOG.md

@@ -4,6 +4,19 @@ 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/).
 
+## [2.6.0] - 2025-02-22
+### Added
+- New option `--no-v-prefix` to generate the tag names without prepending `v` [#43]
+- New option `--no-sort-releases` to disable sorting of releases [#51]
+- New option `--bullet-style` for customizing the bullet point character used in unordered lists [#48]
+- Add Azure DevOps URL support [#49]
+- New option `--combine` to combine changes with the same version [#50]
+- `--help, -h` flag [#45].
+
+### Fixed
+- Updated dependencies
+- Skip release creation if it already exists [#47]
+
 ## [2.5.3] - 2023-11-19
 ### Fixed
 - Improve URL normalization in CLI [#42]
@@ -93,7 +106,15 @@ New version merging Deno and Node code using Deno's `dnt` package.
 [#40]: https://github.com/oscarotero/keep-a-changelog/issues/40
 [#41]: https://github.com/oscarotero/keep-a-changelog/issues/41
 [#42]: https://github.com/oscarotero/keep-a-changelog/issues/42
-
+[#43]: https://github.com/oscarotero/keep-a-changelog/issues/43
+[#45]: https://github.com/oscarotero/keep-a-changelog/issues/45
+[#47]: https://github.com/oscarotero/keep-a-changelog/issues/47
+[#48]: https://github.com/oscarotero/keep-a-changelog/issues/48
+[#49]: https://github.com/oscarotero/keep-a-changelog/issues/49
+[#50]: https://github.com/oscarotero/keep-a-changelog/issues/50
+[#51]: https://github.com/oscarotero/keep-a-changelog/issues/51
+
+[2.6.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.5.3...v2.6.0
 [2.5.3]: https://github.com/oscarotero/keep-a-changelog/compare/v2.5.2...v2.5.3
 [2.5.2]: https://github.com/oscarotero/keep-a-changelog/compare/v2.5.1...v2.5.2
 [2.5.1]: https://github.com/oscarotero/keep-a-changelog/compare/v2.5.0...v2.5.1

package/README.md

@@ -67,6 +67,16 @@ const changelog = new Changelog();
 changelog.format = "markdownlint";
 ```
 
+### Custom bullet style
+
+By default, the bullet style of the markdown is "-". You can change it to use
+other styles of bullet points:
+
+```js
+const changelog = new Changelog();
+changelog.bulletStyle = "*";
+```
+
 ### Custom tag names
 
 By default, the tag names are `v` + version number. For example, the tag for the
@@ -185,17 +195,8 @@ changelog --latest-release
 > 2.0.0
 ```
 
-Available options:
-
-| Option             | Description                                                                                                                                                                                                    |
-| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `--format`         | The output format for the generated markdown. It can be `markdownlint` or `compact`. The default value is `compact`.                                                                                           |
-| `--file`           | The markdown file of the changelog. The default value is `CHANGELOG.md`.                                                                                                                                       |
-| `--url`            | The base url used to build the diff urls of the different releases. It is taken from the existing diff urls in the markdown. If no urls are found, try to catch it using the url of the git remote repository. |
-| `--https`          | Set to false to use `http` instead `https` in the url (`--https=false`).                                                                                                                                       |
-| `--init`           | Init a new empty changelog file.                                                                                                                                                                               |
-| `--latest-release` | Print the latest release version.                                                                                                                                                                              |
-| `--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                                                                                                                                                                                 |
+See available options:
+
+```sh
+changelog --help
+```

package/esm/keep-a-changelog/bin.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import "../_dnt.polyfills.js";

package/esm/{bin.js → keep-a-changelog/bin.js}

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
-import "./_dnt.polyfills.js";
-import * as dntShim from "./_dnt.shims.js";
-import { join } from "./deps/deno.land/std@0.189.0/path/mod.js";
+import "../_dnt.polyfills.js";
+import * as dntShim from "../_dnt.shims.js";
+import { join } from "../std/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 { parseArgs } from "../std/cli/parse_args.js";
+import { parse as parseIni } from "../std/ini/mod.js";
 import getSettingsForURL from "./src/settings.js";
-const argv = parseFlag(dntShim.Deno.args, {
+const argv = parseArgs(dntShim.Deno.args, {
     default: {
         file: "CHANGELOG.md",
         format: "compact",
@@ -16,20 +16,45 @@ const argv = parseFlag(dntShim.Deno.args, {
         https: true,
         quiet: false,
         head: null,
+        combine: false,
+        "bullet-style": "-",
+    },
+    string: ["file", "format", "url", "head", "bullet-style"],
+    boolean: [
+        "https",
+        "init",
+        "latest-release",
+        "quiet",
+        "help",
+        "combine",
+        "no-v-prefix",
+        "no-sort-releases",
+    ],
+    alias: {
+        h: "help",
     },
-    string: ["file", "format", "url", "head"],
-    boolean: ["https", "init", "latest-release", "quiet"],
 });
 const file = join(dntShim.Deno.cwd(), argv.file);
 try {
+    if (argv.help) {
+        showHelp();
+        dntShim.Deno.exit(0);
+    }
     if (argv.init) {
         const changelog = new Changelog("Changelog").addRelease(new Release("0.1.0", new Date(), "First version"));
         changelog.format = argv.format;
+        changelog.bulletStyle = argv["bullet-style"];
         save(file, changelog, true);
         dntShim.Deno.exit(0);
     }
-    const changelog = parser(dntShim.Deno.readTextFileSync(file));
+    const changelog = parser(dntShim.Deno.readTextFileSync(file), {
+        autoSortReleases: !argv["no-sort-releases"],
+    });
     changelog.format = argv.format;
+    changelog.bulletStyle = argv["bullet-style"];
+    if (argv["no-v-prefix"]) {
+        changelog.tagNameBuilder = (release) => String(release.version);
+    }
     if (argv["latest-release"]) {
         const release = changelog.releases.find((release) => release.date && release.version);
         if (release) {
@@ -58,9 +83,31 @@ try {
             dntShim.Deno.exit(1);
         }
     }
+    if (argv.combine) {
+        const combinedReleases = changelog.releases.reduce((acc, release) => {
+            if (release.version) {
+                if (acc[release.version]) {
+                    acc[release.version].combineChanges(release.changes);
+                }
+                else {
+                    acc[release.version] = release;
+                }
+            }
+            return acc;
+        }, {});
+        changelog.releases = Object.values(combinedReleases);
+    }
     if (argv.create) {
         const version = typeof argv.create === "string" ? argv.create : undefined;
-        changelog.addRelease(new Release(version));
+        const release = changelog.releases.find((release) => {
+            return release.version === version;
+        });
+        if (release) {
+            console.warn("Release already exists.");
+        }
+        else {
+            changelog.addRelease(new Release(version));
+        }
     }
     save(file, changelog);
 }
@@ -116,14 +163,39 @@ function getRemoteUrl(https = true) {
         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) {
+        const origin = data['remote "origin"'];
+        if (!origin?.url) {
             return;
         }
-        return normalizeUrl(url, https).href;
+        return normalizeUrl(origin.url, https).href;
     }
     catch (err) {
         console.error(red(err.message));
         // Ignore
     }
 }
+function showHelp() {
+    console.log(`keep-a-changelog
+
+Usage: keep-a-changelog [options]
+
+Options:
+  --file, -f          Changelog file (default: CHANGELOG.md)
+  --format            Output format (default: compact)
+  --bullet-style      Bullet point style (default: -)
+  --url               Repository URL
+
+  --init              Initialize a new changelog file
+  --latest-release    Print the latest release version
+
+  --release           Set the date of the specified release
+  --combine           Combine changes from releases with the same version
+  --create            Create a new release
+
+  --no-v-prefix       Do not add a "v" prefix to the version
+  --no-sort-releases  Do not sort releases
+  --head              Set the HEAD link
+  --quiet             Do not print errors
+  --help, -h          Show this help message
+`);
+}

package/esm/{mod.d.ts → keep-a-changelog/mod.d.ts}

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

package/esm/{mod.js → keep-a-changelog/mod.js}

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

package/esm/keep-a-changelog/test/changelog.azdo.md

@@ -0,0 +1,24 @@
+# Changelog - Azure DevOps demo
+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/).
+
+## [Unreleased]
+- This is a brand new releases with:
+
+## [0.0.2] - 2023-11-09
+### Added
+- I want to have a compare link
+
+## [0.0.1] - 2023-11-09
+### Added
+- This is just a test changelog
+
+[Unreleased]: https://dev.azure.com/myorg/myproject/_git/myrepo/branchCompare?baseVersion=GTv0.0.2&targetVersion=GBmaster
+[0.0.2]: https://dev.azure.com/myorg/myproject/_git/myrepo/branchCompare?baseVersion=GTv0.0.1&targetVersion=GTv0.0.2
+[0.0.1]: https://dev.azure.com/myorg/myproject/_git/myrepo?version=GTv0.0.1
+
+---
+
+This is a footer

package/esm/keep-a-changelog/test/changelog.sort.md

@@ -0,0 +1,17 @@
+# Changelog - gitlab demo
+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/).
+
+## [1.0.1] - 2025-01-05
+### Fixed
+- Bug fix
+
+## [2.0.0] - 2025-01-03
+### Added
+- New feature
+
+## [1.0.0] - 2025-01-01
+### Added
+- This is just a test changelog

package/esm/std/cli/parse_args.d.ts

@@ -0,0 +1,193 @@
+/** The value returned from {@linkcode parseArgs}. */
+export type Args<TArgs extends Record<string, unknown> = Record<string, any>, TDoubleDash extends boolean | undefined = undefined> = Id<TArgs & {
+    /** Contains all the arguments that didn't have an option associated with
+     * them. */
+    _: Array<string | number>;
+} & (boolean extends TDoubleDash ? DoubleDash : true extends TDoubleDash ? Required<DoubleDash> : Record<never, never>)>;
+/** Options for {@linkcode parseArgs}. */
+export interface ParseOptions<TBooleans extends BooleanType = BooleanType, TStrings extends StringType = StringType, TCollectable extends Collectable = Collectable, TNegatable extends Negatable = Negatable, TDefault extends Record<string, unknown> | undefined = Record<string, unknown> | undefined, TAliases extends Aliases | undefined = Aliases | undefined, TDoubleDash extends boolean | undefined = boolean | undefined> {
+    /**
+     * When `true`, populate the result `_` with everything before the `--` and
+     * the result `['--']` with everything after the `--`.
+     *
+     * @default {false}
+     *
+     * @example Double dash option is false
+     * ```ts
+     * // $ deno run example.ts -- a arg1
+     * import { parseArgs } from "parse_args.ts";
+     * const args = parseArgs(Deno.args, { "--": false }); // args equals { _: [ "a", "arg1" ] }
+     * ```
+     *
+     * @example Double dash option is true
+     * ```ts
+     * // $ deno run example.ts -- a arg1
+     * import { parseArgs } from "parse_args.ts";
+     * const args = parseArgs(Deno.args, { "--": true }); // args equals { _: [], --: [ "a", "arg1" ] }
+     * ```
+     */
+    "--"?: TDoubleDash;
+    /**
+     * An object mapping string names to strings or arrays of string argument
+     * names to use as aliases.
+     *
+     * @default {{}}
+     */
+    alias?: TAliases;
+    /**
+     * A boolean, string or array of strings to always treat as booleans. If
+     * `true` will treat all double hyphenated arguments without equal signs as
+     * `boolean` (e.g. affects `--foo`, not `-f` or `--foo=bar`).
+     *  All `boolean` arguments will be set to `false` by default.
+     *
+     * @default {false}
+     */
+    boolean?: TBooleans | ReadonlyArray<Extract<TBooleans, string>>;
+    /**
+     * An object mapping string argument names to default values.
+     *
+     * @default {{}}
+     */
+    default?: TDefault & Defaults<TBooleans, TStrings>;
+    /**
+     * When `true`, populate the result `_` with everything after the first
+     * non-option.
+     *
+     * @default {false}
+     */
+    stopEarly?: boolean;
+    /**
+     * A string or array of strings argument names to always treat as strings.
+     *
+     * @default {[]}
+     */
+    string?: TStrings | ReadonlyArray<Extract<TStrings, string>>;
+    /**
+     * A string or array of strings argument names to always treat as arrays.
+     * Collectable options can be used multiple times. All values will be
+     * collected into one array. If a non-collectable option is used multiple
+     * times, the last value is used.
+     *
+     * @default {[]}
+     */
+    collect?: TCollectable | ReadonlyArray<Extract<TCollectable, string>>;
+    /**
+     * A string or array of strings argument names which can be negated
+     * by prefixing them with `--no-`, like `--no-config`.
+     *
+     * @default {[]}
+     */
+    negatable?: TNegatable | ReadonlyArray<Extract<TNegatable, string>>;
+    /**
+     * A function which is invoked with a command line parameter not defined in
+     * the `options` configuration object. If the function returns `false`, the
+     * unknown option is not added to `parsedArgs`.
+     *
+     * @default {unknown}
+     */
+    unknown?: (arg: string, key?: string, value?: unknown) => unknown;
+}
+/**
+ * Take a set of command line arguments, optionally with a set of options, and
+ * return an object representing the flags found in the passed arguments.
+ *
+ * By default, any arguments starting with `-` or `--` are considered boolean
+ * flags. If the argument name is followed by an equal sign (`=`) it is
+ * considered a key-value pair. Any arguments which could not be parsed are
+ * available in the `_` property of the returned object.
+ *
+ * By default, this module tries to determine the type of all arguments
+ * automatically and the return type of this function will have an index
+ * signature with `any` as value (`{ [x: string]: any }`).
+ *
+ * If the `string`, `boolean` or `collect` option is set, the return value of
+ * this function will be fully typed and the index signature of the return
+ * type will change to `{ [x: string]: unknown }`.
+ *
+ * Any arguments after `'--'` will not be parsed and will end up in `parsedArgs._`.
+ *
+ * Numeric-looking arguments will be returned as numbers unless `options.string`
+ * or `options.boolean` is set for that argument name.
+ *
+ * See {@linkcode ParseOptions} for more information.
+ *
+ * @param args An array of command line arguments.
+ * @param options Options for the parse function.
+ *
+ * @typeParam TArgs Type of result.
+ * @typeParam TDoubleDash Used by `TArgs` for the result.
+ * @typeParam TBooleans Used by `TArgs` for the result.
+ * @typeParam TStrings Used by `TArgs` for the result.
+ * @typeParam TCollectable Used by `TArgs` for the result.
+ * @typeParam TNegatable Used by `TArgs` for the result.
+ * @typeParam TDefaults Used by `TArgs` for the result.
+ * @typeParam TAliases Used by `TArgs` for the result.
+ * @typeParam TAliasArgNames Used by `TArgs` for the result.
+ * @typeParam TAliasNames Used by `TArgs` for the result.
+ *
+ * @return The parsed arguments.
+ *
+ * @example Usage
+ * ```ts
+ * import { parseArgs } from "parse_args.ts";
+ * import { assertEquals } from "../assert/equals.ts";
+ *
+ * // For proper use, one should use `parseArgs(Deno.args)`
+ * assertEquals(parseArgs(["--foo", "--bar=baz", "./quux.txt"]), {
+ *   foo: true,
+ *   bar: "baz",
+ *   _: ["./quux.txt"],
+ * });
+ * ```
+ *
+ * @example `string` and `boolean` options
+ *
+ * Use `string` and `boolean` options to specify the type of the argument.
+ *
+ * ```ts
+ * import { parseArgs } from "parse_args.ts";
+ * import { assertEquals } from "../assert/equals.ts";
+ *
+ * const args = parseArgs(["--foo", "--bar", "baz"], {
+ *   boolean: ["foo"],
+ *   string: ["bar"],
+ * });
+ *
+ * assertEquals(args, { foo: true, bar: "baz", _: [] });
+ * ```
+ *
+ * @example `collect` option
+ *
+ * `collect` option tells the parser to treat the option as an array. All
+ * values will be collected into one array. If a non-collectable option is used
+ * multiple times, the last value is used.
+ *
+ * ```ts
+ * import { parseArgs } from "parse_args.ts";
+ * import { assertEquals } from "../assert/equals.ts";
+ *
+ * const args = parseArgs(["--foo", "bar", "--foo", "baz"], {
+ *  collect: ["foo"],
+ * });
+ *
+ * assertEquals(args, { foo: ["bar", "baz"], _: [] });
+ * ```
+ *
+ * @example `negatable` option
+ *
+ * `negatable` option tells the parser to treat the option can be negated by
+ * prefixing them with `--no-`, like `--no-config`.
+ *
+ * ```ts
+ * import { parseArgs } from "parse_args.ts";
+ * import { assertEquals } from "../assert/equals.ts";
+ *
+ * const args = parseArgs(["--no-foo"], {
+ *   boolean: ["foo"],
+ *   negatable: ["foo"],
+ * });
+ *
+ * assertEquals(args, { foo: false, _: [] });
+ * ```
+ */
+export declare function parseArgs<TArgs extends Values<TBooleans, TStrings, TCollectable, TNegatable, TDefaults, TAliases>, TDoubleDash extends boolean | undefined = undefined, TBooleans extends BooleanType = undefined, TStrings extends StringType = undefined, TCollectable extends Collectable = undefined, TNegatable extends Negatable = undefined, TDefaults extends Record<string, unknown> | undefined = undefined, TAliases extends Aliases<TAliasArgNames, TAliasNames> | undefined = undefined, TAliasArgNames extends string = string, TAliasNames extends string = string>(args: string[], options?: ParseOptions<TBooleans, TStrings, TCollectable, TNegatable, TDefaults, TAliases, TDoubleDash>): Args<TArgs, TDoubleDash>;