path-class 0.8.3 → 0.10.0

package/README.md

@@ -53,3 +53,8 @@ This implementation differs from similar functions in `node` in a few ways:
 - Async `.exists(…)` is implemented. Go knock yourself out with race conditions.
 - `.exists(…)` has options/variants to ensure the existing path is a dir/file.
 - Supported in packages like [`printable-shell-command`](https://github.com/lgarron/printable-shell-command) and [`lockfile-mutex`](https://github.com/lgarron/lockfile-mutex).
+
+Also note:
+
+- `Path` sometimes uses a the presence of a trailing slash `/` to disallow file-specific operations on directory paths.
+- `Path` preserves relative resolution prefixes like `.` and `..`. For example, `new Path("./@biomejs/biome")` is *not* the same as `new Path("@biomejs/biome")`.

package/dist/lib/path-class/Path.d.ts

@@ -1,12 +1,18 @@
 import { appendFile, cp, mkdir, rm, symlink, writeFile } from "node:fs/promises";
 import type { lstatType, readDirType, readFileType, statType } from "./modifiedNodeTypes";
 type WritableData = Parameters<typeof writeFile>[1] | ReadableStream | Response;
+export declare enum ResolutionPrefix {
+    Absolute = "absolute",
+    Relative = "relative",
+    Bare = "bare"
+}
 export declare class Path {
     #private;
     /**
      * If `path` is a string starting with `file:///`, it will be parsed as a file URL.
      */
     constructor(path: string | URL | Path);
+    get resolutionPrefix(): ResolutionPrefix;
     /**
      * Similar to `new URL(path, base)`, but accepting and returning `Path` objects.
      * Note that `base` must be one of:
@@ -36,6 +42,67 @@ export declare class Path {
      * This follows `node` semantics for absolute paths: leading slashes in the given descendant segments are ignored.
      */
     join(...segments: (string | Path)[]): Path;
+    /**
+     * Adjust the prefix to construct a relative path.
+     *
+     * | Example input   | Output          |
+     * |-----------------|-----------------|
+     * | `"bare"`        | `"./bare"`      |
+     * | `"./relative"`  | `"./relative"`  |
+     * | `"../up-first"` | `"../up-first"` |
+     * | `"/absolute"`   | `"./absolute"`  |
+     *
+     */
+    asRelative(): Path;
+    /**
+     * Adjust the prefix to construct an absolute path.
+     *
+     * | Example input   | Output        |
+     * |-----------------|---------------|
+     * | `"bare"`        | `"/bare"`     |
+     * | `"./relative"`  | `"/relative"` |
+     * | `"../up-first"` | `"/up-first"` |
+     * | `"/absolute"`   | `"/absolute"` |
+     *
+     */
+    asAbsolute(): Path;
+    /**
+     * Adjust the prefix to construct a bare path. Note that this returns `"."` if
+     * there are no named paths left.
+     *
+     * | Example input     | Output       |
+     * |-------------------|--------------|
+     * | `"bare"`          | `"bare"`     |
+     * | `"./relative"  `  | `"relative"` |
+     * | `"/absolute"`     | `"absolute"` |
+     * | `"."`             | `"."`        |
+     * | `"down-first/.."` | `"."`        |
+     * | `"../up-first"`   | (error)      |
+     * | `".."`            | (error)      |
+     *
+     * Specify `parentTraversalPrefixHandling` in the `options` if you would like
+     * to strip or keep resolution prefixes like `../` rather than erroring.
+     *
+     * | Example input        | Output with `{ parentTraversalPrefixHandling: "strip" }` |
+     * |----------------------|----------------------------------------------------------|
+     * | `"../up-first"`      | `"up-first"`                                             |
+     * | `".."`               | `"."`                                                    |
+     *
+     * | Example input        | Output with `{ parentTraversalPrefixHandling: "keep" }` |
+     * |----------------------|---------------------------------------------------------|
+     * | `"../up-first"`      | `"../up-first"`                                         |
+     * | `".."`               | `".."`                                                  |
+     *
+     * If you need the output to start with a named component and return values
+     * like `.`, `..`, `../`, or `../…` are not okay, pass
+     * `requireNamedComponentPrefix: true`. This is useful if the path represents
+     * an `npm`-style package name (e.g. `"typescript"`, `"@biomejs/biome"`).
+     *
+     */
+    asBare(options?: {
+        parentTraversalPrefixHandling?: "error" | "strip" | "keep";
+        requireNamedComponentPrefix?: boolean;
+    }): Path;
     extendBasename(suffix: string): Path;
     get parent(): Path;
     /** @deprecated Alias for `.parent`. */

package/dist/lib/path-class/chunks/{chunk-3W742CSF.js → chunk-6KFFVP6T.js}

@@ -35,6 +35,22 @@ async function wrangleWritableData(data) {
   }
   return data;
 }
+var ResolutionPrefix = /* @__PURE__ */ ((ResolutionPrefix2) => {
+  ResolutionPrefix2["Absolute"] = "absolute";
+  ResolutionPrefix2["Relative"] = "relative";
+  ResolutionPrefix2["Bare"] = "bare";
+  return ResolutionPrefix2;
+})(ResolutionPrefix || {});
+function resolutionPrefix(pathString) {
+  if (pathString.startsWith("/")) {
+    return "absolute" /* Absolute */;
+  } else if (pathString.startsWith("./")) {
+    return "relative" /* Relative */;
+  } else if (pathString === ".") {
+    return "relative" /* Relative */;
+  }
+  return "bare" /* Bare */;
+}
 var Path = class _Path {
   // @ts-expect-error ts(2564): False positive. https://github.com/microsoft/TypeScript/issues/32194
   #path;
@@ -42,7 +58,11 @@ var Path = class _Path {
    * If `path` is a string starting with `file:///`, it will be parsed as a file URL.
    */
   constructor(path) {
-    this.#setNormalizedPath(_Path.#pathlikeToString(path));
+    const s = _Path.#pathlikeToString(path);
+    this.#setNormalizedPath(s);
+  }
+  get resolutionPrefix() {
+    return resolutionPrefix(this.#path);
   }
   /**
    * Similar to `new URL(path, base)`, but accepting and returning `Path` objects.
@@ -55,6 +75,9 @@ var Path = class _Path {
   static resolve(path, base) {
     const baseURL = (() => {
       if (!(base instanceof _Path)) {
+        if (typeof base === "string" && !base.startsWith("file://")) {
+          return pathToFileURL(base);
+        }
         return base;
       }
       if (!base.isAbsolutePath()) {
@@ -81,11 +104,16 @@ var Path = class _Path {
     }
     throw new Error("Invalid path");
   }
+  // Preserves the `ResolutionPrefix` status when possible.
   #setNormalizedPath(path) {
+    const prefix = resolutionPrefix(path);
     this.#path = join(path);
+    if (prefix === "relative" /* Relative */ && !this.#path.startsWith(".")) {
+      this.#path = `./${this.#path}`;
+    }
   }
   isAbsolutePath() {
-    return this.#path.startsWith("/");
+    return this.resolutionPrefix === "absolute" /* Absolute */;
   }
   toFileURL() {
     if (!this.isAbsolutePath()) {
@@ -119,11 +147,112 @@ var Path = class _Path {
    * This follows `node` semantics for absolute paths: leading slashes in the given descendant segments are ignored.
    */
   join(...segments) {
-    const segmentStrings = segments.map(
-      (segment) => segment instanceof _Path ? segment.path : segment
-    );
+    const segmentStrings = segments.map((segment) => {
+      const s = stringifyIfPath(segment);
+      if (resolutionPrefix(s) === "absolute" /* Absolute */) {
+        throw new Error(
+          "Arguments to `.join(\u2026)` cannot be absolute. Use `.asRelative()` to convert them first if needed."
+        );
+      }
+      return s;
+    });
     return new _Path(join(this.#path, ...segmentStrings));
   }
+  /**
+   * Adjust the prefix to construct a relative path.
+   *
+   * | Example input   | Output          |
+   * |-----------------|-----------------|
+   * | `"bare"`        | `"./bare"`      |
+   * | `"./relative"`  | `"./relative"`  |
+   * | `"../up-first"` | `"../up-first"` |
+   * | `"/absolute"`   | `"./absolute"`  |
+   *
+   */
+  asRelative() {
+    return new _Path(`./${this.#path}`);
+  }
+  /**
+   * Adjust the prefix to construct an absolute path.
+   *
+   * | Example input   | Output        |
+   * |-----------------|---------------|
+   * | `"bare"`        | `"/bare"`     |
+   * | `"./relative"`  | `"/relative"` |
+   * | `"../up-first"` | `"/up-first"` |
+   * | `"/absolute"`   | `"/absolute"` |
+   *
+   */
+  asAbsolute() {
+    return new _Path(join("/", this.#path));
+  }
+  /**
+   * Adjust the prefix to construct a bare path. Note that this returns `"."` if
+   * there are no named paths left.
+   *
+   * | Example input     | Output       |
+   * |-------------------|--------------|
+   * | `"bare"`          | `"bare"`     |
+   * | `"./relative"  `  | `"relative"` |
+   * | `"/absolute"`     | `"absolute"` |
+   * | `"."`             | `"."`        |
+   * | `"down-first/.."` | `"."`        |
+   * | `"../up-first"`   | (error)      |
+   * | `".."`            | (error)      |
+   *
+   * Specify `parentTraversalPrefixHandling` in the `options` if you would like
+   * to strip or keep resolution prefixes like `../` rather than erroring.
+   *
+   * | Example input        | Output with `{ parentTraversalPrefixHandling: "strip" }` |
+   * |----------------------|----------------------------------------------------------|
+   * | `"../up-first"`      | `"up-first"`                                             |
+   * | `".."`               | `"."`                                                    |
+   *
+   * | Example input        | Output with `{ parentTraversalPrefixHandling: "keep" }` |
+   * |----------------------|---------------------------------------------------------|
+   * | `"../up-first"`      | `"../up-first"`                                         |
+   * | `".."`               | `".."`                                                  |
+   *
+   * If you need the output to start with a named component and return values
+   * like `.`, `..`, `../`, or `../…` are not okay, pass
+   * `requireNamedComponentPrefix: true`. This is useful if the path represents
+   * an `npm`-style package name (e.g. `"typescript"`, `"@biomejs/biome"`).
+   *
+   */
+  asBare(options) {
+    const path = new _Path(join(".", this.#path));
+    if (!path.#path.startsWith("../") && path.#path !== "..") {
+      if (options?.requireNamedComponentPrefix && path.resolutionPrefix === "relative" /* Relative */) {
+        throw new Error("Output does not start with a named component.");
+      }
+      return path;
+    }
+    const parentTraversalHandling = options?.parentTraversalPrefixHandling ?? "error";
+    switch (parentTraversalHandling) {
+      case "error": {
+        throw new Error(
+          'Converting path to a bare path resulted in a `..` traversal prefix. Pass `"strip"` or `"keep"` as the `parentTraversalHandling` option to avoid an error.'
+        );
+      }
+      case "strip": {
+        let newPath = path.#path.replace(/^(\.\.\/)+/, "");
+        if (["", ".."].includes(newPath)) {
+          newPath = ".";
+        }
+        const output = new _Path(newPath);
+        if (options?.requireNamedComponentPrefix && output.resolutionPrefix === "relative" /* Relative */) {
+          throw new Error("Output does not start with a named component.");
+        }
+        return new _Path(newPath);
+      }
+      case "keep": {
+        if (options?.requireNamedComponentPrefix) {
+          throw new Error("Output does not start with a named component.");
+        }
+        return path;
+      }
+    }
+  }
   extendBasename(suffix) {
     const joinedSuffix = join(suffix);
     if (joinedSuffix !== basename(joinedSuffix)) {
@@ -377,8 +506,9 @@ function mustNotHaveTrailingSlash(path) {
 }
 
 export {
+  ResolutionPrefix,
   Path,
   stringifyIfPath,
   mustNotHaveTrailingSlash
 };
-//# sourceMappingURL=chunk-3W742CSF.js.map
+//# sourceMappingURL=chunk-6KFFVP6T.js.map

package/dist/lib/path-class/chunks/chunk-6KFFVP6T.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/Path.ts"],
+  "sourcesContent": ["import {\n  appendFile,\n  cp,\n  lstat,\n  mkdir,\n  mkdtemp,\n  readdir,\n  readFile,\n  realpath,\n  rename,\n  rm,\n  stat,\n  symlink,\n  writeFile,\n} from \"node:fs/promises\";\nimport { homedir, tmpdir } from \"node:os\";\nimport { basename, dirname, extname, join } from \"node:path\";\nimport { Readable } from \"node:stream\";\nimport { fileURLToPath, pathToFileURL } from \"node:url\";\nimport {\n  xdgCache,\n  xdgConfig,\n  xdgData,\n  xdgRuntime,\n  xdgState,\n} from \"xdg-basedir\";\nimport type {\n  lstatType,\n  readDirType,\n  readFileType,\n  statType,\n} from \"./modifiedNodeTypes\";\n\n// Note that (non-static) functions in this file are defined using `function(\u2026)\n// { \u2026 }` rather than arrow functions, specifically because we want `this` to\n// operate on the `Path` instance.\n\ntype WritableData = Parameters<typeof writeFile>[1] | ReadableStream | Response;\nasync function wrangleWritableData(\n  data: WritableData | Promise<WritableData>,\n): Promise<Parameters<typeof writeFile>[1]> {\n  data = await data;\n  if (data instanceof Response) {\n    data = data.body ? Readable.fromWeb(data.body) : new Uint8Array(0);\n  }\n  if (data instanceof ReadableStream) {\n    data = Readable.fromWeb(data);\n  }\n  return data;\n}\n\nexport enum ResolutionPrefix {\n  Absolute = \"absolute\",\n  Relative = \"relative\",\n  Bare = \"bare\",\n}\n\nfunction resolutionPrefix(pathString: string): ResolutionPrefix {\n  if (pathString.startsWith(\"/\")) {\n    return ResolutionPrefix.Absolute;\n  } else if (pathString.startsWith(\"./\")) {\n    return ResolutionPrefix.Relative;\n  } else if (pathString === \".\") {\n    return ResolutionPrefix.Relative;\n  }\n  return ResolutionPrefix.Bare;\n}\n\nexport class Path {\n  // @ts-expect-error ts(2564): False positive. https://github.com/microsoft/TypeScript/issues/32194\n  #path: string;\n  /**\n   * If `path` is a string starting with `file:///`, it will be parsed as a file URL.\n   */\n  constructor(path: string | URL | Path) {\n    const s = Path.#pathlikeToString(path);\n    this.#setNormalizedPath(s);\n  }\n\n  get resolutionPrefix(): ResolutionPrefix {\n    return resolutionPrefix(this.#path);\n  }\n\n  /**\n   * Similar to `new URL(path, base)`, but accepting and returning `Path` objects.\n   * Note that `base` must be one of:\n   *\n   * - a valid second argument to `new URL(\u2026)`.\n   * - a `Path` representing an absolute path.\n   *\n   */\n  static resolve(path: string | URL | Path, base: string | URL | Path): Path {\n    const baseURL = (() => {\n      if (!(base instanceof Path)) {\n        if (typeof base === \"string\" && !base.startsWith(\"file://\")) {\n          return pathToFileURL(base);\n        }\n        return base;\n      }\n      if (!base.isAbsolutePath()) {\n        throw new Error(\n          \"The `base` arg to `Path.resolve(\u2026)` must be an absolute path.\",\n        );\n      }\n      return pathToFileURL(base.#path);\n    })();\n    return new Path(new URL(Path.#pathlikeToString(path), baseURL));\n  }\n\n  static #pathlikeToString(path: string | URL | Path): string {\n    if (path instanceof Path) {\n      return path.#path;\n    }\n    if (path instanceof URL) {\n      return fileURLToPath(path);\n    }\n    if (typeof path === \"string\") {\n      // TODO: allow turning off this heuristic?\n      if (path.startsWith(\"file:///\")) {\n        return fileURLToPath(path);\n      }\n      return path;\n    }\n    throw new Error(\"Invalid path\");\n  }\n\n  // Preserves the `ResolutionPrefix` status when possible.\n  #setNormalizedPath(path: string): void {\n    const prefix = resolutionPrefix(path);\n    this.#path = join(path);\n    if (prefix === ResolutionPrefix.Relative && !this.#path.startsWith(\".\")) {\n      // We don't have to handle the case of `\".\"`, as it already starts with `\".\"`\n      this.#path = `./${this.#path}`;\n    }\n  }\n\n  isAbsolutePath(): boolean {\n    return this.resolutionPrefix === ResolutionPrefix.Absolute;\n  }\n\n  toFileURL(): URL {\n    if (!this.isAbsolutePath()) {\n      throw new Error(\n        \"Tried to convert to file URL when the path is not absolute.\",\n      );\n    }\n    return pathToFileURL(this.#path);\n  }\n\n  /**\n   * The `Path` can have a trailing slash, indicating that it represents a\n   * directory. (If there is no trailing slash, it can represent either a file\n   * or a directory.)\n   *\n   * Some operations will refuse to treat a directory path as a file path. This\n   * function identifies such paths.\n   */\n  hasTrailingSlash(): boolean {\n    // TODO: handle Windows semantically\n    return this.#path.endsWith(\"/\");\n  }\n\n  /**\n   * Same as `.toString()`, but more concise.\n   */\n  get path() {\n    return this.#path;\n  }\n\n  toString(): string {\n    return this.#path;\n  }\n\n  /** Constructs a new path by appending the given path segments.\n   * This follows `node` semantics for absolute paths: leading slashes in the given descendant segments are ignored.\n   */\n  join(...segments: (string | Path)[]): Path {\n    const segmentStrings = segments.map((segment) => {\n      const s = stringifyIfPath(segment);\n      if (resolutionPrefix(s) === ResolutionPrefix.Absolute) {\n        throw new Error(\n          \"Arguments to `.join(\u2026)` cannot be absolute. Use `.asRelative()` to convert them first if needed.\",\n        );\n      }\n      return s;\n    });\n    return new Path(join(this.#path, ...segmentStrings));\n  }\n\n  /**\n   * Adjust the prefix to construct a relative path.\n   *\n   * | Example input   | Output          |\n   * |-----------------|-----------------|\n   * | `\"bare\"`        | `\"./bare\"`      |\n   * | `\"./relative\"`  | `\"./relative\"`  |\n   * | `\"../up-first\"` | `\"../up-first\"` |\n   * | `\"/absolute\"`   | `\"./absolute\"`  |\n   *\n   */\n  asRelative(): Path {\n    return new Path(`./${this.#path}`);\n  }\n\n  /**\n   * Adjust the prefix to construct an absolute path.\n   *\n   * | Example input   | Output        |\n   * |-----------------|---------------|\n   * | `\"bare\"`        | `\"/bare\"`     |\n   * | `\"./relative\"`  | `\"/relative\"` |\n   * | `\"../up-first\"` | `\"/up-first\"` |\n   * | `\"/absolute\"`   | `\"/absolute\"` |\n   *\n   */\n  asAbsolute(): Path {\n    return new Path(join(\"/\", this.#path));\n  }\n\n  /**\n   * Adjust the prefix to construct a bare path. Note that this returns `\".\"` if\n   * there are no named paths left.\n   *\n   * | Example input     | Output       |\n   * |-------------------|--------------|\n   * | `\"bare\"`          | `\"bare\"`     |\n   * | `\"./relative\"  `  | `\"relative\"` |\n   * | `\"/absolute\"`     | `\"absolute\"` |\n   * | `\".\"`             | `\".\"`        |\n   * | `\"down-first/..\"` | `\".\"`        |\n   * | `\"../up-first\"`   | (error)      |\n   * | `\"..\"`            | (error)      |\n   *\n   * Specify `parentTraversalPrefixHandling` in the `options` if you would like\n   * to strip or keep resolution prefixes like `../` rather than erroring.\n   *\n   * | Example input        | Output with `{ parentTraversalPrefixHandling: \"strip\" }` |\n   * |----------------------|----------------------------------------------------------|\n   * | `\"../up-first\"`      | `\"up-first\"`                                             |\n   * | `\"..\"`               | `\".\"`                                                    |\n   *\n   * | Example input        | Output with `{ parentTraversalPrefixHandling: \"keep\" }` |\n   * |----------------------|---------------------------------------------------------|\n   * | `\"../up-first\"`      | `\"../up-first\"`                                         |\n   * | `\"..\"`               | `\"..\"`                                                  |\n   *\n   * If you need the output to start with a named component and return values\n   * like `.`, `..`, `../`, or `../\u2026` are not okay, pass\n   * `requireNamedComponentPrefix: true`. This is useful if the path represents\n   * an `npm`-style package name (e.g. `\"typescript\"`, `\"@biomejs/biome\"`).\n   *\n   */\n  asBare(options?: {\n    parentTraversalPrefixHandling?: \"error\" | \"strip\" | \"keep\";\n    requireNamedComponentPrefix?: boolean;\n  }): Path {\n    const path = new Path(join(\".\", this.#path));\n    if (!path.#path.startsWith(\"../\") && path.#path !== \"..\") {\n      if (\n        options?.requireNamedComponentPrefix &&\n        path.resolutionPrefix === ResolutionPrefix.Relative\n      ) {\n        throw new Error(\"Output does not start with a named component.\");\n      }\n      return path;\n    }\n    const parentTraversalHandling =\n      options?.parentTraversalPrefixHandling ?? \"error\";\n    switch (parentTraversalHandling) {\n      case \"error\": {\n        throw new Error(\n          'Converting path to a bare path resulted in a `..` traversal prefix. Pass `\"strip\"` or `\"keep\"` as the `parentTraversalHandling` option to avoid an error.',\n        );\n      }\n      case \"strip\": {\n        let newPath = path.#path.replace(/^(\\.\\.\\/)+/, \"\");\n        if ([\"\", \"..\"].includes(newPath)) {\n          newPath = \".\";\n        }\n        const output = new Path(newPath);\n        if (\n          options?.requireNamedComponentPrefix &&\n          output.resolutionPrefix === ResolutionPrefix.Relative\n        ) {\n          throw new Error(\"Output does not start with a named component.\");\n        }\n        return new Path(newPath);\n      }\n      case \"keep\": {\n        if (options?.requireNamedComponentPrefix) {\n          throw new Error(\"Output does not start with a named component.\");\n        }\n        return path;\n      }\n    }\n  }\n\n  extendBasename(suffix: string): Path {\n    const joinedSuffix = join(suffix);\n    if (joinedSuffix !== basename(joinedSuffix)) {\n      throw new Error(\"Invalid suffix to extend file name.\");\n    }\n    // TODO: join basename and dirname instead?\n    return new Path(this.#path + joinedSuffix);\n  }\n\n  get parent(): Path {\n    return new Path(dirname(this.#path));\n  }\n\n  // Normally I'd stick with `node`'s name, but I think `.dirname` is a\n  // particularly poor name. So we support `.dirname` for discovery but mark it\n  // as deprecated, even if it will never be removed.\n  /** @deprecated Alias for `.parent`. */\n  get dirname(): Path {\n    return this.parent;\n  }\n\n  get basename(): Path {\n    return new Path(basename(this.#path));\n  }\n\n  get extension(): string {\n    mustNotHaveTrailingSlash(this);\n    return extname(this.#path);\n  }\n\n  // Normally I'd stick with `node`'s name, but I think `.extname` is a\n  // particularly poor name. So we support `.extname` for discovery but mark it\n  // as deprecated, even if it will never be removed.\n  /** @deprecated Alias for `.extension`. */\n  get extname(): string {\n    return this.extension;\n  }\n\n  // TODO: find a neat way to dedup with the sync version?\n  async exists(constraints?: {\n    mustBe: \"file\" | \"directory\";\n  }): Promise<boolean> {\n    let stats: Awaited<ReturnType<typeof stat>>;\n    try {\n      stats = await stat(this.#path);\n      // biome-ignore lint/suspicious/noExplicitAny: TypeScript limitation\n    } catch (e: any) {\n      if (e.code === \"ENOENT\") {\n        return false;\n      }\n      throw e;\n    }\n    if (!constraints?.mustBe) {\n      return true;\n    }\n    switch (constraints?.mustBe) {\n      case \"file\": {\n        mustNotHaveTrailingSlash(this);\n        if (stats.isFile()) {\n          return true;\n        }\n        throw new Error(`Path exists but is not a file: ${this.#path}`);\n      }\n      case \"directory\": {\n        if (stats.isDirectory()) {\n          return true;\n        }\n        throw new Error(`Path exists but is not a directory: ${this.#path}`);\n      }\n      default: {\n        throw new Error(\"Invalid path type constraint\");\n      }\n    }\n  }\n\n  async existsAsFile(): Promise<boolean> {\n    return this.exists({ mustBe: \"file\" });\n  }\n\n  async existsAsDir(): Promise<boolean> {\n    return this.exists({ mustBe: \"directory\" });\n  }\n\n  // I don't think `mkdir` is a great name, but it does match the\n  // well-established canonical commandline name. So in this case we keep the\n  // awkward abbreviation.\n  /** Defaults to `recursive: true`. */\n  async mkdir(options?: Parameters<typeof mkdir>[1]): Promise<Path> {\n    const optionsObject = (() => {\n      if (typeof options === \"string\" || typeof options === \"number\") {\n        return { mode: options };\n      }\n      return options ?? {};\n    })();\n    await mkdir(this.#path, { recursive: true, ...optionsObject });\n    return this;\n  }\n\n  // TODO: check idempotency semantics when the destination exists and is a folder.\n  /** Returns the destination path. */\n  async cp(\n    destination: string | URL | Path,\n    options?: Parameters<typeof cp>[2],\n  ): Promise<Path> {\n    await cp(this.#path, new Path(destination).#path, options);\n    return new Path(destination);\n  }\n\n  // TODO: check idempotency semantics when the destination exists and is a folder.\n  async rename(destination: string | URL | Path): Promise<void> {\n    await rename(this.#path, new Path(destination).#path);\n  }\n\n  /** Create a temporary dir inside the global temp dir for the current user. */\n  static async makeTempDir(prefix?: string): Promise<Path> {\n    return new Path(\n      await mkdtemp(new Path(tmpdir()).join(prefix ?? \"js-temp-\").toString()),\n    );\n  }\n\n  async rm(options?: Parameters<typeof rm>[1]): Promise<void> {\n    await rm(this.#path, options);\n  }\n\n  /**\n   * Equivalent to:\n   *\n   *     .rm({ recursive: true, force: true, ...(options ?? {}) })\n   *\n   */\n  async rm_rf(options?: Parameters<typeof rm>[1]): Promise<void> {\n    await this.rm({ recursive: true, force: true, ...(options ?? {}) });\n  }\n\n  read: typeof readFileType = (options) =>\n    // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n    readFile(this.#path, options as any) as any;\n\n  async readText(): Promise<string> {\n    return readFile(this.#path, \"utf-8\");\n  }\n\n  /**\n   * Reads JSON from the given file and parses it. No validation is performed\n   * (beyond JSON parsing).\n   *\n   * An optional `fallback` value can be specified. It will be used if (and only\n   * if) the file does not exist.\n   *\n   */\n\n  // biome-ignore lint/suspicious/noExplicitAny: Allow a default of `any` to match `JSON.parse(\u2026)`.\n  async readJSON<T = any>(options?: { fallback?: T }): Promise<T> {\n    try {\n      return JSON.parse(await this.readText());\n    } catch (e) {\n      if (\n        (e as { code?: string }).code === \"ENOENT\" &&\n        options &&\n        \"fallback\" in options\n      ) {\n        return options.fallback as T;\n      }\n      throw e;\n    }\n  }\n\n  /**\n   * Returns the original `Path` (for chaining).\n   */\n  async appendFile(\n    data: Parameters<typeof appendFile>[1],\n    options?: Parameters<typeof appendFile>[2],\n  ): Promise<Path> {\n    await appendFile(this.#path, data, options);\n    return this;\n  }\n\n  /** Creates intermediate directories if they do not exist.\n   *\n   * Returns the original `Path` (for chaining).\n   */\n  async write(\n    data: WritableData | Promise<WritableData>,\n    options?: Parameters<typeof writeFile>[2],\n  ): Promise<Path> {\n    await this.parent.mkdir();\n    await writeFile(this.#path, await wrangleWritableData(data), options);\n    return this;\n  }\n\n  /**\n   * If only `data` is provided, this is equivalent to:\n   *\n   *     .write(JSON.stringify(data, null, \"  \"));\n   *\n   * `replacer` and `space` can also be specified, making this equivalent to:\n   *\n   *     .write(JSON.stringify(data, replacer, space));\n   *\n   * Returns the original `Path` (for chaining).\n   */\n  async writeJSON<T>(\n    data: T,\n    replacer: Parameters<typeof JSON.stringify>[1] = null,\n    space: Parameters<typeof JSON.stringify>[2] = \"  \",\n  ): Promise<Path> {\n    await this.write(JSON.stringify(data, replacer, space));\n    return this;\n  }\n\n  // Normally we'd add a `@deprecated` alias named `.readdir`, but that would\n  // differ only by capitalization of a single non-leading character. This can\n  // be a bit confusing, especially when autocompleting. So for this function in\n  // particular we don't include an alias.\n  readDir: typeof readDirType = (options) =>\n    // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n    readdir(this.#path, options as any) as any;\n\n  /** Returns the destination path. */\n  async symlink(\n    target: string | URL | Path,\n    type?: Parameters<typeof symlink>[2],\n  ): Promise<Path> {\n    const targetPath = new Path(target);\n    await symlink(\n      this.path,\n      targetPath.path,\n      type as Exclude<Parameters<typeof symlink>[2], undefined>, // \uD83E\uDD37\n    );\n    return targetPath;\n  }\n\n  // I don't think `lstat` is a great name, but it does match the\n  // well-established canonical commandline name. So in this case we keep the\n  // name instead of using `realPath`.\n  //\n  // Note: There are no options in our API, because the only option is an\n  // encoding. We set the encoding to construct the returned `Path`.\n  async realpath(): Promise<Path> {\n    return new Path(await realpath(this.#path, \"utf-8\"));\n  }\n\n  // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n  stat: typeof statType = (...options) => stat(this.#path, ...options) as any;\n\n  // I don't think `lstat` is a great name, but it does match the\n  // well-established canonical system call. So in this case we keep the\n  // awkward abbreviation.\n  lstat: typeof lstatType = (...options) =>\n    // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n    lstat(this.#path, ...options) as any;\n\n  static get homedir(): Path {\n    return new Path(homedir());\n  }\n\n  static xdg = {\n    cache: new Path(xdgCache ?? Path.homedir.join(\".cache\")),\n    config: new Path(xdgConfig ?? Path.homedir.join(\".config\")),\n    data: new Path(xdgData ?? Path.homedir.join(\".local/share\")),\n    state: new Path(xdgState ?? Path.homedir.join(\".local/state\")),\n    /**\n     * {@link Path.xdg.runtime} does not have a default value. Consider\n     * {@link Path.xdg.runtimeWithStateFallback} if you need a fallback but do not have a particular fallback in mind.\n     */\n    runtime: xdgRuntime ? new Path(xdgRuntime) : undefined,\n    runtimeWithStateFallback: xdgRuntime\n      ? new Path(xdgRuntime)\n      : new Path(xdgState ?? Path.homedir.join(\".local/state\")),\n  };\n\n  /** Chainable function to print the path. Prints the same as:\n   *\n   *     if (args.length > 0) {\n   *      console.log(...args);\n   *     }\n   *     console.log(this.path);\n   *\n   */\n  // biome-ignore lint/suspicious/noExplicitAny: This is the correct type, based on `console.log(\u2026)`.\n  debugPrint(...args: any[]): Path {\n    if (args.length > 0) {\n      console.log(...args);\n    }\n    console.log(this.#path);\n    return this;\n  }\n}\n\n/**\n * This function is useful to serialize any `Path`s in a structure to pass on to\n * functions that do not know about the `Path` class, e.g.\n *\n *     function process(args: (string | Path)[]) {\n *       const argsAsStrings = args.map(stringifyIfPath);\n *     }\n *\n */\nexport function stringifyIfPath<T>(value: T | Path): T | string {\n  if (value instanceof Path) {\n    return value.toString();\n  }\n  return value;\n}\n\nexport function mustNotHaveTrailingSlash(path: Path): void {\n  if (path.hasTrailingSlash()) {\n    throw new Error(\n      \"Path ends with a slash, which cannot be treated as a file.\",\n    );\n  }\n}\n"],
+  "mappings": ";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,SAAS,cAAc;AAChC,SAAS,UAAU,SAAS,SAAS,YAAY;AACjD,SAAS,gBAAgB;AACzB,SAAS,eAAe,qBAAqB;AAC7C;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAaP,eAAe,oBACb,MAC0C;AAC1C,SAAO,MAAM;AACb,MAAI,gBAAgB,UAAU;AAC5B,WAAO,KAAK,OAAO,SAAS,QAAQ,KAAK,IAAI,IAAI,IAAI,WAAW,CAAC;AAAA,EACnE;AACA,MAAI,gBAAgB,gBAAgB;AAClC,WAAO,SAAS,QAAQ,IAAI;AAAA,EAC9B;AACA,SAAO;AACT;AAEO,IAAK,mBAAL,kBAAKA,sBAAL;AACL,EAAAA,kBAAA,cAAW;AACX,EAAAA,kBAAA,cAAW;AACX,EAAAA,kBAAA,UAAO;AAHG,SAAAA;AAAA,GAAA;AAMZ,SAAS,iBAAiB,YAAsC;AAC9D,MAAI,WAAW,WAAW,GAAG,GAAG;AAC9B,WAAO;AAAA,EACT,WAAW,WAAW,WAAW,IAAI,GAAG;AACtC,WAAO;AAAA,EACT,WAAW,eAAe,KAAK;AAC7B,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,OAAN,MAAM,MAAK;AAAA;AAAA,EAEhB;AAAA;AAAA;AAAA;AAAA,EAIA,YAAY,MAA2B;AACrC,UAAM,IAAI,MAAK,kBAAkB,IAAI;AACrC,SAAK,mBAAmB,CAAC;AAAA,EAC3B;AAAA,EAEA,IAAI,mBAAqC;AACvC,WAAO,iBAAiB,KAAK,KAAK;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAO,QAAQ,MAA2B,MAAiC;AACzE,UAAM,WAAW,MAAM;AACrB,UAAI,EAAE,gBAAgB,QAAO;AAC3B,YAAI,OAAO,SAAS,YAAY,CAAC,KAAK,WAAW,SAAS,GAAG;AAC3D,iBAAO,cAAc,IAAI;AAAA,QAC3B;AACA,eAAO;AAAA,MACT;AACA,UAAI,CAAC,KAAK,eAAe,GAAG;AAC1B,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AACA,aAAO,cAAc,KAAK,KAAK;AAAA,IACjC,GAAG;AACH,WAAO,IAAI,MAAK,IAAI,IAAI,MAAK,kBAAkB,IAAI,GAAG,OAAO,CAAC;AAAA,EAChE;AAAA,EAEA,OAAO,kBAAkB,MAAmC;AAC1D,QAAI,gBAAgB,OAAM;AACxB,aAAO,KAAK;AAAA,IACd;AACA,QAAI,gBAAgB,KAAK;AACvB,aAAO,cAAc,IAAI;AAAA,IAC3B;AACA,QAAI,OAAO,SAAS,UAAU;AAE5B,UAAI,KAAK,WAAW,UAAU,GAAG;AAC/B,eAAO,cAAc,IAAI;AAAA,MAC3B;AACA,aAAO;AAAA,IACT;AACA,UAAM,IAAI,MAAM,cAAc;AAAA,EAChC;AAAA;AAAA,EAGA,mBAAmB,MAAoB;AACrC,UAAM,SAAS,iBAAiB,IAAI;AACpC,SAAK,QAAQ,KAAK,IAAI;AACtB,QAAI,WAAW,6BAA6B,CAAC,KAAK,MAAM,WAAW,GAAG,GAAG;AAEvE,WAAK,QAAQ,KAAK,KAAK,KAAK;AAAA,IAC9B;AAAA,EACF;AAAA,EAEA,iBAA0B;AACxB,WAAO,KAAK,qBAAqB;AAAA,EACnC;AAAA,EAEA,YAAiB;AACf,QAAI,CAAC,KAAK,eAAe,GAAG;AAC1B,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AACA,WAAO,cAAc,KAAK,KAAK;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,mBAA4B;AAE1B,WAAO,KAAK,MAAM,SAAS,GAAG;AAAA,EAChC;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,OAAO;AACT,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,WAAmB;AACjB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKA,QAAQ,UAAmC;AACzC,UAAM,iBAAiB,SAAS,IAAI,CAAC,YAAY;AAC/C,YAAM,IAAI,gBAAgB,OAAO;AACjC,UAAI,iBAAiB,CAAC,MAAM,2BAA2B;AACrD,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AACA,aAAO;AAAA,IACT,CAAC;AACD,WAAO,IAAI,MAAK,KAAK,KAAK,OAAO,GAAG,cAAc,CAAC;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAmB;AACjB,WAAO,IAAI,MAAK,KAAK,KAAK,KAAK,EAAE;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAmB;AACjB,WAAO,IAAI,MAAK,KAAK,KAAK,KAAK,KAAK,CAAC;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmCA,OAAO,SAGE;AACP,UAAM,OAAO,IAAI,MAAK,KAAK,KAAK,KAAK,KAAK,CAAC;AAC3C,QAAI,CAAC,KAAK,MAAM,WAAW,KAAK,KAAK,KAAK,UAAU,MAAM;AACxD,UACE,SAAS,+BACT,KAAK,qBAAqB,2BAC1B;AACA,cAAM,IAAI,MAAM,+CAA+C;AAAA,MACjE;AACA,aAAO;AAAA,IACT;AACA,UAAM,0BACJ,SAAS,iCAAiC;AAC5C,YAAQ,yBAAyB;AAAA,MAC/B,KAAK,SAAS;AACZ,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,MACA,KAAK,SAAS;AACZ,YAAI,UAAU,KAAK,MAAM,QAAQ,cAAc,EAAE;AACjD,YAAI,CAAC,IAAI,IAAI,EAAE,SAAS,OAAO,GAAG;AAChC,oBAAU;AAAA,QACZ;AACA,cAAM,SAAS,IAAI,MAAK,OAAO;AAC/B,YACE,SAAS,+BACT,OAAO,qBAAqB,2BAC5B;AACA,gBAAM,IAAI,MAAM,+CAA+C;AAAA,QACjE;AACA,eAAO,IAAI,MAAK,OAAO;AAAA,MACzB;AAAA,MACA,KAAK,QAAQ;AACX,YAAI,SAAS,6BAA6B;AACxC,gBAAM,IAAI,MAAM,+CAA+C;AAAA,QACjE;AACA,eAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAAA,EAEA,eAAe,QAAsB;AACnC,UAAM,eAAe,KAAK,MAAM;AAChC,QAAI,iBAAiB,SAAS,YAAY,GAAG;AAC3C,YAAM,IAAI,MAAM,qCAAqC;AAAA,IACvD;AAEA,WAAO,IAAI,MAAK,KAAK,QAAQ,YAAY;AAAA,EAC3C;AAAA,EAEA,IAAI,SAAe;AACjB,WAAO,IAAI,MAAK,QAAQ,KAAK,KAAK,CAAC;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,UAAgB;AAClB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,WAAiB;AACnB,WAAO,IAAI,MAAK,SAAS,KAAK,KAAK,CAAC;AAAA,EACtC;AAAA,EAEA,IAAI,YAAoB;AACtB,6BAAyB,IAAI;AAC7B,WAAO,QAAQ,KAAK,KAAK;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,UAAkB;AACpB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA,EAGA,MAAM,OAAO,aAEQ;AACnB,QAAI;AACJ,QAAI;AACF,cAAQ,MAAM,KAAK,KAAK,KAAK;AAAA,IAE/B,SAAS,GAAQ;AACf,UAAI,EAAE,SAAS,UAAU;AACvB,eAAO;AAAA,MACT;AACA,YAAM;AAAA,IACR;AACA,QAAI,CAAC,aAAa,QAAQ;AACxB,aAAO;AAAA,IACT;AACA,YAAQ,aAAa,QAAQ;AAAA,MAC3B,KAAK,QAAQ;AACX,iCAAyB,IAAI;AAC7B,YAAI,MAAM,OAAO,GAAG;AAClB,iBAAO;AAAA,QACT;AACA,cAAM,IAAI,MAAM,kCAAkC,KAAK,KAAK,EAAE;AAAA,MAChE;AAAA,MACA,KAAK,aAAa;AAChB,YAAI,MAAM,YAAY,GAAG;AACvB,iBAAO;AAAA,QACT;AACA,cAAM,IAAI,MAAM,uCAAuC,KAAK,KAAK,EAAE;AAAA,MACrE;AAAA,MACA,SAAS;AACP,cAAM,IAAI,MAAM,8BAA8B;AAAA,MAChD;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,eAAiC;AACrC,WAAO,KAAK,OAAO,EAAE,QAAQ,OAAO,CAAC;AAAA,EACvC;AAAA,EAEA,MAAM,cAAgC;AACpC,WAAO,KAAK,OAAO,EAAE,QAAQ,YAAY,CAAC;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,MAAM,SAAsD;AAChE,UAAM,iBAAiB,MAAM;AAC3B,UAAI,OAAO,YAAY,YAAY,OAAO,YAAY,UAAU;AAC9D,eAAO,EAAE,MAAM,QAAQ;AAAA,MACzB;AACA,aAAO,WAAW,CAAC;AAAA,IACrB,GAAG;AACH,UAAM,MAAM,KAAK,OAAO,EAAE,WAAW,MAAM,GAAG,cAAc,CAAC;AAC7D,WAAO;AAAA,EACT;AAAA;AAAA;AAAA,EAIA,MAAM,GACJ,aACA,SACe;AACf,UAAM,GAAG,KAAK,OAAO,IAAI,MAAK,WAAW,EAAE,OAAO,OAAO;AACzD,WAAO,IAAI,MAAK,WAAW;AAAA,EAC7B;AAAA;AAAA,EAGA,MAAM,OAAO,aAAiD;AAC5D,UAAM,OAAO,KAAK,OAAO,IAAI,MAAK,WAAW,EAAE,KAAK;AAAA,EACtD;AAAA;AAAA,EAGA,aAAa,YAAY,QAAgC;AACvD,WAAO,IAAI;AAAA,MACT,MAAM,QAAQ,IAAI,MAAK,OAAO,CAAC,EAAE,KAAK,UAAU,UAAU,EAAE,SAAS,CAAC;AAAA,IACxE;AAAA,EACF;AAAA,EAEA,MAAM,GAAG,SAAmD;AAC1D,UAAM,GAAG,KAAK,OAAO,OAAO;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,MAAM,SAAmD;AAC7D,UAAM,KAAK,GAAG,EAAE,WAAW,MAAM,OAAO,MAAM,GAAI,WAAW,CAAC,EAAG,CAAC;AAAA,EACpE;AAAA,EAEA,OAA4B,CAAC;AAAA;AAAA,IAE3B,SAAS,KAAK,OAAO,OAAc;AAAA;AAAA,EAErC,MAAM,WAA4B;AAChC,WAAO,SAAS,KAAK,OAAO,OAAO;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAM,SAAkB,SAAwC;AAC9D,QAAI;AACF,aAAO,KAAK,MAAM,MAAM,KAAK,SAAS,CAAC;AAAA,IACzC,SAAS,GAAG;AACV,UACG,EAAwB,SAAS,YAClC,WACA,cAAc,SACd;AACA,eAAO,QAAQ;AAAA,MACjB;AACA,YAAM;AAAA,IACR;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,WACJ,MACA,SACe;AACf,UAAM,WAAW,KAAK,OAAO,MAAM,OAAO;AAC1C,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,MACJ,MACA,SACe;AACf,UAAM,KAAK,OAAO,MAAM;AACxB,UAAM,UAAU,KAAK,OAAO,MAAM,oBAAoB,IAAI,GAAG,OAAO;AACpE,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,UACJ,MACA,WAAiD,MACjD,QAA8C,MAC/B;AACf,UAAM,KAAK,MAAM,KAAK,UAAU,MAAM,UAAU,KAAK,CAAC;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAA8B,CAAC;AAAA;AAAA,IAE7B,QAAQ,KAAK,OAAO,OAAc;AAAA;AAAA;AAAA,EAGpC,MAAM,QACJ,QACA,MACe;AACf,UAAM,aAAa,IAAI,MAAK,MAAM;AAClC,UAAM;AAAA,MACJ,KAAK;AAAA,MACL,WAAW;AAAA,MACX;AAAA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,WAA0B;AAC9B,WAAO,IAAI,MAAK,MAAM,SAAS,KAAK,OAAO,OAAO,CAAC;AAAA,EACrD;AAAA;AAAA,EAGA,OAAwB,IAAI,YAAY,KAAK,KAAK,OAAO,GAAG,OAAO;AAAA;AAAA;AAAA;AAAA,EAKnE,QAA0B,IAAI;AAAA;AAAA,IAE5B,MAAM,KAAK,OAAO,GAAG,OAAO;AAAA;AAAA,EAE9B,WAAW,UAAgB;AACzB,WAAO,IAAI,MAAK,QAAQ,CAAC;AAAA,EAC3B;AAAA,EAEA,OAAO,MAAM;AAAA,IACX,OAAO,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,QAAQ,CAAC;AAAA,IACvD,QAAQ,IAAI,MAAK,aAAa,MAAK,QAAQ,KAAK,SAAS,CAAC;AAAA,IAC1D,MAAM,IAAI,MAAK,WAAW,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA,IAC3D,OAAO,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7D,SAAS,aAAa,IAAI,MAAK,UAAU,IAAI;AAAA,IAC7C,0BAA0B,aACtB,IAAI,MAAK,UAAU,IACnB,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,cAAc,MAAmB;AAC/B,QAAI,KAAK,SAAS,GAAG;AACnB,cAAQ,IAAI,GAAG,IAAI;AAAA,IACrB;AACA,YAAQ,IAAI,KAAK,KAAK;AACtB,WAAO;AAAA,EACT;AACF;AAWO,SAAS,gBAAmB,OAA6B;AAC9D,MAAI,iBAAiB,MAAM;AACzB,WAAO,MAAM,SAAS;AAAA,EACxB;AACA,SAAO;AACT;AAEO,SAAS,yBAAyB,MAAkB;AACzD,MAAI,KAAK,iBAAiB,GAAG;AAC3B,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACF;",
+  "names": ["ResolutionPrefix"]
+}

package/dist/lib/path-class/index.js

@@ -1,10 +1,12 @@
 import {
   Path,
+  ResolutionPrefix,
   mustNotHaveTrailingSlash,
   stringifyIfPath
-} from "./chunks/chunk-3W742CSF.js";
+} from "./chunks/chunk-6KFFVP6T.js";
 export {
   Path,
+  ResolutionPrefix,
   mustNotHaveTrailingSlash,
   stringifyIfPath
 };

package/dist/lib/path-class/sync/index.js

@@ -1,7 +1,7 @@
 import {
   Path,
   mustNotHaveTrailingSlash
-} from "../chunks/chunk-3W742CSF.js";
+} from "../chunks/chunk-6KFFVP6T.js";
 
 // src/sync/index.ts
 import {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "path-class",
-  "version": "0.8.3",
+  "version": "0.10.0",
   "author": "Lucas Garron <code@garron.net>",
   "type": "module",
   "main": "./dist/lib/path-class/index.js",
@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "@types/node": "^24.7.1",
-    "readme-cli-help": "^0.1.10",
+    "readme-cli-help": ">=0.3.1",
     "xdg-basedir": "^5.1.0"
   },
   "files": [

package/src/Path.test.ts

@@ -4,12 +4,21 @@ import { join } from "node:path";
 import { Path, stringifyIfPath } from "./Path";
 
 test("constructor", async () => {
-  expect(new Path("foo").path).toEqual("foo");
-  expect(new Path("./relative").path).toEqual("relative");
-  expect(new Path("./relative/nested").path).toEqual("relative/nested");
+  expect(new Path("bare").path).toEqual("bare");
+  expect(new Path("bare/").path).toEqual("bare/");
+  expect(new Path("bare/path").path).toEqual("bare/path");
+  expect(new Path("bare/path/").path).toEqual("bare/path/");
+  expect(new Path("./relative").path).toEqual("./relative");
+  expect(new Path("./relative/").path).toEqual("./relative/");
+  expect(new Path("./relative/nested").path).toEqual("./relative/nested");
+  expect(new Path("./relative/nested/").path).toEqual("./relative/nested/");
   expect(new Path("/absolute").path).toEqual("/absolute");
+  expect(new Path("/absolute/").path).toEqual("/absolute/");
   expect(new Path("/absolute/nested").path).toEqual("/absolute/nested");
-  expect(new Path("trailing/slash/").path).toEqual("trailing/slash/");
+  expect(new Path("/absolute/nested/").path).toEqual("/absolute/nested/");
+  expect(new Path("./down/../again").path).toEqual("./again");
+  expect(new Path("down/../again").path).toEqual("again");
+  expect(new Path("down/..").path).toEqual(".");
 });
 
 test("Path.resolve(…)", async () => {
@@ -50,8 +59,10 @@ test(".hasTrailingSlash()", async () => {
   expect(new Path("foo/bar").hasTrailingSlash()).toBe(false);
   expect(new Path("foo/bar/").hasTrailingSlash()).toBe(true);
   expect(new Path(import.meta.url).hasTrailingSlash()).toBe(false);
-  expect(new Path(import.meta.url).join("/").hasTrailingSlash()).toBe(true);
-  expect(new Path(import.meta.url).join("/.").hasTrailingSlash()).toBe(false);
+  expect(new Path(import.meta.url).join("foo/").hasTrailingSlash()).toBe(true);
+  expect(new Path(import.meta.url).join("bar/.").hasTrailingSlash()).toBe(
+    false,
+  );
   expect(new Path(import.meta.url).join(".").hasTrailingSlash()).toBe(false);
 });
 
@@ -72,7 +83,114 @@ test(".join(…)", async () => {
   expect(
     new Path("foo/bar").join("bath", new Path("kitchen/sink")).path,
   ).toEqual("foo/bar/bath/kitchen/sink");
-  expect(new Path("foo").join(new Path("/bar")).path).toEqual("foo/bar");
+  expect(() => new Path("foo").join(new Path("/bar")).path).toThrow(
+    "Arguments to `.join(…)` cannot be absolute. Use `.asRelative()` to convert them first if needed.",
+  );
+});
+
+test("asRelative()", async () => {
+  // From doc comment
+  expect(new Path("bare").asRelative().path).toEqual("./bare");
+  expect(new Path("./relative").asRelative().path).toEqual("./relative");
+  expect(new Path("../up-first").asRelative().path).toEqual("../up-first");
+  expect(new Path("/absolute").asRelative().path).toEqual("./absolute");
+  // Other
+  expect(new Path("./bar/../foo").asRelative().path).toEqual("./foo");
+  expect(new Path("./bar/../../").asRelative().path).toEqual("../");
+  expect(new Path("././").asRelative().path).toEqual("./");
+  expect(new Path("..").asRelative().path).toEqual("..");
+  expect(new Path("../").asRelative().path).toEqual("../");
+  expect(new Path("/abs/").asRelative().path).toEqual("./abs/");
+  expect(new Path("bare/").asRelative().path).toEqual("./bare/");
+  expect(new Path("./rel/").asRelative().path).toEqual("./rel/");
+  expect(new Path("../up/").asRelative().path).toEqual("../up/");
+});
+
+test("asAbsolute()", async () => {
+  // From doc comment
+  expect(new Path("bare").asAbsolute().path).toEqual("/bare");
+  expect(new Path("./relative").asAbsolute().path).toEqual("/relative");
+  expect(new Path("../up-first").asAbsolute().path).toEqual("/up-first");
+  expect(new Path("/absolute").asAbsolute().path).toEqual("/absolute");
+  // Other
+  expect(new Path("/abs/").asAbsolute().path).toEqual("/abs/");
+  expect(new Path("bare/").asAbsolute().path).toEqual("/bare/");
+  expect(new Path("../up/").asAbsolute().path).toEqual("/up/");
+});
+
+test("asBare(…)", async () => {
+  const ERROR_1 =
+    'Converting path to a bare path resulted in a `..` traversal prefix. Pass `"strip"` or `"keep"` as the `parentTraversalHandling` option to avoid an error.';
+  const ERROR_2 = "Output does not start with a named component.";
+  // From doc comment (default)
+  expect(new Path("bare").asBare().path).toEqual("bare");
+  expect(new Path("./relative").asBare().path).toEqual("relative");
+  expect(new Path(".").asBare().path).toEqual(".");
+  expect(new Path("down-first/..").asBare().path).toEqual(".");
+  expect(() => new Path("../up-first").asBare().path).toThrow(ERROR_1);
+  expect(() => new Path("..").asBare().path).toThrow(ERROR_1);
+  expect(new Path("/absolute").asBare().path).toEqual("absolute");
+  // From doc comment (strip)
+  expect(
+    new Path("../up-first").asBare({ parentTraversalPrefixHandling: "strip" })
+      .path,
+  ).toEqual("up-first");
+  expect(
+    new Path("..").asBare({ parentTraversalPrefixHandling: "strip" }).path,
+  ).toEqual(".");
+  // From doc comment (keep)
+  expect(
+    new Path("../up-first").asBare({ parentTraversalPrefixHandling: "keep" })
+      .path,
+  ).toEqual("../up-first");
+  expect(
+    new Path("..").asBare({ parentTraversalPrefixHandling: "keep" }).path,
+  ).toEqual("..");
+  // Other
+  expect(new Path(".").asBare().asBare().path).toEqual(".");
+  expect(new Path("./").asBare().asBare().path).toEqual("./");
+  expect(new Path("/abs/").asBare().asBare().path).toEqual("abs/");
+  expect(new Path("bare/").asBare().asBare().path).toEqual("bare/");
+  expect(() => new Path("../up/").asBare().path).toThrow(ERROR_1);
+  expect(() => new Path("./down/down/../../..").asBare().path).toThrow(ERROR_1);
+  expect(() => new Path("..").asBare().path).toThrow(ERROR_1);
+  expect(() => new Path("../../up/").asBare().path).toThrow(ERROR_1);
+  // parentTraversalPrefixHandling
+  expect(
+    new Path("../../up/").asBare({ parentTraversalPrefixHandling: "strip" })
+      .path,
+  ).toEqual("up/");
+  expect(
+    new Path("../../up/").asBare({ parentTraversalPrefixHandling: "keep" })
+      .path,
+  ).toEqual("../../up/");
+  expect(
+    new Path("../..").asBare({ parentTraversalPrefixHandling: "strip" }).path,
+  ).toEqual(".");
+  expect(
+    new Path("../../").asBare({ parentTraversalPrefixHandling: "strip" }).path,
+  ).toEqual(".");
+  // requireNamedComponentPrefix
+  expect(
+    () =>
+      new Path(".").asBare({
+        requireNamedComponentPrefix: true,
+      }).path,
+  ).toThrow(ERROR_2);
+  expect(
+    () =>
+      new Path("../../").asBare({
+        parentTraversalPrefixHandling: "strip",
+        requireNamedComponentPrefix: true,
+      }).path,
+  ).toThrow(ERROR_2);
+  expect(
+    () =>
+      new Path("./").asBare({
+        parentTraversalPrefixHandling: "strip",
+        requireNamedComponentPrefix: true,
+      }).path,
+  ).toThrow(ERROR_2);
 });
 
 test("traverse", async () => {
@@ -405,8 +523,11 @@ test(".xdg", async () => {
 const spy = spyOn(console, "log");
 
 test(".debugPrint(…)", async () => {
-  Path.homedir.debugPrint("foo");
-  expect(spy.mock.calls).toEqual([["foo"], ["/mock/home/dir"]]);
+  Path.homedir.debugPrint("Here is a test log of the mock home directory:");
+  expect(spy.mock.calls).toEqual([
+    ["Here is a test log of the mock home directory:"],
+    ["/mock/home/dir"],
+  ]);
 });
 
 test(".stringifyIfPath(…)", async () => {

package/src/Path.ts

@@ -49,6 +49,23 @@ async function wrangleWritableData(
   return data;
 }
 
+export enum ResolutionPrefix {
+  Absolute = "absolute",
+  Relative = "relative",
+  Bare = "bare",
+}
+
+function resolutionPrefix(pathString: string): ResolutionPrefix {
+  if (pathString.startsWith("/")) {
+    return ResolutionPrefix.Absolute;
+  } else if (pathString.startsWith("./")) {
+    return ResolutionPrefix.Relative;
+  } else if (pathString === ".") {
+    return ResolutionPrefix.Relative;
+  }
+  return ResolutionPrefix.Bare;
+}
+
 export class Path {
   // @ts-expect-error ts(2564): False positive. https://github.com/microsoft/TypeScript/issues/32194
   #path: string;
@@ -56,7 +73,12 @@ export class Path {
    * If `path` is a string starting with `file:///`, it will be parsed as a file URL.
    */
   constructor(path: string | URL | Path) {
-    this.#setNormalizedPath(Path.#pathlikeToString(path));
+    const s = Path.#pathlikeToString(path);
+    this.#setNormalizedPath(s);
+  }
+
+  get resolutionPrefix(): ResolutionPrefix {
+    return resolutionPrefix(this.#path);
   }
 
   /**
@@ -70,6 +92,9 @@ export class Path {
   static resolve(path: string | URL | Path, base: string | URL | Path): Path {
     const baseURL = (() => {
       if (!(base instanceof Path)) {
+        if (typeof base === "string" && !base.startsWith("file://")) {
+          return pathToFileURL(base);
+        }
         return base;
       }
       if (!base.isAbsolutePath()) {
@@ -99,12 +124,18 @@ export class Path {
     throw new Error("Invalid path");
   }
 
+  // Preserves the `ResolutionPrefix` status when possible.
   #setNormalizedPath(path: string): void {
+    const prefix = resolutionPrefix(path);
     this.#path = join(path);
+    if (prefix === ResolutionPrefix.Relative && !this.#path.startsWith(".")) {
+      // We don't have to handle the case of `"."`, as it already starts with `"."`
+      this.#path = `./${this.#path}`;
+    }
   }
 
   isAbsolutePath(): boolean {
-    return this.#path.startsWith("/");
+    return this.resolutionPrefix === ResolutionPrefix.Absolute;
   }
 
   toFileURL(): URL {
@@ -144,12 +175,126 @@ export class Path {
    * This follows `node` semantics for absolute paths: leading slashes in the given descendant segments are ignored.
    */
   join(...segments: (string | Path)[]): Path {
-    const segmentStrings = segments.map((segment) =>
-      segment instanceof Path ? segment.path : segment,
-    );
+    const segmentStrings = segments.map((segment) => {
+      const s = stringifyIfPath(segment);
+      if (resolutionPrefix(s) === ResolutionPrefix.Absolute) {
+        throw new Error(
+          "Arguments to `.join(…)` cannot be absolute. Use `.asRelative()` to convert them first if needed.",
+        );
+      }
+      return s;
+    });
     return new Path(join(this.#path, ...segmentStrings));
   }
 
+  /**
+   * Adjust the prefix to construct a relative path.
+   *
+   * | Example input   | Output          |
+   * |-----------------|-----------------|
+   * | `"bare"`        | `"./bare"`      |
+   * | `"./relative"`  | `"./relative"`  |
+   * | `"../up-first"` | `"../up-first"` |
+   * | `"/absolute"`   | `"./absolute"`  |
+   *
+   */
+  asRelative(): Path {
+    return new Path(`./${this.#path}`);
+  }
+
+  /**
+   * Adjust the prefix to construct an absolute path.
+   *
+   * | Example input   | Output        |
+   * |-----------------|---------------|
+   * | `"bare"`        | `"/bare"`     |
+   * | `"./relative"`  | `"/relative"` |
+   * | `"../up-first"` | `"/up-first"` |
+   * | `"/absolute"`   | `"/absolute"` |
+   *
+   */
+  asAbsolute(): Path {
+    return new Path(join("/", this.#path));
+  }
+
+  /**
+   * Adjust the prefix to construct a bare path. Note that this returns `"."` if
+   * there are no named paths left.
+   *
+   * | Example input     | Output       |
+   * |-------------------|--------------|
+   * | `"bare"`          | `"bare"`     |
+   * | `"./relative"  `  | `"relative"` |
+   * | `"/absolute"`     | `"absolute"` |
+   * | `"."`             | `"."`        |
+   * | `"down-first/.."` | `"."`        |
+   * | `"../up-first"`   | (error)      |
+   * | `".."`            | (error)      |
+   *
+   * Specify `parentTraversalPrefixHandling` in the `options` if you would like
+   * to strip or keep resolution prefixes like `../` rather than erroring.
+   *
+   * | Example input        | Output with `{ parentTraversalPrefixHandling: "strip" }` |
+   * |----------------------|----------------------------------------------------------|
+   * | `"../up-first"`      | `"up-first"`                                             |
+   * | `".."`               | `"."`                                                    |
+   *
+   * | Example input        | Output with `{ parentTraversalPrefixHandling: "keep" }` |
+   * |----------------------|---------------------------------------------------------|
+   * | `"../up-first"`      | `"../up-first"`                                         |
+   * | `".."`               | `".."`                                                  |
+   *
+   * If you need the output to start with a named component and return values
+   * like `.`, `..`, `../`, or `../…` are not okay, pass
+   * `requireNamedComponentPrefix: true`. This is useful if the path represents
+   * an `npm`-style package name (e.g. `"typescript"`, `"@biomejs/biome"`).
+   *
+   */
+  asBare(options?: {
+    parentTraversalPrefixHandling?: "error" | "strip" | "keep";
+    requireNamedComponentPrefix?: boolean;
+  }): Path {
+    const path = new Path(join(".", this.#path));
+    if (!path.#path.startsWith("../") && path.#path !== "..") {
+      if (
+        options?.requireNamedComponentPrefix &&
+        path.resolutionPrefix === ResolutionPrefix.Relative
+      ) {
+        throw new Error("Output does not start with a named component.");
+      }
+      return path;
+    }
+    const parentTraversalHandling =
+      options?.parentTraversalPrefixHandling ?? "error";
+    switch (parentTraversalHandling) {
+      case "error": {
+        throw new Error(
+          'Converting path to a bare path resulted in a `..` traversal prefix. Pass `"strip"` or `"keep"` as the `parentTraversalHandling` option to avoid an error.',
+        );
+      }
+      case "strip": {
+        let newPath = path.#path.replace(/^(\.\.\/)+/, "");
+        if (["", ".."].includes(newPath)) {
+          newPath = ".";
+        }
+        const output = new Path(newPath);
+        if (
+          options?.requireNamedComponentPrefix &&
+          output.resolutionPrefix === ResolutionPrefix.Relative
+        ) {
+          throw new Error("Output does not start with a named component.");
+        }
+        return new Path(newPath);
+      }
+      case "keep": {
+        if (options?.requireNamedComponentPrefix) {
+          throw new Error("Output does not start with a named component.");
+        }
+        return path;
+      }
+    }
+  }
+
   extendBasename(suffix: string): Path {
     const joinedSuffix = join(suffix);
     if (joinedSuffix !== basename(joinedSuffix)) {

package/dist/lib/path-class/chunks/chunk-3W742CSF.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../../src/Path.ts"],
-  "sourcesContent": ["import {\n  appendFile,\n  cp,\n  lstat,\n  mkdir,\n  mkdtemp,\n  readdir,\n  readFile,\n  realpath,\n  rename,\n  rm,\n  stat,\n  symlink,\n  writeFile,\n} from \"node:fs/promises\";\nimport { homedir, tmpdir } from \"node:os\";\nimport { basename, dirname, extname, join } from \"node:path\";\nimport { Readable } from \"node:stream\";\nimport { fileURLToPath, pathToFileURL } from \"node:url\";\nimport {\n  xdgCache,\n  xdgConfig,\n  xdgData,\n  xdgRuntime,\n  xdgState,\n} from \"xdg-basedir\";\nimport type {\n  lstatType,\n  readDirType,\n  readFileType,\n  statType,\n} from \"./modifiedNodeTypes\";\n\n// Note that (non-static) functions in this file are defined using `function(\u2026)\n// { \u2026 }` rather than arrow functions, specifically because we want `this` to\n// operate on the `Path` instance.\n\ntype WritableData = Parameters<typeof writeFile>[1] | ReadableStream | Response;\nasync function wrangleWritableData(\n  data: WritableData | Promise<WritableData>,\n): Promise<Parameters<typeof writeFile>[1]> {\n  data = await data;\n  if (data instanceof Response) {\n    data = data.body ? Readable.fromWeb(data.body) : new Uint8Array(0);\n  }\n  if (data instanceof ReadableStream) {\n    data = Readable.fromWeb(data);\n  }\n  return data;\n}\n\nexport class Path {\n  // @ts-expect-error ts(2564): False positive. https://github.com/microsoft/TypeScript/issues/32194\n  #path: string;\n  /**\n   * If `path` is a string starting with `file:///`, it will be parsed as a file URL.\n   */\n  constructor(path: string | URL | Path) {\n    this.#setNormalizedPath(Path.#pathlikeToString(path));\n  }\n\n  /**\n   * Similar to `new URL(path, base)`, but accepting and returning `Path` objects.\n   * Note that `base` must be one of:\n   *\n   * - a valid second argument to `new URL(\u2026)`.\n   * - a `Path` representing an absolute path.\n   *\n   */\n  static resolve(path: string | URL | Path, base: string | URL | Path): Path {\n    const baseURL = (() => {\n      if (!(base instanceof Path)) {\n        return base;\n      }\n      if (!base.isAbsolutePath()) {\n        throw new Error(\n          \"The `base` arg to `Path.resolve(\u2026)` must be an absolute path.\",\n        );\n      }\n      return pathToFileURL(base.#path);\n    })();\n    return new Path(new URL(Path.#pathlikeToString(path), baseURL));\n  }\n\n  static #pathlikeToString(path: string | URL | Path): string {\n    if (path instanceof Path) {\n      return path.#path;\n    }\n    if (path instanceof URL) {\n      return fileURLToPath(path);\n    }\n    if (typeof path === \"string\") {\n      // TODO: allow turning off this heuristic?\n      if (path.startsWith(\"file:///\")) {\n        return fileURLToPath(path);\n      }\n      return path;\n    }\n    throw new Error(\"Invalid path\");\n  }\n\n  #setNormalizedPath(path: string): void {\n    this.#path = join(path);\n  }\n\n  isAbsolutePath(): boolean {\n    return this.#path.startsWith(\"/\");\n  }\n\n  toFileURL(): URL {\n    if (!this.isAbsolutePath()) {\n      throw new Error(\n        \"Tried to convert to file URL when the path is not absolute.\",\n      );\n    }\n    return pathToFileURL(this.#path);\n  }\n\n  /**\n   * The `Path` can have a trailing slash, indicating that it represents a\n   * directory. (If there is no trailing slash, it can represent either a file\n   * or a directory.)\n   *\n   * Some operations will refuse to treat a directory path as a file path. This\n   * function identifies such paths.\n   */\n  hasTrailingSlash(): boolean {\n    // TODO: handle Windows semantically\n    return this.#path.endsWith(\"/\");\n  }\n\n  /**\n   * Same as `.toString()`, but more concise.\n   */\n  get path() {\n    return this.#path;\n  }\n\n  toString(): string {\n    return this.#path;\n  }\n\n  /** Constructs a new path by appending the given path segments.\n   * This follows `node` semantics for absolute paths: leading slashes in the given descendant segments are ignored.\n   */\n  join(...segments: (string | Path)[]): Path {\n    const segmentStrings = segments.map((segment) =>\n      segment instanceof Path ? segment.path : segment,\n    );\n    return new Path(join(this.#path, ...segmentStrings));\n  }\n\n  extendBasename(suffix: string): Path {\n    const joinedSuffix = join(suffix);\n    if (joinedSuffix !== basename(joinedSuffix)) {\n      throw new Error(\"Invalid suffix to extend file name.\");\n    }\n    // TODO: join basename and dirname instead?\n    return new Path(this.#path + joinedSuffix);\n  }\n\n  get parent(): Path {\n    return new Path(dirname(this.#path));\n  }\n\n  // Normally I'd stick with `node`'s name, but I think `.dirname` is a\n  // particularly poor name. So we support `.dirname` for discovery but mark it\n  // as deprecated, even if it will never be removed.\n  /** @deprecated Alias for `.parent`. */\n  get dirname(): Path {\n    return this.parent;\n  }\n\n  get basename(): Path {\n    return new Path(basename(this.#path));\n  }\n\n  get extension(): string {\n    mustNotHaveTrailingSlash(this);\n    return extname(this.#path);\n  }\n\n  // Normally I'd stick with `node`'s name, but I think `.extname` is a\n  // particularly poor name. So we support `.extname` for discovery but mark it\n  // as deprecated, even if it will never be removed.\n  /** @deprecated Alias for `.extension`. */\n  get extname(): string {\n    return this.extension;\n  }\n\n  // TODO: find a neat way to dedup with the sync version?\n  async exists(constraints?: {\n    mustBe: \"file\" | \"directory\";\n  }): Promise<boolean> {\n    let stats: Awaited<ReturnType<typeof stat>>;\n    try {\n      stats = await stat(this.#path);\n      // biome-ignore lint/suspicious/noExplicitAny: TypeScript limitation\n    } catch (e: any) {\n      if (e.code === \"ENOENT\") {\n        return false;\n      }\n      throw e;\n    }\n    if (!constraints?.mustBe) {\n      return true;\n    }\n    switch (constraints?.mustBe) {\n      case \"file\": {\n        mustNotHaveTrailingSlash(this);\n        if (stats.isFile()) {\n          return true;\n        }\n        throw new Error(`Path exists but is not a file: ${this.#path}`);\n      }\n      case \"directory\": {\n        if (stats.isDirectory()) {\n          return true;\n        }\n        throw new Error(`Path exists but is not a directory: ${this.#path}`);\n      }\n      default: {\n        throw new Error(\"Invalid path type constraint\");\n      }\n    }\n  }\n\n  async existsAsFile(): Promise<boolean> {\n    return this.exists({ mustBe: \"file\" });\n  }\n\n  async existsAsDir(): Promise<boolean> {\n    return this.exists({ mustBe: \"directory\" });\n  }\n\n  // I don't think `mkdir` is a great name, but it does match the\n  // well-established canonical commandline name. So in this case we keep the\n  // awkward abbreviation.\n  /** Defaults to `recursive: true`. */\n  async mkdir(options?: Parameters<typeof mkdir>[1]): Promise<Path> {\n    const optionsObject = (() => {\n      if (typeof options === \"string\" || typeof options === \"number\") {\n        return { mode: options };\n      }\n      return options ?? {};\n    })();\n    await mkdir(this.#path, { recursive: true, ...optionsObject });\n    return this;\n  }\n\n  // TODO: check idempotency semantics when the destination exists and is a folder.\n  /** Returns the destination path. */\n  async cp(\n    destination: string | URL | Path,\n    options?: Parameters<typeof cp>[2],\n  ): Promise<Path> {\n    await cp(this.#path, new Path(destination).#path, options);\n    return new Path(destination);\n  }\n\n  // TODO: check idempotency semantics when the destination exists and is a folder.\n  async rename(destination: string | URL | Path): Promise<void> {\n    await rename(this.#path, new Path(destination).#path);\n  }\n\n  /** Create a temporary dir inside the global temp dir for the current user. */\n  static async makeTempDir(prefix?: string): Promise<Path> {\n    return new Path(\n      await mkdtemp(new Path(tmpdir()).join(prefix ?? \"js-temp-\").toString()),\n    );\n  }\n\n  async rm(options?: Parameters<typeof rm>[1]): Promise<void> {\n    await rm(this.#path, options);\n  }\n\n  /**\n   * Equivalent to:\n   *\n   *     .rm({ recursive: true, force: true, ...(options ?? {}) })\n   *\n   */\n  async rm_rf(options?: Parameters<typeof rm>[1]): Promise<void> {\n    await this.rm({ recursive: true, force: true, ...(options ?? {}) });\n  }\n\n  read: typeof readFileType = (options) =>\n    // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n    readFile(this.#path, options as any) as any;\n\n  async readText(): Promise<string> {\n    return readFile(this.#path, \"utf-8\");\n  }\n\n  /**\n   * Reads JSON from the given file and parses it. No validation is performed\n   * (beyond JSON parsing).\n   *\n   * An optional `fallback` value can be specified. It will be used if (and only\n   * if) the file does not exist.\n   *\n   */\n\n  // biome-ignore lint/suspicious/noExplicitAny: Allow a default of `any` to match `JSON.parse(\u2026)`.\n  async readJSON<T = any>(options?: { fallback?: T }): Promise<T> {\n    try {\n      return JSON.parse(await this.readText());\n    } catch (e) {\n      if (\n        (e as { code?: string }).code === \"ENOENT\" &&\n        options &&\n        \"fallback\" in options\n      ) {\n        return options.fallback as T;\n      }\n      throw e;\n    }\n  }\n\n  /**\n   * Returns the original `Path` (for chaining).\n   */\n  async appendFile(\n    data: Parameters<typeof appendFile>[1],\n    options?: Parameters<typeof appendFile>[2],\n  ): Promise<Path> {\n    await appendFile(this.#path, data, options);\n    return this;\n  }\n\n  /** Creates intermediate directories if they do not exist.\n   *\n   * Returns the original `Path` (for chaining).\n   */\n  async write(\n    data: WritableData | Promise<WritableData>,\n    options?: Parameters<typeof writeFile>[2],\n  ): Promise<Path> {\n    await this.parent.mkdir();\n    await writeFile(this.#path, await wrangleWritableData(data), options);\n    return this;\n  }\n\n  /**\n   * If only `data` is provided, this is equivalent to:\n   *\n   *     .write(JSON.stringify(data, null, \"  \"));\n   *\n   * `replacer` and `space` can also be specified, making this equivalent to:\n   *\n   *     .write(JSON.stringify(data, replacer, space));\n   *\n   * Returns the original `Path` (for chaining).\n   */\n  async writeJSON<T>(\n    data: T,\n    replacer: Parameters<typeof JSON.stringify>[1] = null,\n    space: Parameters<typeof JSON.stringify>[2] = \"  \",\n  ): Promise<Path> {\n    await this.write(JSON.stringify(data, replacer, space));\n    return this;\n  }\n\n  // Normally we'd add a `@deprecated` alias named `.readdir`, but that would\n  // differ only by capitalization of a single non-leading character. This can\n  // be a bit confusing, especially when autocompleting. So for this function in\n  // particular we don't include an alias.\n  readDir: typeof readDirType = (options) =>\n    // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n    readdir(this.#path, options as any) as any;\n\n  /** Returns the destination path. */\n  async symlink(\n    target: string | URL | Path,\n    type?: Parameters<typeof symlink>[2],\n  ): Promise<Path> {\n    const targetPath = new Path(target);\n    await symlink(\n      this.path,\n      targetPath.path,\n      type as Exclude<Parameters<typeof symlink>[2], undefined>, // \uD83E\uDD37\n    );\n    return targetPath;\n  }\n\n  // I don't think `lstat` is a great name, but it does match the\n  // well-established canonical commandline name. So in this case we keep the\n  // name instead of using `realPath`.\n  //\n  // Note: There are no options in our API, because the only option is an\n  // encoding. We set the encoding to construct the returned `Path`.\n  async realpath(): Promise<Path> {\n    return new Path(await realpath(this.#path, \"utf-8\"));\n  }\n\n  // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n  stat: typeof statType = (...options) => stat(this.#path, ...options) as any;\n\n  // I don't think `lstat` is a great name, but it does match the\n  // well-established canonical system call. So in this case we keep the\n  // awkward abbreviation.\n  lstat: typeof lstatType = (...options) =>\n    // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n    lstat(this.#path, ...options) as any;\n\n  static get homedir(): Path {\n    return new Path(homedir());\n  }\n\n  static xdg = {\n    cache: new Path(xdgCache ?? Path.homedir.join(\".cache\")),\n    config: new Path(xdgConfig ?? Path.homedir.join(\".config\")),\n    data: new Path(xdgData ?? Path.homedir.join(\".local/share\")),\n    state: new Path(xdgState ?? Path.homedir.join(\".local/state\")),\n    /**\n     * {@link Path.xdg.runtime} does not have a default value. Consider\n     * {@link Path.xdg.runtimeWithStateFallback} if you need a fallback but do not have a particular fallback in mind.\n     */\n    runtime: xdgRuntime ? new Path(xdgRuntime) : undefined,\n    runtimeWithStateFallback: xdgRuntime\n      ? new Path(xdgRuntime)\n      : new Path(xdgState ?? Path.homedir.join(\".local/state\")),\n  };\n\n  /** Chainable function to print the path. Prints the same as:\n   *\n   *     if (args.length > 0) {\n   *      console.log(...args);\n   *     }\n   *     console.log(this.path);\n   *\n   */\n  // biome-ignore lint/suspicious/noExplicitAny: This is the correct type, based on `console.log(\u2026)`.\n  debugPrint(...args: any[]): Path {\n    if (args.length > 0) {\n      console.log(...args);\n    }\n    console.log(this.#path);\n    return this;\n  }\n}\n\n/**\n * This function is useful to serialize any `Path`s in a structure to pass on to\n * functions that do not know about the `Path` class, e.g.\n *\n *     function process(args: (string | Path)[]) {\n *       const argsAsStrings = args.map(stringifyIfPath);\n *     }\n *\n */\nexport function stringifyIfPath<T>(value: T | Path): T | string {\n  if (value instanceof Path) {\n    return value.toString();\n  }\n  return value;\n}\n\nexport function mustNotHaveTrailingSlash(path: Path): void {\n  if (path.hasTrailingSlash()) {\n    throw new Error(\n      \"Path ends with a slash, which cannot be treated as a file.\",\n    );\n  }\n}\n"],
-  "mappings": ";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,SAAS,cAAc;AAChC,SAAS,UAAU,SAAS,SAAS,YAAY;AACjD,SAAS,gBAAgB;AACzB,SAAS,eAAe,qBAAqB;AAC7C;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAaP,eAAe,oBACb,MAC0C;AAC1C,SAAO,MAAM;AACb,MAAI,gBAAgB,UAAU;AAC5B,WAAO,KAAK,OAAO,SAAS,QAAQ,KAAK,IAAI,IAAI,IAAI,WAAW,CAAC;AAAA,EACnE;AACA,MAAI,gBAAgB,gBAAgB;AAClC,WAAO,SAAS,QAAQ,IAAI;AAAA,EAC9B;AACA,SAAO;AACT;AAEO,IAAM,OAAN,MAAM,MAAK;AAAA;AAAA,EAEhB;AAAA;AAAA;AAAA;AAAA,EAIA,YAAY,MAA2B;AACrC,SAAK,mBAAmB,MAAK,kBAAkB,IAAI,CAAC;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAO,QAAQ,MAA2B,MAAiC;AACzE,UAAM,WAAW,MAAM;AACrB,UAAI,EAAE,gBAAgB,QAAO;AAC3B,eAAO;AAAA,MACT;AACA,UAAI,CAAC,KAAK,eAAe,GAAG;AAC1B,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AACA,aAAO,cAAc,KAAK,KAAK;AAAA,IACjC,GAAG;AACH,WAAO,IAAI,MAAK,IAAI,IAAI,MAAK,kBAAkB,IAAI,GAAG,OAAO,CAAC;AAAA,EAChE;AAAA,EAEA,OAAO,kBAAkB,MAAmC;AAC1D,QAAI,gBAAgB,OAAM;AACxB,aAAO,KAAK;AAAA,IACd;AACA,QAAI,gBAAgB,KAAK;AACvB,aAAO,cAAc,IAAI;AAAA,IAC3B;AACA,QAAI,OAAO,SAAS,UAAU;AAE5B,UAAI,KAAK,WAAW,UAAU,GAAG;AAC/B,eAAO,cAAc,IAAI;AAAA,MAC3B;AACA,aAAO;AAAA,IACT;AACA,UAAM,IAAI,MAAM,cAAc;AAAA,EAChC;AAAA,EAEA,mBAAmB,MAAoB;AACrC,SAAK,QAAQ,KAAK,IAAI;AAAA,EACxB;AAAA,EAEA,iBAA0B;AACxB,WAAO,KAAK,MAAM,WAAW,GAAG;AAAA,EAClC;AAAA,EAEA,YAAiB;AACf,QAAI,CAAC,KAAK,eAAe,GAAG;AAC1B,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AACA,WAAO,cAAc,KAAK,KAAK;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,mBAA4B;AAE1B,WAAO,KAAK,MAAM,SAAS,GAAG;AAAA,EAChC;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,OAAO;AACT,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,WAAmB;AACjB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKA,QAAQ,UAAmC;AACzC,UAAM,iBAAiB,SAAS;AAAA,MAAI,CAAC,YACnC,mBAAmB,QAAO,QAAQ,OAAO;AAAA,IAC3C;AACA,WAAO,IAAI,MAAK,KAAK,KAAK,OAAO,GAAG,cAAc,CAAC;AAAA,EACrD;AAAA,EAEA,eAAe,QAAsB;AACnC,UAAM,eAAe,KAAK,MAAM;AAChC,QAAI,iBAAiB,SAAS,YAAY,GAAG;AAC3C,YAAM,IAAI,MAAM,qCAAqC;AAAA,IACvD;AAEA,WAAO,IAAI,MAAK,KAAK,QAAQ,YAAY;AAAA,EAC3C;AAAA,EAEA,IAAI,SAAe;AACjB,WAAO,IAAI,MAAK,QAAQ,KAAK,KAAK,CAAC;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,UAAgB;AAClB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,WAAiB;AACnB,WAAO,IAAI,MAAK,SAAS,KAAK,KAAK,CAAC;AAAA,EACtC;AAAA,EAEA,IAAI,YAAoB;AACtB,6BAAyB,IAAI;AAC7B,WAAO,QAAQ,KAAK,KAAK;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,UAAkB;AACpB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA,EAGA,MAAM,OAAO,aAEQ;AACnB,QAAI;AACJ,QAAI;AACF,cAAQ,MAAM,KAAK,KAAK,KAAK;AAAA,IAE/B,SAAS,GAAQ;AACf,UAAI,EAAE,SAAS,UAAU;AACvB,eAAO;AAAA,MACT;AACA,YAAM;AAAA,IACR;AACA,QAAI,CAAC,aAAa,QAAQ;AACxB,aAAO;AAAA,IACT;AACA,YAAQ,aAAa,QAAQ;AAAA,MAC3B,KAAK,QAAQ;AACX,iCAAyB,IAAI;AAC7B,YAAI,MAAM,OAAO,GAAG;AAClB,iBAAO;AAAA,QACT;AACA,cAAM,IAAI,MAAM,kCAAkC,KAAK,KAAK,EAAE;AAAA,MAChE;AAAA,MACA,KAAK,aAAa;AAChB,YAAI,MAAM,YAAY,GAAG;AACvB,iBAAO;AAAA,QACT;AACA,cAAM,IAAI,MAAM,uCAAuC,KAAK,KAAK,EAAE;AAAA,MACrE;AAAA,MACA,SAAS;AACP,cAAM,IAAI,MAAM,8BAA8B;AAAA,MAChD;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,eAAiC;AACrC,WAAO,KAAK,OAAO,EAAE,QAAQ,OAAO,CAAC;AAAA,EACvC;AAAA,EAEA,MAAM,cAAgC;AACpC,WAAO,KAAK,OAAO,EAAE,QAAQ,YAAY,CAAC;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,MAAM,SAAsD;AAChE,UAAM,iBAAiB,MAAM;AAC3B,UAAI,OAAO,YAAY,YAAY,OAAO,YAAY,UAAU;AAC9D,eAAO,EAAE,MAAM,QAAQ;AAAA,MACzB;AACA,aAAO,WAAW,CAAC;AAAA,IACrB,GAAG;AACH,UAAM,MAAM,KAAK,OAAO,EAAE,WAAW,MAAM,GAAG,cAAc,CAAC;AAC7D,WAAO;AAAA,EACT;AAAA;AAAA;AAAA,EAIA,MAAM,GACJ,aACA,SACe;AACf,UAAM,GAAG,KAAK,OAAO,IAAI,MAAK,WAAW,EAAE,OAAO,OAAO;AACzD,WAAO,IAAI,MAAK,WAAW;AAAA,EAC7B;AAAA;AAAA,EAGA,MAAM,OAAO,aAAiD;AAC5D,UAAM,OAAO,KAAK,OAAO,IAAI,MAAK,WAAW,EAAE,KAAK;AAAA,EACtD;AAAA;AAAA,EAGA,aAAa,YAAY,QAAgC;AACvD,WAAO,IAAI;AAAA,MACT,MAAM,QAAQ,IAAI,MAAK,OAAO,CAAC,EAAE,KAAK,UAAU,UAAU,EAAE,SAAS,CAAC;AAAA,IACxE;AAAA,EACF;AAAA,EAEA,MAAM,GAAG,SAAmD;AAC1D,UAAM,GAAG,KAAK,OAAO,OAAO;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,MAAM,SAAmD;AAC7D,UAAM,KAAK,GAAG,EAAE,WAAW,MAAM,OAAO,MAAM,GAAI,WAAW,CAAC,EAAG,CAAC;AAAA,EACpE;AAAA,EAEA,OAA4B,CAAC;AAAA;AAAA,IAE3B,SAAS,KAAK,OAAO,OAAc;AAAA;AAAA,EAErC,MAAM,WAA4B;AAChC,WAAO,SAAS,KAAK,OAAO,OAAO;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAM,SAAkB,SAAwC;AAC9D,QAAI;AACF,aAAO,KAAK,MAAM,MAAM,KAAK,SAAS,CAAC;AAAA,IACzC,SAAS,GAAG;AACV,UACG,EAAwB,SAAS,YAClC,WACA,cAAc,SACd;AACA,eAAO,QAAQ;AAAA,MACjB;AACA,YAAM;AAAA,IACR;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,WACJ,MACA,SACe;AACf,UAAM,WAAW,KAAK,OAAO,MAAM,OAAO;AAC1C,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,MACJ,MACA,SACe;AACf,UAAM,KAAK,OAAO,MAAM;AACxB,UAAM,UAAU,KAAK,OAAO,MAAM,oBAAoB,IAAI,GAAG,OAAO;AACpE,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,UACJ,MACA,WAAiD,MACjD,QAA8C,MAC/B;AACf,UAAM,KAAK,MAAM,KAAK,UAAU,MAAM,UAAU,KAAK,CAAC;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAA8B,CAAC;AAAA;AAAA,IAE7B,QAAQ,KAAK,OAAO,OAAc;AAAA;AAAA;AAAA,EAGpC,MAAM,QACJ,QACA,MACe;AACf,UAAM,aAAa,IAAI,MAAK,MAAM;AAClC,UAAM;AAAA,MACJ,KAAK;AAAA,MACL,WAAW;AAAA,MACX;AAAA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,WAA0B;AAC9B,WAAO,IAAI,MAAK,MAAM,SAAS,KAAK,OAAO,OAAO,CAAC;AAAA,EACrD;AAAA;AAAA,EAGA,OAAwB,IAAI,YAAY,KAAK,KAAK,OAAO,GAAG,OAAO;AAAA;AAAA;AAAA;AAAA,EAKnE,QAA0B,IAAI;AAAA;AAAA,IAE5B,MAAM,KAAK,OAAO,GAAG,OAAO;AAAA;AAAA,EAE9B,WAAW,UAAgB;AACzB,WAAO,IAAI,MAAK,QAAQ,CAAC;AAAA,EAC3B;AAAA,EAEA,OAAO,MAAM;AAAA,IACX,OAAO,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,QAAQ,CAAC;AAAA,IACvD,QAAQ,IAAI,MAAK,aAAa,MAAK,QAAQ,KAAK,SAAS,CAAC;AAAA,IAC1D,MAAM,IAAI,MAAK,WAAW,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA,IAC3D,OAAO,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7D,SAAS,aAAa,IAAI,MAAK,UAAU,IAAI;AAAA,IAC7C,0BAA0B,aACtB,IAAI,MAAK,UAAU,IACnB,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,cAAc,MAAmB;AAC/B,QAAI,KAAK,SAAS,GAAG;AACnB,cAAQ,IAAI,GAAG,IAAI;AAAA,IACrB;AACA,YAAQ,IAAI,KAAK,KAAK;AACtB,WAAO;AAAA,EACT;AACF;AAWO,SAAS,gBAAmB,OAA6B;AAC9D,MAAI,iBAAiB,MAAM;AACzB,WAAO,MAAM,SAAS;AAAA,EACxB;AACA,SAAO;AACT;AAEO,SAAS,yBAAyB,MAAkB;AACzD,MAAI,KAAK,iBAAiB,GAAG;AAC3B,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACF;",
-  "names": []
-}