@metamask/utils 8.3.0 → 8.5.0

package/dist/fs.cjs

@@ -0,0 +1,248 @@
+"use strict";
+// This file is intended to be used only in a Node.js context.
+/* eslint-disable import/no-nodejs-modules */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSandbox = exports.forceRemove = exports.ensureDirectoryStructureExists = exports.directoryExists = exports.fileExists = exports.writeJsonFile = exports.readJsonFile = exports.writeFile = exports.readFile = void 0;
+const fs_1 = __importDefault(require("fs"));
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const uuid = __importStar(require("uuid"));
+const errors_1 = require("./errors.cjs");
+/**
+ * Read the file at the given path, assuming its content is encoded as UTF-8.
+ *
+ * @param filePath - The path to the file.
+ * @returns The content of the file.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+async function readFile(filePath) {
+    try {
+        return await fs_1.default.promises.readFile(filePath, 'utf8');
+    }
+    catch (error) {
+        throw (0, errors_1.wrapError)(error, `Could not read file '${filePath}'`);
+    }
+}
+exports.readFile = readFile;
+/**
+ * Write content to the file at the given path, creating the directory structure
+ * for the file automatically if necessary.
+ *
+ * @param filePath - The path to the file.
+ * @param content - The new content of the file.
+ * @throws An error with a stack trace if writing fails in any way.
+ */
+async function writeFile(filePath, content) {
+    try {
+        await fs_1.default.promises.mkdir(path_1.default.dirname(filePath), { recursive: true });
+        await fs_1.default.promises.writeFile(filePath, content);
+    }
+    catch (error) {
+        throw (0, errors_1.wrapError)(error, `Could not write file '${filePath}'`);
+    }
+}
+exports.writeFile = writeFile;
+/**
+ * Read the assumed JSON file at the given path, attempts to parse it, and
+ * get the resulting object. Supports a custom parser (in case you want to
+ * use the [JSON5](https://www.npmjs.com/package/json5) package instead).
+ *
+ * @param filePath - The path segments pointing to the JSON file. Will be passed
+ * to path.join().
+ * @param options - Options to this function.
+ * @param options.parser - The parser object to use. Defaults to `JSON`.
+ * @param options.parser.parse - A function that parses JSON data.
+ * @returns The object corresponding to the parsed JSON file, typed against the
+ * struct.
+ * @throws An error with a stack trace if reading fails in any way, or if the
+ * parsed value is not a plain object.
+ */
+async function readJsonFile(filePath, { parser = JSON, } = {}) {
+    try {
+        const content = await fs_1.default.promises.readFile(filePath, 'utf8');
+        return parser.parse(content);
+    }
+    catch (error) {
+        throw (0, errors_1.wrapError)(error, `Could not read JSON file '${filePath}'`);
+    }
+}
+exports.readJsonFile = readJsonFile;
+/**
+ * Attempt to write the given JSON-like value to the file at the given path,
+ * creating the directory structure for the file automatically if necessary.
+ * Adds a newline to the end of the file. Supports a custom parser (in case you
+ * want to use the [JSON5](https://www.npmjs.com/package/json5) package
+ * instead).
+ *
+ * @param filePath - The path to write the JSON file to, including the file
+ * itself.
+ * @param jsonValue - The JSON-like value to write to the file. Make sure that
+ * JSON.stringify can handle it.
+ * @param options - The options to this function.
+ * @param options.prettify - Whether to format the JSON as it is turned into a
+ * string such that it is broken up into separate lines (using 2 spaces as
+ * indentation).
+ * @param options.stringifier - The stringifier to use. Defaults to `JSON`.
+ * @param options.stringifier.stringify - A function that stringifies JSON.
+ * @returns The object corresponding to the parsed JSON file, typed against the
+ * struct.
+ * @throws An error with a stack trace if writing fails in any way.
+ */
+async function writeJsonFile(filePath, jsonValue, { stringifier = JSON, prettify = false, } = {}) {
+    try {
+        await fs_1.default.promises.mkdir(path_1.default.dirname(filePath), { recursive: true });
+        const json = prettify
+            ? stringifier.stringify(jsonValue, null, '  ')
+            : stringifier.stringify(jsonValue);
+        await fs_1.default.promises.writeFile(filePath, json);
+    }
+    catch (error) {
+        throw (0, errors_1.wrapError)(error, `Could not write JSON file '${filePath}'`);
+    }
+}
+exports.writeJsonFile = writeJsonFile;
+/**
+ * Test the given path to determine whether it represents a file.
+ *
+ * @param filePath - The path to a (supposed) file on the filesystem.
+ * @returns A promise for true if the file exists or false otherwise.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+async function fileExists(filePath) {
+    try {
+        const stats = await fs_1.default.promises.stat(filePath);
+        return stats.isFile();
+    }
+    catch (error) {
+        if ((0, errors_1.isErrorWithCode)(error) && error.code === 'ENOENT') {
+            return false;
+        }
+        throw (0, errors_1.wrapError)(error, `Could not determine if file exists '${filePath}'`);
+    }
+}
+exports.fileExists = fileExists;
+/**
+ * Test the given path to determine whether it represents a directory.
+ *
+ * @param directoryPath - The path to a (supposed) directory on the filesystem.
+ * @returns A promise for true if the file exists or false otherwise.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+async function directoryExists(directoryPath) {
+    try {
+        const stats = await fs_1.default.promises.stat(directoryPath);
+        return stats.isDirectory();
+    }
+    catch (error) {
+        if ((0, errors_1.isErrorWithCode)(error) && error.code === 'ENOENT') {
+            return false;
+        }
+        throw (0, errors_1.wrapError)(error, `Could not determine if directory exists '${directoryPath}'`);
+    }
+}
+exports.directoryExists = directoryExists;
+/**
+ * Create the given directory along with any directories leading up to the
+ * directory, or do nothing if the directory already exists.
+ *
+ * @param directoryPath - The path to the desired directory.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+async function ensureDirectoryStructureExists(directoryPath) {
+    try {
+        await fs_1.default.promises.mkdir(directoryPath, { recursive: true });
+    }
+    catch (error) {
+        throw (0, errors_1.wrapError)(error, `Could not create directory structure '${directoryPath}'`);
+    }
+}
+exports.ensureDirectoryStructureExists = ensureDirectoryStructureExists;
+/**
+ * Remove the given file or directory if it exists, or do nothing if it does
+ * not.
+ *
+ * @param entryPath - The path to the file or directory.
+ * @throws An error with a stack trace if removal fails in any way.
+ */
+async function forceRemove(entryPath) {
+    try {
+        return await fs_1.default.promises.rm(entryPath, {
+            recursive: true,
+            force: true,
+        });
+    }
+    catch (error) {
+        throw (0, errors_1.wrapError)(error, `Could not remove file or directory '${entryPath}'`);
+    }
+}
+exports.forceRemove = forceRemove;
+/**
+ * Construct a sandbox object which can be used in tests that need temporary
+ * access to the filesystem.
+ *
+ * @param projectName - The name of the project.
+ * @returns The sandbox object. This contains a `withinSandbox` function which
+ * can be used in tests (see example).
+ * @example
+ * ```typescript
+ * const { withinSandbox } = createSandbox('utils');
+ *
+ * // ... later ...
+ *
+ * it('does something with the filesystem', async () => {
+ *   await withinSandbox(async ({ directoryPath }) => {
+ *     await fs.promises.writeFile(
+ *       path.join(directoryPath, 'some-file'),
+ *       'some content',
+ *       'utf8'
+ *     );
+ *   })
+ * });
+ * ```
+ */
+function createSandbox(projectName) {
+    const directoryPath = path_1.default.join(os_1.default.tmpdir(), projectName, uuid.v4());
+    return {
+        directoryPath,
+        async withinSandbox(test) {
+            if (await directoryExists(directoryPath)) {
+                throw new Error(`${directoryPath} already exists. Cannot continue.`);
+            }
+            await ensureDirectoryStructureExists(directoryPath);
+            try {
+                await test({ directoryPath });
+            }
+            finally {
+                await forceRemove(directoryPath);
+            }
+        },
+    };
+}
+exports.createSandbox = createSandbox;
+//# sourceMappingURL=fs.cjs.map

package/dist/fs.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.cjs","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":";AAAA,8DAA8D;AAC9D,6CAA6C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE7C,4CAAoB;AACpB,4CAAoB;AACpB,gDAAwB;AACxB,2CAA6B;AAE7B,yCAAsD;AActD;;;;;;GAMG;AACI,KAAK,UAAU,QAAQ,CAAC,QAAgB;IAC7C,IAAI;QACF,OAAO,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;KACrD;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAA,kBAAS,EAAC,KAAK,EAAE,wBAAwB,QAAQ,GAAG,CAAC,CAAC;KAC7D;AACH,CAAC;AAND,4BAMC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,SAAS,CAC7B,QAAgB,EAChB,OAAe;IAEf,IAAI;QACF,MAAM,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,MAAM,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;KAChD;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAA,kBAAS,EAAC,KAAK,EAAE,yBAAyB,QAAQ,GAAG,CAAC,CAAC;KAC9D;AACH,CAAC;AAVD,8BAUC;AAED;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,YAAY,CAChC,QAAgB,EAChB,EACE,MAAM,GAAG,IAAI,MAOX,EAAE;IAEN,IAAI;QACF,MAAM,OAAO,GAAG,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC7D,OAAO,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;KAC9B;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAA,kBAAS,EAAC,KAAK,EAAE,6BAA6B,QAAQ,GAAG,CAAC,CAAC;KAClE;AACH,CAAC;AAlBD,oCAkBC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACI,KAAK,UAAU,aAAa,CACjC,QAAgB,EAChB,SAAe,EACf,EACE,WAAW,GAAG,IAAI,EAClB,QAAQ,GAAG,KAAK,MAMd,EAAE;IAEN,IAAI;QACF,MAAM,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,MAAM,IAAI,GAAG,QAAQ;YACnB,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC;YAC9C,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACrC,MAAM,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;KAC7C;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAA,kBAAS,EAAC,KAAK,EAAE,8BAA8B,QAAQ,GAAG,CAAC,CAAC;KACnE;AACH,CAAC;AAtBD,sCAsBC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,UAAU,CAAC,QAAgB;IAC/C,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,YAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/C,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;KACvB;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,IAAA,wBAAe,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YACrD,OAAO,KAAK,CAAC;SACd;QAED,MAAM,IAAA,kBAAS,EAAC,KAAK,EAAE,uCAAuC,QAAQ,GAAG,CAAC,CAAC;KAC5E;AACH,CAAC;AAXD,gCAWC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,eAAe,CAAC,aAAqB;IACzD,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,YAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpD,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;KAC5B;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,IAAA,wBAAe,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YACrD,OAAO,KAAK,CAAC;SACd;QAED,MAAM,IAAA,kBAAS,EACb,KAAK,EACL,4CAA4C,aAAa,GAAG,CAC7D,CAAC;KACH;AACH,CAAC;AAdD,0CAcC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,8BAA8B,CAClD,aAAqB;IAErB,IAAI;QACF,MAAM,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;KAC7D;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAA,kBAAS,EACb,KAAK,EACL,yCAAyC,aAAa,GAAG,CAC1D,CAAC;KACH;AACH,CAAC;AAXD,wEAWC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,WAAW,CAAC,SAAiB;IACjD,IAAI;QACF,OAAO,MAAM,YAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE;YACrC,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;KACJ;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAA,kBAAS,EAAC,KAAK,EAAE,uCAAuC,SAAS,GAAG,CAAC,CAAC;KAC7E;AACH,CAAC;AATD,kCASC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,aAAa,CAAC,WAAmB;IAC/C,MAAM,aAAa,GAAG,cAAI,CAAC,IAAI,CAAC,YAAE,CAAC,MAAM,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;IAErE,OAAO;QACL,aAAa;QACb,KAAK,CAAC,aAAa,CACjB,IAAwD;YAExD,IAAI,MAAM,eAAe,CAAC,aAAa,CAAC,EAAE;gBACxC,MAAM,IAAI,KAAK,CAAC,GAAG,aAAa,mCAAmC,CAAC,CAAC;aACtE;YAED,MAAM,8BAA8B,CAAC,aAAa,CAAC,CAAC;YAEpD,IAAI;gBACF,MAAM,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC;aAC/B;oBAAS;gBACR,MAAM,WAAW,CAAC,aAAa,CAAC,CAAC;aAClC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AArBD,sCAqBC","sourcesContent":["// This file is intended to be used only in a Node.js context.\n/* eslint-disable import/no-nodejs-modules */\n\nimport fs from 'fs';\nimport os from 'os';\nimport path from 'path';\nimport * as uuid from 'uuid';\n\nimport { isErrorWithCode, wrapError } from './errors';\nimport type { Json } from './json';\n\n/**\n * Information about the file sandbox provided to tests that need temporary\n * access to the filesystem.\n */\nexport type FileSandbox = {\n  directoryPath: string;\n  withinSandbox: (\n    test: (args: { directoryPath: string }) => Promise<void>,\n  ) => Promise<void>;\n};\n\n/**\n * Read the file at the given path, assuming its content is encoded as UTF-8.\n *\n * @param filePath - The path to the file.\n * @returns The content of the file.\n * @throws An error with a stack trace if reading fails in any way.\n */\nexport async function readFile(filePath: string): Promise<string> {\n  try {\n    return await fs.promises.readFile(filePath, 'utf8');\n  } catch (error) {\n    throw wrapError(error, `Could not read file '${filePath}'`);\n  }\n}\n\n/**\n * Write content to the file at the given path, creating the directory structure\n * for the file automatically if necessary.\n *\n * @param filePath - The path to the file.\n * @param content - The new content of the file.\n * @throws An error with a stack trace if writing fails in any way.\n */\nexport async function writeFile(\n  filePath: string,\n  content: string,\n): Promise<void> {\n  try {\n    await fs.promises.mkdir(path.dirname(filePath), { recursive: true });\n    await fs.promises.writeFile(filePath, content);\n  } catch (error) {\n    throw wrapError(error, `Could not write file '${filePath}'`);\n  }\n}\n\n/**\n * Read the assumed JSON file at the given path, attempts to parse it, and\n * get the resulting object. Supports a custom parser (in case you want to\n * use the [JSON5](https://www.npmjs.com/package/json5) package instead).\n *\n * @param filePath - The path segments pointing to the JSON file. Will be passed\n * to path.join().\n * @param options - Options to this function.\n * @param options.parser - The parser object to use. Defaults to `JSON`.\n * @param options.parser.parse - A function that parses JSON data.\n * @returns The object corresponding to the parsed JSON file, typed against the\n * struct.\n * @throws An error with a stack trace if reading fails in any way, or if the\n * parsed value is not a plain object.\n */\nexport async function readJsonFile<Value extends Json>(\n  filePath: string,\n  {\n    parser = JSON,\n  }: {\n    parser?: {\n      parse: (\n        text: Parameters<typeof JSON.parse>[0],\n      ) => ReturnType<typeof JSON.parse>;\n    };\n  } = {},\n): Promise<Value> {\n  try {\n    const content = await fs.promises.readFile(filePath, 'utf8');\n    return parser.parse(content);\n  } catch (error) {\n    throw wrapError(error, `Could not read JSON file '${filePath}'`);\n  }\n}\n\n/**\n * Attempt to write the given JSON-like value to the file at the given path,\n * creating the directory structure for the file automatically if necessary.\n * Adds a newline to the end of the file. Supports a custom parser (in case you\n * want to use the [JSON5](https://www.npmjs.com/package/json5) package\n * instead).\n *\n * @param filePath - The path to write the JSON file to, including the file\n * itself.\n * @param jsonValue - The JSON-like value to write to the file. Make sure that\n * JSON.stringify can handle it.\n * @param options - The options to this function.\n * @param options.prettify - Whether to format the JSON as it is turned into a\n * string such that it is broken up into separate lines (using 2 spaces as\n * indentation).\n * @param options.stringifier - The stringifier to use. Defaults to `JSON`.\n * @param options.stringifier.stringify - A function that stringifies JSON.\n * @returns The object corresponding to the parsed JSON file, typed against the\n * struct.\n * @throws An error with a stack trace if writing fails in any way.\n */\nexport async function writeJsonFile(\n  filePath: string,\n  jsonValue: Json,\n  {\n    stringifier = JSON,\n    prettify = false,\n  }: {\n    stringifier?: {\n      stringify: typeof JSON.stringify;\n    };\n    prettify?: boolean;\n  } = {},\n): Promise<void> {\n  try {\n    await fs.promises.mkdir(path.dirname(filePath), { recursive: true });\n    const json = prettify\n      ? stringifier.stringify(jsonValue, null, '  ')\n      : stringifier.stringify(jsonValue);\n    await fs.promises.writeFile(filePath, json);\n  } catch (error) {\n    throw wrapError(error, `Could not write JSON file '${filePath}'`);\n  }\n}\n\n/**\n * Test the given path to determine whether it represents a file.\n *\n * @param filePath - The path to a (supposed) file on the filesystem.\n * @returns A promise for true if the file exists or false otherwise.\n * @throws An error with a stack trace if reading fails in any way.\n */\nexport async function fileExists(filePath: string): Promise<boolean> {\n  try {\n    const stats = await fs.promises.stat(filePath);\n    return stats.isFile();\n  } catch (error) {\n    if (isErrorWithCode(error) && error.code === 'ENOENT') {\n      return false;\n    }\n\n    throw wrapError(error, `Could not determine if file exists '${filePath}'`);\n  }\n}\n\n/**\n * Test the given path to determine whether it represents a directory.\n *\n * @param directoryPath - The path to a (supposed) directory on the filesystem.\n * @returns A promise for true if the file exists or false otherwise.\n * @throws An error with a stack trace if reading fails in any way.\n */\nexport async function directoryExists(directoryPath: string): Promise<boolean> {\n  try {\n    const stats = await fs.promises.stat(directoryPath);\n    return stats.isDirectory();\n  } catch (error) {\n    if (isErrorWithCode(error) && error.code === 'ENOENT') {\n      return false;\n    }\n\n    throw wrapError(\n      error,\n      `Could not determine if directory exists '${directoryPath}'`,\n    );\n  }\n}\n\n/**\n * Create the given directory along with any directories leading up to the\n * directory, or do nothing if the directory already exists.\n *\n * @param directoryPath - The path to the desired directory.\n * @throws An error with a stack trace if reading fails in any way.\n */\nexport async function ensureDirectoryStructureExists(\n  directoryPath: string,\n): Promise<void> {\n  try {\n    await fs.promises.mkdir(directoryPath, { recursive: true });\n  } catch (error) {\n    throw wrapError(\n      error,\n      `Could not create directory structure '${directoryPath}'`,\n    );\n  }\n}\n\n/**\n * Remove the given file or directory if it exists, or do nothing if it does\n * not.\n *\n * @param entryPath - The path to the file or directory.\n * @throws An error with a stack trace if removal fails in any way.\n */\nexport async function forceRemove(entryPath: string): Promise<void> {\n  try {\n    return await fs.promises.rm(entryPath, {\n      recursive: true,\n      force: true,\n    });\n  } catch (error) {\n    throw wrapError(error, `Could not remove file or directory '${entryPath}'`);\n  }\n}\n\n/**\n * Construct a sandbox object which can be used in tests that need temporary\n * access to the filesystem.\n *\n * @param projectName - The name of the project.\n * @returns The sandbox object. This contains a `withinSandbox` function which\n * can be used in tests (see example).\n * @example\n * ```typescript\n * const { withinSandbox } = createSandbox('utils');\n *\n * // ... later ...\n *\n * it('does something with the filesystem', async () => {\n *   await withinSandbox(async ({ directoryPath }) => {\n *     await fs.promises.writeFile(\n *       path.join(directoryPath, 'some-file'),\n *       'some content',\n *       'utf8'\n *     );\n *   })\n * });\n * ```\n */\nexport function createSandbox(projectName: string): FileSandbox {\n  const directoryPath = path.join(os.tmpdir(), projectName, uuid.v4());\n\n  return {\n    directoryPath,\n    async withinSandbox(\n      test: (args: { directoryPath: string }) => Promise<void>,\n    ) {\n      if (await directoryExists(directoryPath)) {\n        throw new Error(`${directoryPath} already exists. Cannot continue.`);\n      }\n\n      await ensureDirectoryStructureExists(directoryPath);\n\n      try {\n        await test({ directoryPath });\n      } finally {\n        await forceRemove(directoryPath);\n      }\n    },\n  };\n}\n"]}

package/dist/{types/fs.d.ts → fs.d.cts}

@@ -1,9 +1,9 @@
-import type { Json } from './json';
+import type { Json } from "./json.cjs";
 /**
  * Information about the file sandbox provided to tests that need temporary
  * access to the filesystem.
  */
-export declare type FileSandbox = {
+export type FileSandbox = {
     directoryPath: string;
     withinSandbox: (test: (args: {
         directoryPath: string;
@@ -130,4 +130,4 @@ export declare function forceRemove(entryPath: string): Promise<void>;
  * ```
  */
 export declare function createSandbox(projectName: string): FileSandbox;
-//# sourceMappingURL=fs.d.ts.map
+//# sourceMappingURL=fs.d.cts.map

package/dist/fs.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.d.cts","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,IAAI,EAAE,mBAAe;AAEnC;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,CACb,IAAI,EAAE,CAAC,IAAI,EAAE;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,KACrD,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAsB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAMhE;AAED;;;;;;;GAOG;AACH,wBAAsB,SAAS,CAC7B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CAOf;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,YAAY,CAAC,KAAK,SAAS,IAAI,EACnD,QAAQ,EAAE,MAAM,EAChB,EACE,MAAa,GACd,GAAE;IACD,MAAM,CAAC,EAAE;QACP,KAAK,EAAE,CACL,IAAI,EAAE,UAAU,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KACnC,UAAU,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;KACpC,CAAC;CACE,GACL,OAAO,CAAC,KAAK,CAAC,CAOhB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,aAAa,CACjC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,IAAI,EACf,EACE,WAAkB,EAClB,QAAgB,GACjB,GAAE;IACD,WAAW,CAAC,EAAE;QACZ,SAAS,EAAE,OAAO,IAAI,CAAC,SAAS,CAAC;KAClC,CAAC;IACF,QAAQ,CAAC,EAAE,OAAO,CAAC;CACf,GACL,OAAO,CAAC,IAAI,CAAC,CAUf;AAED;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAWnE;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAc7E;AAED;;;;;;GAMG;AACH,wBAAsB,8BAA8B,CAClD,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC,CASf;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CASlE;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,WAAW,CAqB9D"}

package/dist/fs.d.mts

@@ -0,0 +1,133 @@
+import type { Json } from "./json.mjs";
+/**
+ * Information about the file sandbox provided to tests that need temporary
+ * access to the filesystem.
+ */
+export type FileSandbox = {
+    directoryPath: string;
+    withinSandbox: (test: (args: {
+        directoryPath: string;
+    }) => Promise<void>) => Promise<void>;
+};
+/**
+ * Read the file at the given path, assuming its content is encoded as UTF-8.
+ *
+ * @param filePath - The path to the file.
+ * @returns The content of the file.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export declare function readFile(filePath: string): Promise<string>;
+/**
+ * Write content to the file at the given path, creating the directory structure
+ * for the file automatically if necessary.
+ *
+ * @param filePath - The path to the file.
+ * @param content - The new content of the file.
+ * @throws An error with a stack trace if writing fails in any way.
+ */
+export declare function writeFile(filePath: string, content: string): Promise<void>;
+/**
+ * Read the assumed JSON file at the given path, attempts to parse it, and
+ * get the resulting object. Supports a custom parser (in case you want to
+ * use the [JSON5](https://www.npmjs.com/package/json5) package instead).
+ *
+ * @param filePath - The path segments pointing to the JSON file. Will be passed
+ * to path.join().
+ * @param options - Options to this function.
+ * @param options.parser - The parser object to use. Defaults to `JSON`.
+ * @param options.parser.parse - A function that parses JSON data.
+ * @returns The object corresponding to the parsed JSON file, typed against the
+ * struct.
+ * @throws An error with a stack trace if reading fails in any way, or if the
+ * parsed value is not a plain object.
+ */
+export declare function readJsonFile<Value extends Json>(filePath: string, { parser, }?: {
+    parser?: {
+        parse: (text: Parameters<typeof JSON.parse>[0]) => ReturnType<typeof JSON.parse>;
+    };
+}): Promise<Value>;
+/**
+ * Attempt to write the given JSON-like value to the file at the given path,
+ * creating the directory structure for the file automatically if necessary.
+ * Adds a newline to the end of the file. Supports a custom parser (in case you
+ * want to use the [JSON5](https://www.npmjs.com/package/json5) package
+ * instead).
+ *
+ * @param filePath - The path to write the JSON file to, including the file
+ * itself.
+ * @param jsonValue - The JSON-like value to write to the file. Make sure that
+ * JSON.stringify can handle it.
+ * @param options - The options to this function.
+ * @param options.prettify - Whether to format the JSON as it is turned into a
+ * string such that it is broken up into separate lines (using 2 spaces as
+ * indentation).
+ * @param options.stringifier - The stringifier to use. Defaults to `JSON`.
+ * @param options.stringifier.stringify - A function that stringifies JSON.
+ * @returns The object corresponding to the parsed JSON file, typed against the
+ * struct.
+ * @throws An error with a stack trace if writing fails in any way.
+ */
+export declare function writeJsonFile(filePath: string, jsonValue: Json, { stringifier, prettify, }?: {
+    stringifier?: {
+        stringify: typeof JSON.stringify;
+    };
+    prettify?: boolean;
+}): Promise<void>;
+/**
+ * Test the given path to determine whether it represents a file.
+ *
+ * @param filePath - The path to a (supposed) file on the filesystem.
+ * @returns A promise for true if the file exists or false otherwise.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export declare function fileExists(filePath: string): Promise<boolean>;
+/**
+ * Test the given path to determine whether it represents a directory.
+ *
+ * @param directoryPath - The path to a (supposed) directory on the filesystem.
+ * @returns A promise for true if the file exists or false otherwise.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export declare function directoryExists(directoryPath: string): Promise<boolean>;
+/**
+ * Create the given directory along with any directories leading up to the
+ * directory, or do nothing if the directory already exists.
+ *
+ * @param directoryPath - The path to the desired directory.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export declare function ensureDirectoryStructureExists(directoryPath: string): Promise<void>;
+/**
+ * Remove the given file or directory if it exists, or do nothing if it does
+ * not.
+ *
+ * @param entryPath - The path to the file or directory.
+ * @throws An error with a stack trace if removal fails in any way.
+ */
+export declare function forceRemove(entryPath: string): Promise<void>;
+/**
+ * Construct a sandbox object which can be used in tests that need temporary
+ * access to the filesystem.
+ *
+ * @param projectName - The name of the project.
+ * @returns The sandbox object. This contains a `withinSandbox` function which
+ * can be used in tests (see example).
+ * @example
+ * ```typescript
+ * const { withinSandbox } = createSandbox('utils');
+ *
+ * // ... later ...
+ *
+ * it('does something with the filesystem', async () => {
+ *   await withinSandbox(async ({ directoryPath }) => {
+ *     await fs.promises.writeFile(
+ *       path.join(directoryPath, 'some-file'),
+ *       'some content',
+ *       'utf8'
+ *     );
+ *   })
+ * });
+ * ```
+ */
+export declare function createSandbox(projectName: string): FileSandbox;
+//# sourceMappingURL=fs.d.mts.map

package/dist/fs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.d.mts","sourceRoot":"","sources":["../src/fs.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,IAAI,EAAE,mBAAe;AAEnC;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,CACb,IAAI,EAAE,CAAC,IAAI,EAAE;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,KACrD,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAsB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAMhE;AAED;;;;;;;GAOG;AACH,wBAAsB,SAAS,CAC7B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CAOf;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,YAAY,CAAC,KAAK,SAAS,IAAI,EACnD,QAAQ,EAAE,MAAM,EAChB,EACE,MAAa,GACd,GAAE;IACD,MAAM,CAAC,EAAE;QACP,KAAK,EAAE,CACL,IAAI,EAAE,UAAU,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KACnC,UAAU,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;KACpC,CAAC;CACE,GACL,OAAO,CAAC,KAAK,CAAC,CAOhB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,aAAa,CACjC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,IAAI,EACf,EACE,WAAkB,EAClB,QAAgB,GACjB,GAAE;IACD,WAAW,CAAC,EAAE;QACZ,SAAS,EAAE,OAAO,IAAI,CAAC,SAAS,CAAC;KAClC,CAAC;IACF,QAAQ,CAAC,EAAE,OAAO,CAAC;CACf,GACL,OAAO,CAAC,IAAI,CAAC,CAUf;AAED;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAWnE;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAc7E;AAED;;;;;;GAMG;AACH,wBAAsB,8BAA8B,CAClD,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC,CASf;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CASlE;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,WAAW,CAqB9D"}

package/dist/fs.mjs

@@ -1,26 +1,210 @@
-import {
-  createSandbox,
-  directoryExists,
-  ensureDirectoryStructureExists,
-  fileExists,
-  forceRemove,
-  readFile,
-  readJsonFile,
-  writeFile,
-  writeJsonFile
-} from "./chunk-52OU772R.mjs";
-import "./chunk-XYGUOY6N.mjs";
-import "./chunk-H4YFDLB7.mjs";
-import "./chunk-X66SUIEF.mjs";
-export {
-  createSandbox,
-  directoryExists,
-  ensureDirectoryStructureExists,
-  fileExists,
-  forceRemove,
-  readFile,
-  readJsonFile,
-  writeFile,
-  writeJsonFile
-};
+// This file is intended to be used only in a Node.js context.
+/* eslint-disable import/no-nodejs-modules */
+import fs from "fs";
+import os from "os";
+import path from "path";
+import * as uuid from "uuid";
+import { isErrorWithCode, wrapError } from "./errors.mjs";
+/**
+ * Read the file at the given path, assuming its content is encoded as UTF-8.
+ *
+ * @param filePath - The path to the file.
+ * @returns The content of the file.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export async function readFile(filePath) {
+    try {
+        return await fs.promises.readFile(filePath, 'utf8');
+    }
+    catch (error) {
+        throw wrapError(error, `Could not read file '${filePath}'`);
+    }
+}
+/**
+ * Write content to the file at the given path, creating the directory structure
+ * for the file automatically if necessary.
+ *
+ * @param filePath - The path to the file.
+ * @param content - The new content of the file.
+ * @throws An error with a stack trace if writing fails in any way.
+ */
+export async function writeFile(filePath, content) {
+    try {
+        await fs.promises.mkdir(path.dirname(filePath), { recursive: true });
+        await fs.promises.writeFile(filePath, content);
+    }
+    catch (error) {
+        throw wrapError(error, `Could not write file '${filePath}'`);
+    }
+}
+/**
+ * Read the assumed JSON file at the given path, attempts to parse it, and
+ * get the resulting object. Supports a custom parser (in case you want to
+ * use the [JSON5](https://www.npmjs.com/package/json5) package instead).
+ *
+ * @param filePath - The path segments pointing to the JSON file. Will be passed
+ * to path.join().
+ * @param options - Options to this function.
+ * @param options.parser - The parser object to use. Defaults to `JSON`.
+ * @param options.parser.parse - A function that parses JSON data.
+ * @returns The object corresponding to the parsed JSON file, typed against the
+ * struct.
+ * @throws An error with a stack trace if reading fails in any way, or if the
+ * parsed value is not a plain object.
+ */
+export async function readJsonFile(filePath, { parser = JSON, } = {}) {
+    try {
+        const content = await fs.promises.readFile(filePath, 'utf8');
+        return parser.parse(content);
+    }
+    catch (error) {
+        throw wrapError(error, `Could not read JSON file '${filePath}'`);
+    }
+}
+/**
+ * Attempt to write the given JSON-like value to the file at the given path,
+ * creating the directory structure for the file automatically if necessary.
+ * Adds a newline to the end of the file. Supports a custom parser (in case you
+ * want to use the [JSON5](https://www.npmjs.com/package/json5) package
+ * instead).
+ *
+ * @param filePath - The path to write the JSON file to, including the file
+ * itself.
+ * @param jsonValue - The JSON-like value to write to the file. Make sure that
+ * JSON.stringify can handle it.
+ * @param options - The options to this function.
+ * @param options.prettify - Whether to format the JSON as it is turned into a
+ * string such that it is broken up into separate lines (using 2 spaces as
+ * indentation).
+ * @param options.stringifier - The stringifier to use. Defaults to `JSON`.
+ * @param options.stringifier.stringify - A function that stringifies JSON.
+ * @returns The object corresponding to the parsed JSON file, typed against the
+ * struct.
+ * @throws An error with a stack trace if writing fails in any way.
+ */
+export async function writeJsonFile(filePath, jsonValue, { stringifier = JSON, prettify = false, } = {}) {
+    try {
+        await fs.promises.mkdir(path.dirname(filePath), { recursive: true });
+        const json = prettify
+            ? stringifier.stringify(jsonValue, null, '  ')
+            : stringifier.stringify(jsonValue);
+        await fs.promises.writeFile(filePath, json);
+    }
+    catch (error) {
+        throw wrapError(error, `Could not write JSON file '${filePath}'`);
+    }
+}
+/**
+ * Test the given path to determine whether it represents a file.
+ *
+ * @param filePath - The path to a (supposed) file on the filesystem.
+ * @returns A promise for true if the file exists or false otherwise.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export async function fileExists(filePath) {
+    try {
+        const stats = await fs.promises.stat(filePath);
+        return stats.isFile();
+    }
+    catch (error) {
+        if (isErrorWithCode(error) && error.code === 'ENOENT') {
+            return false;
+        }
+        throw wrapError(error, `Could not determine if file exists '${filePath}'`);
+    }
+}
+/**
+ * Test the given path to determine whether it represents a directory.
+ *
+ * @param directoryPath - The path to a (supposed) directory on the filesystem.
+ * @returns A promise for true if the file exists or false otherwise.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export async function directoryExists(directoryPath) {
+    try {
+        const stats = await fs.promises.stat(directoryPath);
+        return stats.isDirectory();
+    }
+    catch (error) {
+        if (isErrorWithCode(error) && error.code === 'ENOENT') {
+            return false;
+        }
+        throw wrapError(error, `Could not determine if directory exists '${directoryPath}'`);
+    }
+}
+/**
+ * Create the given directory along with any directories leading up to the
+ * directory, or do nothing if the directory already exists.
+ *
+ * @param directoryPath - The path to the desired directory.
+ * @throws An error with a stack trace if reading fails in any way.
+ */
+export async function ensureDirectoryStructureExists(directoryPath) {
+    try {
+        await fs.promises.mkdir(directoryPath, { recursive: true });
+    }
+    catch (error) {
+        throw wrapError(error, `Could not create directory structure '${directoryPath}'`);
+    }
+}
+/**
+ * Remove the given file or directory if it exists, or do nothing if it does
+ * not.
+ *
+ * @param entryPath - The path to the file or directory.
+ * @throws An error with a stack trace if removal fails in any way.
+ */
+export async function forceRemove(entryPath) {
+    try {
+        return await fs.promises.rm(entryPath, {
+            recursive: true,
+            force: true,
+        });
+    }
+    catch (error) {
+        throw wrapError(error, `Could not remove file or directory '${entryPath}'`);
+    }
+}
+/**
+ * Construct a sandbox object which can be used in tests that need temporary
+ * access to the filesystem.
+ *
+ * @param projectName - The name of the project.
+ * @returns The sandbox object. This contains a `withinSandbox` function which
+ * can be used in tests (see example).
+ * @example
+ * ```typescript
+ * const { withinSandbox } = createSandbox('utils');
+ *
+ * // ... later ...
+ *
+ * it('does something with the filesystem', async () => {
+ *   await withinSandbox(async ({ directoryPath }) => {
+ *     await fs.promises.writeFile(
+ *       path.join(directoryPath, 'some-file'),
+ *       'some content',
+ *       'utf8'
+ *     );
+ *   })
+ * });
+ * ```
+ */
+export function createSandbox(projectName) {
+    const directoryPath = path.join(os.tmpdir(), projectName, uuid.v4());
+    return {
+        directoryPath,
+        async withinSandbox(test) {
+            if (await directoryExists(directoryPath)) {
+                throw new Error(`${directoryPath} already exists. Cannot continue.`);
+            }
+            await ensureDirectoryStructureExists(directoryPath);
+            try {
+                await test({ directoryPath });
+            }
+            finally {
+                await forceRemove(directoryPath);
+            }
+        },
+    };
+}
 //# sourceMappingURL=fs.mjs.map