keep-a-changelog 2.5.3 → 2.6.0

package/esm/std/path/windows/is_absolute.js

@@ -0,0 +1,38 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+// This module is browser compatible.
+import { CHAR_COLON } from "../_common/constants.js";
+import { assertPath } from "../_common/assert_path.js";
+import { isPathSeparator, isWindowsDeviceRoot } from "./_util.js";
+/**
+ * Verifies whether provided path is absolute.
+ *
+ * @example Usage
+ * ```ts
+ * import { isAbsolute } from "is_absolute.ts";
+ * import { assert, assertFalse } from "../../assert/mod.ts";
+ *
+ * assert(isAbsolute("C:\\foo\\bar"));
+ * assertFalse(isAbsolute("..\\baz"));
+ * ```
+ *
+ * @param path The path to verify.
+ * @returns `true` if the path is absolute, `false` otherwise.
+ */
+export function isAbsolute(path) {
+    assertPath(path);
+    const len = path.length;
+    if (len === 0)
+        return false;
+    const code = path.charCodeAt(0);
+    if (isPathSeparator(code)) {
+        return true;
+    }
+    else if (isWindowsDeviceRoot(code)) {
+        // Possible device root
+        if (len > 2 && path.charCodeAt(1) === CHAR_COLON) {
+            if (isPathSeparator(path.charCodeAt(2)))
+                return true;
+        }
+    }
+    return false;
+}

package/esm/std/path/windows/join.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Join all given a sequence of `paths`,then normalizes the resulting path.
+ *
+ * @example Usage
+ * ```ts
+ * import { join } from "join.ts";
+ * import { assertEquals } from "../../assert/mod.ts";
+ *
+ * const joined = join("C:\\foo", "bar", "baz\\..");
+ * assertEquals(joined, "C:\\foo\\bar");
+ * ```
+ *
+ * Note: If you are working with file URLs,
+ * use the new version of `join` from `@std/path/windows/unstable-join`.
+ *
+ * @param paths The paths to join.
+ * @returns The joined path.
+ */
+export declare function join(...paths: string[]): string;

package/esm/std/path/windows/join.js

@@ -0,0 +1,74 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+// This module is browser compatible.
+import { assertPath } from "../_common/assert_path.js";
+import { isPathSeparator } from "./_util.js";
+import { normalize } from "./normalize.js";
+/**
+ * Join all given a sequence of `paths`,then normalizes the resulting path.
+ *
+ * @example Usage
+ * ```ts
+ * import { join } from "join.ts";
+ * import { assertEquals } from "../../assert/mod.ts";
+ *
+ * const joined = join("C:\\foo", "bar", "baz\\..");
+ * assertEquals(joined, "C:\\foo\\bar");
+ * ```
+ *
+ * Note: If you are working with file URLs,
+ * use the new version of `join` from `@std/path/windows/unstable-join`.
+ *
+ * @param paths The paths to join.
+ * @returns The joined path.
+ */
+export function join(...paths) {
+    paths.forEach((path) => assertPath(path));
+    paths = paths.filter((path) => path.length > 0);
+    if (paths.length === 0)
+        return ".";
+    // Make sure that the joined path doesn't start with two slashes, because
+    // normalize() will mistake it for an UNC path then.
+    //
+    // This step is skipped when it is very clear that the user actually
+    // intended to point at an UNC path. This is assumed when the first
+    // non-empty string arguments starts with exactly two slashes followed by
+    // at least one more non-slash character.
+    //
+    // Note that for normalize() to treat a path as an UNC path it needs to
+    // have at least 2 components, so we don't filter for that here.
+    // This means that the user can use join to construct UNC paths from
+    // a server name and a share name; for example:
+    //   path.join('//server', 'share') -> '\\\\server\\share\\'
+    let needsReplace = true;
+    let slashCount = 0;
+    const firstPart = paths[0];
+    if (isPathSeparator(firstPart.charCodeAt(0))) {
+        ++slashCount;
+        const firstLen = firstPart.length;
+        if (firstLen > 1) {
+            if (isPathSeparator(firstPart.charCodeAt(1))) {
+                ++slashCount;
+                if (firstLen > 2) {
+                    if (isPathSeparator(firstPart.charCodeAt(2)))
+                        ++slashCount;
+                    else {
+                        // We matched a UNC path in the first part
+                        needsReplace = false;
+                    }
+                }
+            }
+        }
+    }
+    let joined = paths.join("\\");
+    if (needsReplace) {
+        // Find any more consecutive slashes we need to replace
+        for (; slashCount < joined.length; ++slashCount) {
+            if (!isPathSeparator(joined.charCodeAt(slashCount)))
+                break;
+        }
+        // Replace the slashes if needed
+        if (slashCount >= 2)
+            joined = `\\${joined.slice(slashCount)}`;
+    }
+    return normalize(joined);
+}

package/esm/std/path/windows/join_globs.d.ts

@@ -0,0 +1,20 @@
+import type { GlobOptions } from "../_common/glob_to_reg_exp.js";
+export type { GlobOptions };
+/**
+ * Like join(), but doesn't collapse "**\/.." when `globstar` is true.
+ *
+ * @example Usage
+ *
+ * ```ts
+ * import { joinGlobs } from "join_globs.ts";
+ * import { assertEquals } from "../../assert/mod.ts";
+ *
+ * const joined = joinGlobs(["foo", "**", "bar"], { globstar: true });
+ * assertEquals(joined, "foo\\**\\bar");
+ * ```
+ *
+ * @param globs The globs to join.
+ * @param options The options for glob pattern.
+ * @returns The joined glob pattern.
+ */
+export declare function joinGlobs(globs: string[], options?: Pick<GlobOptions, "globstar">): string;

package/esm/std/path/windows/join_globs.js

@@ -0,0 +1,41 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+// This module is browser compatible.
+import { join } from "./join.js";
+import { SEPARATOR } from "./constants.js";
+import { normalizeGlob } from "./normalize_glob.js";
+/**
+ * Like join(), but doesn't collapse "**\/.." when `globstar` is true.
+ *
+ * @example Usage
+ *
+ * ```ts
+ * import { joinGlobs } from "join_globs.ts";
+ * import { assertEquals } from "../../assert/mod.ts";
+ *
+ * const joined = joinGlobs(["foo", "**", "bar"], { globstar: true });
+ * assertEquals(joined, "foo\\**\\bar");
+ * ```
+ *
+ * @param globs The globs to join.
+ * @param options The options for glob pattern.
+ * @returns The joined glob pattern.
+ */
+export function joinGlobs(globs, options = {}) {
+    const { globstar = false } = options;
+    if (!globstar || globs.length === 0) {
+        return join(...globs);
+    }
+    let joined;
+    for (const glob of globs) {
+        const path = glob;
+        if (path.length > 0) {
+            if (!joined)
+                joined = path;
+            else
+                joined += `${SEPARATOR}${path}`;
+        }
+    }
+    if (!joined)
+        return ".";
+    return normalizeGlob(joined, { globstar });
+}

package/esm/std/path/windows/normalize.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Normalize the `path`, resolving `'..'` and `'.'` segments.
+ * Note that resolving these segments does not necessarily mean that all will be eliminated.
+ * A `'..'` at the top-level will be preserved, and an empty path is canonically `'.'`.
+ *
+ * @example Usage
+ * ```ts
+ * import { normalize } from "normalize.ts";
+ * import { assertEquals } from "../../assert/mod.ts";
+ *
+ * const normalized = normalize("C:\\foo\\..\\bar");
+ * assertEquals(normalized, "C:\\bar");
+ * ```
+ *
+ * Note: If you are working with file URLs,
+ * use the new version of `normalize` from `@std/path/windows/unstable-normalize`.
+ *
+ * @param path The path to normalize
+ * @returns The normalized path
+ */
+export declare function normalize(path: string): string;

package/esm/std/path/windows/normalize.js

@@ -0,0 +1,134 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+// This module is browser compatible.
+import { assertArg } from "../_common/normalize.js";
+import { CHAR_COLON } from "../_common/constants.js";
+import { normalizeString } from "../_common/normalize_string.js";
+import { isPathSeparator, isWindowsDeviceRoot } from "./_util.js";
+/**
+ * Normalize the `path`, resolving `'..'` and `'.'` segments.
+ * Note that resolving these segments does not necessarily mean that all will be eliminated.
+ * A `'..'` at the top-level will be preserved, and an empty path is canonically `'.'`.
+ *
+ * @example Usage
+ * ```ts
+ * import { normalize } from "normalize.ts";
+ * import { assertEquals } from "../../assert/mod.ts";
+ *
+ * const normalized = normalize("C:\\foo\\..\\bar");
+ * assertEquals(normalized, "C:\\bar");
+ * ```
+ *
+ * Note: If you are working with file URLs,
+ * use the new version of `normalize` from `@std/path/windows/unstable-normalize`.
+ *
+ * @param path The path to normalize
+ * @returns The normalized path
+ */
+export function normalize(path) {
+    assertArg(path);
+    const len = path.length;
+    let rootEnd = 0;
+    let device;
+    let isAbsolute = false;
+    const code = path.charCodeAt(0);
+    // Try to match a root
+    if (len > 1) {
+        if (isPathSeparator(code)) {
+            // Possible UNC root
+            // If we started with a separator, we know we at least have an absolute
+            // path of some kind (UNC or otherwise)
+            isAbsolute = true;
+            if (isPathSeparator(path.charCodeAt(1))) {
+                // Matched double path separator at beginning
+                let j = 2;
+                let last = j;
+                // Match 1 or more non-path separators
+                for (; j < len; ++j) {
+                    if (isPathSeparator(path.charCodeAt(j)))
+                        break;
+                }
+                if (j < len && j !== last) {
+                    const firstPart = path.slice(last, j);
+                    // Matched!
+                    last = j;
+                    // Match 1 or more path separators
+                    for (; j < len; ++j) {
+                        if (!isPathSeparator(path.charCodeAt(j)))
+                            break;
+                    }
+                    if (j < len && j !== last) {
+                        // Matched!
+                        last = j;
+                        // Match 1 or more non-path separators
+                        for (; j < len; ++j) {
+                            if (isPathSeparator(path.charCodeAt(j)))
+                                break;
+                        }
+                        if (j === len) {
+                            // We matched a UNC root only
+                            // Return the normalized version of the UNC root since there
+                            // is nothing left to process
+                            return `\\\\${firstPart}\\${path.slice(last)}\\`;
+                        }
+                        else if (j !== last) {
+                            // We matched a UNC root with leftovers
+                            device = `\\\\${firstPart}\\${path.slice(last, j)}`;
+                            rootEnd = j;
+                        }
+                    }
+                }
+            }
+            else {
+                rootEnd = 1;
+            }
+        }
+        else if (isWindowsDeviceRoot(code)) {
+            // Possible device root
+            if (path.charCodeAt(1) === CHAR_COLON) {
+                device = path.slice(0, 2);
+                rootEnd = 2;
+                if (len > 2) {
+                    if (isPathSeparator(path.charCodeAt(2))) {
+                        // Treat separator following drive name as an absolute path
+                        // indicator
+                        isAbsolute = true;
+                        rootEnd = 3;
+                    }
+                }
+            }
+        }
+    }
+    else if (isPathSeparator(code)) {
+        // `path` contains just a path separator, exit early to avoid unnecessary
+        // work
+        return "\\";
+    }
+    let tail;
+    if (rootEnd < len) {
+        tail = normalizeString(path.slice(rootEnd), !isAbsolute, "\\", isPathSeparator);
+    }
+    else {
+        tail = "";
+    }
+    if (tail.length === 0 && !isAbsolute)
+        tail = ".";
+    if (tail.length > 0 && isPathSeparator(path.charCodeAt(len - 1))) {
+        tail += "\\";
+    }
+    if (device === undefined) {
+        if (isAbsolute) {
+            if (tail.length > 0)
+                return `\\${tail}`;
+            else
+                return "\\";
+        }
+        return tail;
+    }
+    else if (isAbsolute) {
+        if (tail.length > 0)
+            return `${device}\\${tail}`;
+        else
+            return `${device}\\`;
+    }
+    return device + tail;
+}

package/esm/std/path/windows/normalize_glob.d.ts

@@ -0,0 +1,19 @@
+import type { GlobOptions } from "../_common/glob_to_reg_exp.js";
+export type { GlobOptions };
+/**
+ * Like normalize(), but doesn't collapse "**\/.." when `globstar` is true.
+ *
+ * @example Usage
+ * ```ts
+ * import { normalizeGlob } from "normalize_glob.ts";
+ * import { assertEquals } from "../../assert/mod.ts";
+ *
+ * const normalized = normalizeGlob("**\\foo\\..\\bar", { globstar: true });
+ * assertEquals(normalized, "**\\bar");
+ * ```
+ *
+ * @param glob The glob pattern to normalize.
+ * @param options The options for glob pattern.
+ * @returns The normalized glob pattern.
+ */
+export declare function normalizeGlob(glob: string, options?: Pick<GlobOptions, "globstar">): string;

package/esm/std/path/windows/normalize_glob.js

@@ -0,0 +1,32 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+// This module is browser compatible.
+import { normalize } from "./normalize.js";
+import { SEPARATOR_PATTERN } from "./constants.js";
+/**
+ * Like normalize(), but doesn't collapse "**\/.." when `globstar` is true.
+ *
+ * @example Usage
+ * ```ts
+ * import { normalizeGlob } from "normalize_glob.ts";
+ * import { assertEquals } from "../../assert/mod.ts";
+ *
+ * const normalized = normalizeGlob("**\\foo\\..\\bar", { globstar: true });
+ * assertEquals(normalized, "**\\bar");
+ * ```
+ *
+ * @param glob The glob pattern to normalize.
+ * @param options The options for glob pattern.
+ * @returns The normalized glob pattern.
+ */
+export function normalizeGlob(glob, options = {}) {
+    const { globstar = false } = options;
+    if (glob.match(/\0/g)) {
+        throw new Error(`Glob contains invalid characters: "${glob}"`);
+    }
+    if (!globstar) {
+        return normalize(glob);
+    }
+    const s = SEPARATOR_PATTERN.source;
+    const badParentPattern = new RegExp(`(?<=(${s}|^)\\*\\*${s})\\.\\.(?=${s}|$)`, "g");
+    return normalize(glob.replace(badParentPattern, "\0")).replace(/\0/g, "..");
+}

package/esm/std/path/windows/parse.d.ts

@@ -0,0 +1,24 @@
+import type { ParsedPath } from "../types.js";
+export type { ParsedPath } from "../types.js";
+/**
+ * Return a `ParsedPath` object of the `path`.
+ *
+ * @example Usage
+ * ```ts
+ * import { parse } from "parse.ts";
+ * import { assertEquals } from "../../assert/mod.ts";
+ *
+ * const parsed = parse("C:\\foo\\bar\\baz.ext");
+ * assertEquals(parsed, {
+ *   root: "C:\\",
+ *   dir: "C:\\foo\\bar",
+ *   base: "baz.ext",
+ *   ext: ".ext",
+ *   name: "baz",
+ * });
+ * ```
+ *
+ * @param path The path to parse.
+ * @returns The `ParsedPath` object.
+ */
+export declare function parse(path: string): ParsedPath;

package/esm/std/path/windows/parse.js

@@ -0,0 +1,176 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+// This module is browser compatible.
+import { CHAR_COLON, CHAR_DOT } from "../_common/constants.js";
+import { assertPath } from "../_common/assert_path.js";
+import { isPathSeparator, isWindowsDeviceRoot } from "./_util.js";
+/**
+ * Return a `ParsedPath` object of the `path`.
+ *
+ * @example Usage
+ * ```ts
+ * import { parse } from "parse.ts";
+ * import { assertEquals } from "../../assert/mod.ts";
+ *
+ * const parsed = parse("C:\\foo\\bar\\baz.ext");
+ * assertEquals(parsed, {
+ *   root: "C:\\",
+ *   dir: "C:\\foo\\bar",
+ *   base: "baz.ext",
+ *   ext: ".ext",
+ *   name: "baz",
+ * });
+ * ```
+ *
+ * @param path The path to parse.
+ * @returns The `ParsedPath` object.
+ */
+export function parse(path) {
+    assertPath(path);
+    const ret = { root: "", dir: "", base: "", ext: "", name: "" };
+    const len = path.length;
+    if (len === 0)
+        return ret;
+    let rootEnd = 0;
+    let code = path.charCodeAt(0);
+    // Try to match a root
+    if (len > 1) {
+        if (isPathSeparator(code)) {
+            // Possible UNC root
+            rootEnd = 1;
+            if (isPathSeparator(path.charCodeAt(1))) {
+                // Matched double path separator at beginning
+                let j = 2;
+                let last = j;
+                // Match 1 or more non-path separators
+                for (; j < len; ++j) {
+                    if (isPathSeparator(path.charCodeAt(j)))
+                        break;
+                }
+                if (j < len && j !== last) {
+                    // Matched!
+                    last = j;
+                    // Match 1 or more path separators
+                    for (; j < len; ++j) {
+                        if (!isPathSeparator(path.charCodeAt(j)))
+                            break;
+                    }
+                    if (j < len && j !== last) {
+                        // Matched!
+                        last = j;
+                        // Match 1 or more non-path separators
+                        for (; j < len; ++j) {
+                            if (isPathSeparator(path.charCodeAt(j)))
+                                break;
+                        }
+                        if (j === len) {
+                            // We matched a UNC root only
+                            rootEnd = j;
+                        }
+                        else if (j !== last) {
+                            // We matched a UNC root with leftovers
+                            rootEnd = j + 1;
+                        }
+                    }
+                }
+            }
+        }
+        else if (isWindowsDeviceRoot(code)) {
+            // Possible device root
+            if (path.charCodeAt(1) === CHAR_COLON) {
+                rootEnd = 2;
+                if (len > 2) {
+                    if (isPathSeparator(path.charCodeAt(2))) {
+                        if (len === 3) {
+                            // `path` contains just a drive root, exit early to avoid
+                            // unnecessary work
+                            ret.root = ret.dir = path;
+                            ret.base = "\\";
+                            return ret;
+                        }
+                        rootEnd = 3;
+                    }
+                }
+                else {
+                    // `path` contains just a relative drive root, exit early to avoid
+                    // unnecessary work
+                    ret.root = ret.dir = path;
+                    return ret;
+                }
+            }
+        }
+    }
+    else if (isPathSeparator(code)) {
+        // `path` contains just a path separator, exit early to avoid
+        // unnecessary work
+        ret.root = ret.dir = path;
+        ret.base = "\\";
+        return ret;
+    }
+    if (rootEnd > 0)
+        ret.root = path.slice(0, rootEnd);
+    let startDot = -1;
+    let startPart = rootEnd;
+    let end = -1;
+    let matchedSlash = true;
+    let i = path.length - 1;
+    // Track the state of characters (if any) we see before our first dot and
+    // after any path separator we find
+    let preDotState = 0;
+    // Get non-dir info
+    for (; i >= rootEnd; --i) {
+        code = path.charCodeAt(i);
+        if (isPathSeparator(code)) {
+            // If we reached a path separator that was not part of a set of path
+            // separators at the end of the string, stop now
+            if (!matchedSlash) {
+                startPart = i + 1;
+                break;
+            }
+            continue;
+        }
+        if (end === -1) {
+            // We saw the first non-path separator, mark this as the end of our
+            // extension
+            matchedSlash = false;
+            end = i + 1;
+        }
+        if (code === CHAR_DOT) {
+            // If this is our first dot, mark it as the start of our extension
+            if (startDot === -1)
+                startDot = i;
+            else if (preDotState !== 1)
+                preDotState = 1;
+        }
+        else if (startDot !== -1) {
+            // We saw a non-dot and non-path separator before our dot, so we should
+            // have a good chance at having a non-empty extension
+            preDotState = -1;
+        }
+    }
+    if (startDot === -1 ||
+        end === -1 ||
+        // We saw a non-dot character immediately before the dot
+        preDotState === 0 ||
+        // The (right-most) trimmed path component is exactly '..'
+        (preDotState === 1 && startDot === end - 1 && startDot === startPart + 1)) {
+        if (end !== -1) {
+            ret.base = ret.name = path.slice(startPart, end);
+        }
+    }
+    else {
+        ret.name = path.slice(startPart, startDot);
+        ret.base = path.slice(startPart, end);
+        ret.ext = path.slice(startDot, end);
+    }
+    // Fallback to '\' in case there is no basename
+    ret.base = ret.base || "\\";
+    // If the directory is the root, use the entire root as the `dir` including
+    // the trailing slash if any (`C:\abc` -> `C:\`). Otherwise, strip out the
+    // trailing slash (`C:\abc\def` -> `C:\abc`).
+    if (startPart > 0 && startPart !== rootEnd) {
+        ret.dir = path.slice(0, startPart - 1);
+    }
+    else
+        ret.dir = ret.root;
+    return ret;
+}

package/esm/std/path/windows/relative.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Return the relative path from `from` to `to` based on current working directory.
+ *
+ * An example in windws, for instance:
+ *  from = 'C:\\orandea\\test\\aaa'
+ *  to = 'C:\\orandea\\impl\\bbb'
+ * The output of the function should be: '..\\..\\impl\\bbb'
+ *
+ * @example Usage
+ * ```ts
+ * import { relative } from "relative.ts";
+ * import { assertEquals } from "../../assert/mod.ts";
+ *
+ * const relativePath = relative("C:\\foobar\\test\\aaa", "C:\\foobar\\impl\\bbb");
+ * assertEquals(relativePath, "..\\..\\impl\\bbb");
+ * ```
+ *
+ * @param from The path from which to calculate the relative path
+ * @param to The path to which to calculate the relative path
+ * @returns The relative path from `from` to `to`
+ */
+export declare function relative(from: string, to: string): string;