keep-a-changelog 2.5.2 → 2.6.0

package/{script/deps/deno.land/std@0.205.0 → esm/std}/semver/mod.d.ts

@@ -1,7 +1,37 @@
 /**
- * The semantic version parser.
+ * The Semantic Version parser.
  *
- * Adapted directly from [semver](https://github.com/npm/node-semver).
+ * Adapted directly from {@link https://github.com/npm/node-semver | semver}.
+ *
+ * ```ts
+ * import {
+ *   parse,
+ *   parseRange,
+ *   greaterThan,
+ *   lessThan,
+ *   format
+ * } from "mod.ts";
+ * import { assertEquals } from "../assert/mod.ts";
+ *
+ * const semver = parse("1.2.3");
+ * assertEquals(semver, {
+ *   major: 1,
+ *   minor: 2,
+ *   patch: 3,
+ *   prerelease: [],
+ *   build: []
+ * });
+ *
+ * assertEquals(format(semver), "1.2.3");
+ *
+ * const range = parseRange("1.x || >=2.5.0 || 5.0.0 - 7.2.3");
+ *
+ * const s0 = parse("1.2.3");
+ * const s1 = parse("9.8.7");
+ *
+ * assertEquals(greaterThan(s0, s1), false);
+ * assertEquals(lessThan(s0, s1), true);
+ * ```
  *
  * ## Versions
  *
@@ -17,28 +47,28 @@
  * formatting options.
  *
  * ```
- *           ┌───── full
- *       ┌───┴───┐
- *       ├───────── release
- *   ┌───┴───┐   │
- *   ├───────────── primary
- * ┌─┴─┐     │   │
- * 1.2.3-pre.1+b.1
- * │ │ │ └─┬─┘ └┬┘
- * │ │ │   │    └── build
- * │ │ │   └─────── pre
- * │ │ └─────────── patch
- * │ └───────────── minor
- * └─────────────── major
+ *           full
+ *        ┌───┴───┐
+ *     release    │
+ *    ┌───┴───┐   │
+ * primary    │   │
+ *  ┌─┴─┐     │   │
+ *  1.2.3-pre.1+b.1
+ *  │ │ │ └─┬─┘ └┬┘
+ *  │ │ │   │    └── build
+ *  │ │ │   └─────── pre
+ *  │ │ └─────────── patch
+ *  │ └───────────── minor
+ *  └─────────────── major
  * ```
  *
  * ## Ranges
  *
- * A `version range` is a set of `comparators` which specify versions that satisfy
- * the range.
+ * A version {@linkcode Range} is a set of {@linkcode Comparator}s which specify
+ * versions that satisfy the range.
  *
- * A `comparator` is composed of an `operator` and a `version`. The set of
- * primitive `operators` is:
+ * A {@linkcode Comparator} is composed of an {@linkcode Operator} and a
+ * {@link SemVer}. The set of primitive `operators` is:
  *
  * - `<` Less than
  * - `<=` Less than or equal to
@@ -87,27 +117,24 @@
  * aware of the risk. However, it is still not appropriate to assume that they have
  * opted into taking a similar risk on the _next_ set of prerelease versions.
  *
- * Note that this behavior can be suppressed (treating all prerelease versions as
- * if they were normal versions, for the purpose of range matching) by setting the
- * `includePrerelease` flag on the options object to any [functions](#functions)
- * that do range matching.
- *
  * #### Prerelease Identifiers
  *
- * The method `.increment` takes an additional `identifier` string argument that
- * will append the value of the string as a prerelease identifier:
+ * The method {@linkcode increment} takes an additional `identifier` string
+ * argument that will append the value of the string as a prerelease identifier:
  *
- * ```javascript
- * semver.increment(parse("1.2.3"), "prerelease", "beta");
- * // "1.2.4-beta.0"
+ * ```ts
+ * import { increment, parse } from "mod.ts";
+ * import { assertEquals } from "../assert/mod.ts";
+ *
+ * assertEquals(increment(parse("1.2.3"), "prerelease", { prerelease: "alpha" }), parse("1.2.4-alpha.0"));
  * ```
  *
  * ### Build Metadata
  *
  * Build metadata is `.` delimited alpha-numeric string.
  * When parsing a version it is retained on the `build: string[]` field
- * of the semver instance. When incrementing there is an additional parameter that
- * can set the build metadata on the semver instance.
+ * of the SemVer instance. When incrementing there is an additional parameter that
+ * can set the build metadata on the SemVer instance.
  *
  * ### Advanced Range Syntax
  *
@@ -241,70 +268,30 @@
  * If you want to know if a version satisfies or does not satisfy a range, use the
  * {@linkcode satisfies} function.
  *
- * This module is browser compatible.
- *
- * @example
- * ```ts
- * import {
- *   parse,
- *   parseComparator,
- *   parseRange,
- *   gt,
- *   lt,
- *   format
- * } from "https://deno.land/std@$STD_VERSION/semver/mod.ts";
- *
- * const semver = parse("1.2.3");
- * const range = parseRange("1.x || >=2.5.0 || 5.0.0 - 7.2.3");
- *
- * const s0 = parse("1.2.3");
- * const s1 = parse("9.8.7");
- * gt(s0, s1); // false
- * lt(s0, s1); // true
- *
- * format(semver) // "1.2.3"
- * ```
- *
  * @module
  */
-export * from "./cmp.js";
-export * from "./comparator_format.js";
-export * from "./comparator_intersects.js";
-export * from "./comparator_max.js";
-export * from "./comparator_min.js";
-export * from "./compare_build.js";
 export * from "./compare.js";
-export * from "./constants.js";
 export * from "./difference.js";
-export * from "./eq.js";
 export * from "./format.js";
-export * from "./gt.js";
-export * from "./gte.js";
-export * from "./gtr.js";
-export * from "./test_comparator.js";
-export * from "./test_range.js";
+export * from "./satisfies.js";
 export * from "./increment.js";
-export * from "./is_semver_comparator.js";
-export * from "./is_semver_range.js";
 export * from "./is_semver.js";
-export * from "./lt.js";
-export * from "./lte.js";
-export * from "./ltr.js";
 export * from "./max_satisfying.js";
 export * from "./min_satisfying.js";
-export * from "./neq.js";
-export * from "./outside.js";
-export * from "./parse_comparator.js";
 export * from "./parse_range.js";
 export * from "./parse.js";
-export * from "./range_format.js";
 export * from "./range_intersects.js";
-export * from "./range_max.js";
-export * from "./range_min.js";
-export * from "./rcompare.js";
-export * from "./rsort.js";
-export * from "./sort.js";
 export * from "./types.js";
-export * from "./lte.js";
-export * from "./lte.js";
-export declare const SEMVER_SPEC_VERSION = "2.0.0";
+export * from "./try_parse_range.js";
+export * from "./is_range.js";
+export * from "./can_parse.js";
+export * from "./try_parse.js";
+export * from "./format_range.js";
+export * from "./equals.js";
+export * from "./not_equals.js";
+export * from "./greater_than.js";
+export * from "./greater_than_range.js";
+export * from "./greater_or_equal.js";
+export * from "./less_than.js";
+export * from "./less_than_range.js";
+export * from "./less_or_equal.js";

package/esm/{deps/deno.land/std@0.205.0 → std}/semver/mod.js

@@ -1,10 +1,40 @@
 // Copyright Isaac Z. Schlueter and Contributors. All rights reserved. ISC license.
-// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 // This module is browser compatible.
 /**
- * The semantic version parser.
+ * The Semantic Version parser.
  *
- * Adapted directly from [semver](https://github.com/npm/node-semver).
+ * Adapted directly from {@link https://github.com/npm/node-semver | semver}.
+ *
+ * ```ts
+ * import {
+ *   parse,
+ *   parseRange,
+ *   greaterThan,
+ *   lessThan,
+ *   format
+ * } from "mod.ts";
+ * import { assertEquals } from "../assert/mod.ts";
+ *
+ * const semver = parse("1.2.3");
+ * assertEquals(semver, {
+ *   major: 1,
+ *   minor: 2,
+ *   patch: 3,
+ *   prerelease: [],
+ *   build: []
+ * });
+ *
+ * assertEquals(format(semver), "1.2.3");
+ *
+ * const range = parseRange("1.x || >=2.5.0 || 5.0.0 - 7.2.3");
+ *
+ * const s0 = parse("1.2.3");
+ * const s1 = parse("9.8.7");
+ *
+ * assertEquals(greaterThan(s0, s1), false);
+ * assertEquals(lessThan(s0, s1), true);
+ * ```
  *
  * ## Versions
  *
@@ -20,28 +50,28 @@
  * formatting options.
  *
  * ```
- *           ┌───── full
- *       ┌───┴───┐
- *       ├───────── release
- *   ┌───┴───┐   │
- *   ├───────────── primary
- * ┌─┴─┐     │   │
- * 1.2.3-pre.1+b.1
- * │ │ │ └─┬─┘ └┬┘
- * │ │ │   │    └── build
- * │ │ │   └─────── pre
- * │ │ └─────────── patch
- * │ └───────────── minor
- * └─────────────── major
+ *           full
+ *        ┌───┴───┐
+ *     release    │
+ *    ┌───┴───┐   │
+ * primary    │   │
+ *  ┌─┴─┐     │   │
+ *  1.2.3-pre.1+b.1
+ *  │ │ │ └─┬─┘ └┬┘
+ *  │ │ │   │    └── build
+ *  │ │ │   └─────── pre
+ *  │ │ └─────────── patch
+ *  │ └───────────── minor
+ *  └─────────────── major
  * ```
  *
  * ## Ranges
  *
- * A `version range` is a set of `comparators` which specify versions that satisfy
- * the range.
+ * A version {@linkcode Range} is a set of {@linkcode Comparator}s which specify
+ * versions that satisfy the range.
  *
- * A `comparator` is composed of an `operator` and a `version`. The set of
- * primitive `operators` is:
+ * A {@linkcode Comparator} is composed of an {@linkcode Operator} and a
+ * {@link SemVer}. The set of primitive `operators` is:
  *
  * - `<` Less than
  * - `<=` Less than or equal to
@@ -90,27 +120,24 @@
  * aware of the risk. However, it is still not appropriate to assume that they have
  * opted into taking a similar risk on the _next_ set of prerelease versions.
  *
- * Note that this behavior can be suppressed (treating all prerelease versions as
- * if they were normal versions, for the purpose of range matching) by setting the
- * `includePrerelease` flag on the options object to any [functions](#functions)
- * that do range matching.
- *
  * #### Prerelease Identifiers
  *
- * The method `.increment` takes an additional `identifier` string argument that
- * will append the value of the string as a prerelease identifier:
+ * The method {@linkcode increment} takes an additional `identifier` string
+ * argument that will append the value of the string as a prerelease identifier:
  *
- * ```javascript
- * semver.increment(parse("1.2.3"), "prerelease", "beta");
- * // "1.2.4-beta.0"
+ * ```ts
+ * import { increment, parse } from "mod.ts";
+ * import { assertEquals } from "../assert/mod.ts";
+ *
+ * assertEquals(increment(parse("1.2.3"), "prerelease", { prerelease: "alpha" }), parse("1.2.4-alpha.0"));
  * ```
  *
  * ### Build Metadata
  *
  * Build metadata is `.` delimited alpha-numeric string.
  * When parsing a version it is retained on the `build: string[]` field
- * of the semver instance. When incrementing there is an additional parameter that
- * can set the build metadata on the semver instance.
+ * of the SemVer instance. When incrementing there is an additional parameter that
+ * can set the build metadata on the SemVer instance.
  *
  * ### Advanced Range Syntax
  *
@@ -244,70 +271,30 @@
  * If you want to know if a version satisfies or does not satisfy a range, use the
  * {@linkcode satisfies} function.
  *
- * This module is browser compatible.
- *
- * @example
- * ```ts
- * import {
- *   parse,
- *   parseComparator,
- *   parseRange,
- *   gt,
- *   lt,
- *   format
- * } from "https://deno.land/std@$STD_VERSION/semver/mod.ts";
- *
- * const semver = parse("1.2.3");
- * const range = parseRange("1.x || >=2.5.0 || 5.0.0 - 7.2.3");
- *
- * const s0 = parse("1.2.3");
- * const s1 = parse("9.8.7");
- * gt(s0, s1); // false
- * lt(s0, s1); // true
- *
- * format(semver) // "1.2.3"
- * ```
- *
  * @module
  */
-export * from "./cmp.js";
-export * from "./comparator_format.js";
-export * from "./comparator_intersects.js";
-export * from "./comparator_max.js";
-export * from "./comparator_min.js";
-export * from "./compare_build.js";
 export * from "./compare.js";
-export * from "./constants.js";
 export * from "./difference.js";
-export * from "./eq.js";
 export * from "./format.js";
-export * from "./gt.js";
-export * from "./gte.js";
-export * from "./gtr.js";
-export * from "./test_comparator.js";
-export * from "./test_range.js";
+export * from "./satisfies.js";
 export * from "./increment.js";
-export * from "./is_semver_comparator.js";
-export * from "./is_semver_range.js";
 export * from "./is_semver.js";
-export * from "./lt.js";
-export * from "./lte.js";
-export * from "./ltr.js";
 export * from "./max_satisfying.js";
 export * from "./min_satisfying.js";
-export * from "./neq.js";
-export * from "./outside.js";
-export * from "./parse_comparator.js";
 export * from "./parse_range.js";
 export * from "./parse.js";
-export * from "./range_format.js";
 export * from "./range_intersects.js";
-export * from "./range_max.js";
-export * from "./range_min.js";
-export * from "./rcompare.js";
-export * from "./rsort.js";
-export * from "./sort.js";
 export * from "./types.js";
-export * from "./lte.js";
-export * from "./lte.js";
-export const SEMVER_SPEC_VERSION = "2.0.0";
+export * from "./try_parse_range.js";
+export * from "./is_range.js";
+export * from "./can_parse.js";
+export * from "./try_parse.js";
+export * from "./format_range.js";
+export * from "./equals.js";
+export * from "./not_equals.js";
+export * from "./greater_than.js";
+export * from "./greater_than_range.js";
+export * from "./greater_or_equal.js";
+export * from "./less_than.js";
+export * from "./less_than_range.js";
+export * from "./less_or_equal.js";

package/esm/std/semver/not_equals.d.ts

@@ -0,0 +1,23 @@
+import type { SemVer } from "./types.js";
+/**
+ * Not equal comparison for two SemVers.
+ *
+ * This is equal to `compare(version1, version2) !== 0`.
+ *
+ * @example Usage
+ * ```ts
+ * import { parse, notEquals } from "mod.ts";
+ * import { assert } from "../assert/mod.ts";
+ *
+ * const version1 = parse("1.2.3");
+ * const version2 = parse("1.2.4");
+ *
+ * assert(notEquals(version1, version2));
+ * assert(!notEquals(version1, version1));
+ * ```
+ *
+ * @param version1 The first version to compare
+ * @param version2 The second version to compare
+ * @returns `true` if `version1` is not equal to `version2`, `false` otherwise
+ */
+export declare function notEquals(version1: SemVer, version2: SemVer): boolean;

package/esm/std/semver/not_equals.js

@@ -0,0 +1,25 @@
+import { compare } from "./compare.js";
+/**
+ * Not equal comparison for two SemVers.
+ *
+ * This is equal to `compare(version1, version2) !== 0`.
+ *
+ * @example Usage
+ * ```ts
+ * import { parse, notEquals } from "mod.ts";
+ * import { assert } from "../assert/mod.ts";
+ *
+ * const version1 = parse("1.2.3");
+ * const version2 = parse("1.2.4");
+ *
+ * assert(notEquals(version1, version2));
+ * assert(!notEquals(version1, version1));
+ * ```
+ *
+ * @param version1 The first version to compare
+ * @param version2 The second version to compare
+ * @returns `true` if `version1` is not equal to `version2`, `false` otherwise
+ */
+export function notEquals(version1, version2) {
+    return compare(version1, version2) !== 0;
+}

package/esm/std/semver/parse.d.ts

@@ -0,0 +1,24 @@
+import type { SemVer } from "./types.js";
+/**
+ * Attempt to parse a string as a semantic version, returning a SemVer object.
+ *
+ * @example Usage
+ * ```ts
+ * import { parse } from "parse.ts";
+ * import { assertEquals } from "../assert/mod.ts";
+ *
+ * const version = parse("1.2.3");
+ * assertEquals(version, {
+ *   major: 1,
+ *   minor: 2,
+ *   patch: 3,
+ *   prerelease: [],
+ *   build: [],
+ * });
+ * ```
+ *
+ * @throws {TypeError} If the input string is invalid.
+ * @param value The version string to parse
+ * @returns A valid SemVer
+ */
+export declare function parse(value: string): SemVer;

package/esm/std/semver/parse.js

@@ -0,0 +1,44 @@
+import { parseBuild, parseNumber, parsePrerelease } from "./_shared.js";
+import { FULL_REGEXP, MAX_LENGTH } from "./_shared.js";
+/**
+ * Attempt to parse a string as a semantic version, returning a SemVer object.
+ *
+ * @example Usage
+ * ```ts
+ * import { parse } from "parse.ts";
+ * import { assertEquals } from "../assert/mod.ts";
+ *
+ * const version = parse("1.2.3");
+ * assertEquals(version, {
+ *   major: 1,
+ *   minor: 2,
+ *   patch: 3,
+ *   prerelease: [],
+ *   build: [],
+ * });
+ * ```
+ *
+ * @throws {TypeError} If the input string is invalid.
+ * @param value The version string to parse
+ * @returns A valid SemVer
+ */
+export function parse(value) {
+    if (typeof value !== "string") {
+        throw new TypeError(`Cannot parse version as version must be a string: received ${typeof value}`);
+    }
+    if (value.length > MAX_LENGTH) {
+        throw new TypeError(`Cannot parse version as version length is too long: length is ${value.length}, max length is ${MAX_LENGTH}`);
+    }
+    value = value.trim();
+    const groups = value.match(FULL_REGEXP)?.groups;
+    if (!groups)
+        throw new TypeError(`Cannot parse version: ${value}`);
+    const major = parseNumber(groups.major, `Cannot parse version ${value}: invalid major version`);
+    const minor = parseNumber(groups.minor, `Cannot parse version ${value}: invalid minor version`);
+    const patch = parseNumber(groups.patch, `Cannot parse version ${value}: invalid patch version`);
+    const prerelease = groups.prerelease
+        ? parsePrerelease(groups.prerelease)
+        : [];
+    const build = groups.buildmetadata ? parseBuild(groups.buildmetadata) : [];
+    return { major, minor, patch, prerelease, build };
+}

package/esm/std/semver/parse_range.d.ts

@@ -0,0 +1,26 @@
+import type { Range } from "./types.js";
+/**
+ * Parses a range string into a {@linkcode Range} object.
+ *
+ * @example Usage
+ * ```ts
+ * import { parseRange } from "parse_range.ts";
+ * import { assertEquals } from "../assert/mod.ts";
+ *
+ * const range = parseRange(">=1.0.0 <2.0.0 || >=3.0.0");
+ * assertEquals(range, [
+ *   [
+ *     { operator: ">=", major: 1, minor: 0, patch: 0, prerelease: [], build: [] },
+ *     { operator: "<", major: 2, minor: 0, patch: 0, prerelease: [], build: [] },
+ *   ],
+ *   [
+ *     { operator: ">=", major: 3, minor: 0, patch: 0, prerelease: [], build: [] },
+ *   ]
+ * ]);
+ * ```
+ *
+ * @throws {TypeError} If the input range is invalid.
+ * @param value The range set string
+ * @returns A valid SemVer range
+ */
+export declare function parseRange(value: string): Range;