keep-a-changelog 2.5.2 → 2.6.0

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

@@ -0,0 +1,138 @@
+"use strict";
+// Copyright 2018-2025 the Deno authors. MIT license.
+// This module is browser compatible.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalize = void 0;
+const normalize_js_1 = require("../_common/normalize.js");
+const constants_js_1 = require("../_common/constants.js");
+const normalize_string_js_1 = require("../_common/normalize_string.js");
+const _util_js_1 = require("./_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
+ */
+function normalize(path) {
+    (0, normalize_js_1.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 ((0, _util_js_1.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 ((0, _util_js_1.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 ((0, _util_js_1.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 (!(0, _util_js_1.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 ((0, _util_js_1.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 ((0, _util_js_1.isWindowsDeviceRoot)(code)) {
+            // Possible device root
+            if (path.charCodeAt(1) === constants_js_1.CHAR_COLON) {
+                device = path.slice(0, 2);
+                rootEnd = 2;
+                if (len > 2) {
+                    if ((0, _util_js_1.isPathSeparator)(path.charCodeAt(2))) {
+                        // Treat separator following drive name as an absolute path
+                        // indicator
+                        isAbsolute = true;
+                        rootEnd = 3;
+                    }
+                }
+            }
+        }
+    }
+    else if ((0, _util_js_1.isPathSeparator)(code)) {
+        // `path` contains just a path separator, exit early to avoid unnecessary
+        // work
+        return "\\";
+    }
+    let tail;
+    if (rootEnd < len) {
+        tail = (0, normalize_string_js_1.normalizeString)(path.slice(rootEnd), !isAbsolute, "\\", _util_js_1.isPathSeparator);
+    }
+    else {
+        tail = "";
+    }
+    if (tail.length === 0 && !isAbsolute)
+        tail = ".";
+    if (tail.length > 0 && (0, _util_js_1.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;
+}
+exports.normalize = normalize;

package/script/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/script/std/path/windows/normalize_glob.js

@@ -0,0 +1,36 @@
+"use strict";
+// Copyright 2018-2025 the Deno authors. MIT license.
+// This module is browser compatible.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeGlob = void 0;
+const normalize_js_1 = require("./normalize.js");
+const constants_js_1 = require("./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.
+ */
+function normalizeGlob(glob, options = {}) {
+    const { globstar = false } = options;
+    if (glob.match(/\0/g)) {
+        throw new Error(`Glob contains invalid characters: "${glob}"`);
+    }
+    if (!globstar) {
+        return (0, normalize_js_1.normalize)(glob);
+    }
+    const s = constants_js_1.SEPARATOR_PATTERN.source;
+    const badParentPattern = new RegExp(`(?<=(${s}|^)\\*\\*${s})\\.\\.(?=${s}|$)`, "g");
+    return (0, normalize_js_1.normalize)(glob.replace(badParentPattern, "\0")).replace(/\0/g, "..");
+}
+exports.normalizeGlob = normalizeGlob;

package/script/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/script/std/path/windows/parse.js

@@ -0,0 +1,180 @@
+"use strict";
+// Copyright 2018-2025 the Deno authors. MIT license.
+// This module is browser compatible.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parse = void 0;
+const constants_js_1 = require("../_common/constants.js");
+const assert_path_js_1 = require("../_common/assert_path.js");
+const _util_js_1 = require("./_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.
+ */
+function parse(path) {
+    (0, assert_path_js_1.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 ((0, _util_js_1.isPathSeparator)(code)) {
+            // Possible UNC root
+            rootEnd = 1;
+            if ((0, _util_js_1.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 ((0, _util_js_1.isPathSeparator)(path.charCodeAt(j)))
+                        break;
+                }
+                if (j < len && j !== last) {
+                    // Matched!
+                    last = j;
+                    // Match 1 or more path separators
+                    for (; j < len; ++j) {
+                        if (!(0, _util_js_1.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 ((0, _util_js_1.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 ((0, _util_js_1.isWindowsDeviceRoot)(code)) {
+            // Possible device root
+            if (path.charCodeAt(1) === constants_js_1.CHAR_COLON) {
+                rootEnd = 2;
+                if (len > 2) {
+                    if ((0, _util_js_1.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 ((0, _util_js_1.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 ((0, _util_js_1.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 === constants_js_1.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;
+}
+exports.parse = parse;

package/script/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;

package/script/std/path/windows/relative.js

@@ -0,0 +1,135 @@
+"use strict";
+// Copyright 2018-2025 the Deno authors. MIT license.
+// This module is browser compatible.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.relative = void 0;
+const constants_js_1 = require("../_common/constants.js");
+const resolve_js_1 = require("./resolve.js");
+const relative_js_1 = require("../_common/relative.js");
+/**
+ * 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`
+ */
+function relative(from, to) {
+    (0, relative_js_1.assertArgs)(from, to);
+    const fromOrig = (0, resolve_js_1.resolve)(from);
+    const toOrig = (0, resolve_js_1.resolve)(to);
+    if (fromOrig === toOrig)
+        return "";
+    from = fromOrig.toLowerCase();
+    to = toOrig.toLowerCase();
+    if (from === to)
+        return "";
+    // Trim any leading backslashes
+    let fromStart = 0;
+    let fromEnd = from.length;
+    for (; fromStart < fromEnd; ++fromStart) {
+        if (from.charCodeAt(fromStart) !== constants_js_1.CHAR_BACKWARD_SLASH)
+            break;
+    }
+    // Trim trailing backslashes (applicable to UNC paths only)
+    for (; fromEnd - 1 > fromStart; --fromEnd) {
+        if (from.charCodeAt(fromEnd - 1) !== constants_js_1.CHAR_BACKWARD_SLASH)
+            break;
+    }
+    const fromLen = fromEnd - fromStart;
+    // Trim any leading backslashes
+    let toStart = 0;
+    let toEnd = to.length;
+    for (; toStart < toEnd; ++toStart) {
+        if (to.charCodeAt(toStart) !== constants_js_1.CHAR_BACKWARD_SLASH)
+            break;
+    }
+    // Trim trailing backslashes (applicable to UNC paths only)
+    for (; toEnd - 1 > toStart; --toEnd) {
+        if (to.charCodeAt(toEnd - 1) !== constants_js_1.CHAR_BACKWARD_SLASH)
+            break;
+    }
+    const toLen = toEnd - toStart;
+    // Compare paths to find the longest common path from root
+    const length = fromLen < toLen ? fromLen : toLen;
+    let lastCommonSep = -1;
+    let i = 0;
+    for (; i <= length; ++i) {
+        if (i === length) {
+            if (toLen > length) {
+                if (to.charCodeAt(toStart + i) === constants_js_1.CHAR_BACKWARD_SLASH) {
+                    // We get here if `from` is the exact base path for `to`.
+                    // For example: from='C:\\foo\\bar'; to='C:\\foo\\bar\\baz'
+                    return toOrig.slice(toStart + i + 1);
+                }
+                else if (i === 2) {
+                    // We get here if `from` is the device root.
+                    // For example: from='C:\\'; to='C:\\foo'
+                    return toOrig.slice(toStart + i);
+                }
+            }
+            if (fromLen > length) {
+                if (from.charCodeAt(fromStart + i) === constants_js_1.CHAR_BACKWARD_SLASH) {
+                    // We get here if `to` is the exact base path for `from`.
+                    // For example: from='C:\\foo\\bar'; to='C:\\foo'
+                    lastCommonSep = i;
+                }
+                else if (i === 2) {
+                    // We get here if `to` is the device root.
+                    // For example: from='C:\\foo\\bar'; to='C:\\'
+                    lastCommonSep = 3;
+                }
+            }
+            break;
+        }
+        const fromCode = from.charCodeAt(fromStart + i);
+        const toCode = to.charCodeAt(toStart + i);
+        if (fromCode !== toCode)
+            break;
+        else if (fromCode === constants_js_1.CHAR_BACKWARD_SLASH)
+            lastCommonSep = i;
+    }
+    // We found a mismatch before the first common path separator was seen, so
+    // return the original `to`.
+    if (i !== length && lastCommonSep === -1) {
+        return toOrig;
+    }
+    let out = "";
+    if (lastCommonSep === -1)
+        lastCommonSep = 0;
+    // Generate the relative path based on the path difference between `to` and
+    // `from`
+    for (i = fromStart + lastCommonSep + 1; i <= fromEnd; ++i) {
+        if (i === fromEnd || from.charCodeAt(i) === constants_js_1.CHAR_BACKWARD_SLASH) {
+            if (out.length === 0)
+                out += "..";
+            else
+                out += "\\..";
+        }
+    }
+    // Lastly, append the rest of the destination (`to`) path that comes after
+    // the common path parts
+    if (out.length > 0) {
+        return out + toOrig.slice(toStart + lastCommonSep, toEnd);
+    }
+    else {
+        toStart += lastCommonSep;
+        if (toOrig.charCodeAt(toStart) === constants_js_1.CHAR_BACKWARD_SLASH)
+            ++toStart;
+        return toOrig.slice(toStart, toEnd);
+    }
+}
+exports.relative = relative;

package/script/std/path/windows/resolve.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Resolves path segments into a `path`.
+ *
+ * @example Usage
+ * ```ts
+ * import { resolve } from "resolve.ts";
+ * import { assertEquals } from "../../assert/mod.ts";
+ *
+ * const resolved = resolve("C:\\foo\\bar", "..\\baz");
+ * assertEquals(resolved, "C:\\foo\\baz");
+ * ```
+ *
+ * @param pathSegments The path segments to process to path
+ * @returns The resolved path
+ */
+export declare function resolve(...pathSegments: string[]): string;