@visulima/fs 4.0.4 → 4.0.6

package/dist/move/utils/internal-move-file-sync.d.ts

@@ -0,0 +1,3 @@
+import type { InternalOptions } from "../types.d.ts";
+declare const internalMoveFileSync: (sourcePath: string, destinationPath: string, { cwd, directoryMode, overwrite, validateDirectory }: InternalOptions) => void;
+export default internalMoveFileSync;

package/dist/move/utils/internal-move-file.d.ts

@@ -0,0 +1,3 @@
+import type { InternalOptions } from "../types.d.ts";
+declare const internalMoveFile: (sourcePath: string, destinationPath: string, { cwd, directoryMode, overwrite, validateDirectory }: InternalOptions) => Promise<void>;
+export default internalMoveFile;

package/dist/move/utils/validate-same-directory.d.ts

@@ -0,0 +1,2 @@
+declare const validateSameDirectory: (source: string, destination: string) => void;
+export default validateSameDirectory;

package/dist/packem_shared/{F_OK-MldBaGxb.js → F_OK-BalxCn9n.js}

@@ -2,7 +2,7 @@ const F_OK = 0;
 const R_OK = 4;
 const W_OK = 2;
 const X_OK = 1;
-const FIND_UP_STOP = /* @__PURE__ */ Symbol("findUpStop");
+const FIND_UP_STOP = Symbol("findUpStop");
 const INTERNAL_STRIP_JSON_REGEX = /"(?:[^"\\]|\\.)*"|\/\/[^\r\n]*|\/\*[\s\S]*?\*\//g;
 
 export { FIND_UP_STOP, F_OK, INTERNAL_STRIP_JSON_REGEX, R_OK, W_OK, X_OK };

package/dist/packem_shared/{findUp-BSnyGqer.js → findUp-Lv9mZCIQ.js}

@@ -26,7 +26,7 @@ const {
 } = __cjs_getBuiltinModule("node:url");
 import { resolve, parse, isAbsolute, dirname } from '@visulima/path';
 import { toPath } from '@visulima/path/utils';
-import { FIND_UP_STOP } from './F_OK-MldBaGxb.js';
+import { FIND_UP_STOP } from './F_OK-BalxCn9n.js';
 
 const findUp = async (name, options = {}) => {
   if (typeof name !== "string" && !Array.isArray(name) && typeof name !== "function") {

package/dist/packem_shared/{findUpSync-jRHbSCMV.js → findUpSync-BsK4Nrrq.js}

@@ -26,7 +26,7 @@ const {
 } = __cjs_getBuiltinModule("node:url");
 import { resolve, parse, isAbsolute, dirname } from '@visulima/path';
 import { toPath } from '@visulima/path/utils';
-import { FIND_UP_STOP } from './F_OK-MldBaGxb.js';
+import { FIND_UP_STOP } from './F_OK-BalxCn9n.js';
 
 const findUpSync = (name, options = {}) => {
   if (typeof name !== "string" && !Array.isArray(name) && typeof name !== "function") {

package/dist/packem_shared/{isAccessible-DuVrTNFV.js → isAccessible-iOp0Bou6.js}

@@ -21,7 +21,7 @@ const {
   access
 } = __cjs_getBuiltinModule("node:fs/promises");
 import { toPath } from '@visulima/path/utils';
-import { F_OK } from './F_OK-MldBaGxb.js';
+import { F_OK } from './F_OK-BalxCn9n.js';
 import assertValidFileOrDirectoryPath from './assertValidFileOrDirectoryPath-8HANmVjk.js';
 
 async function isAccessible(path, mode = F_OK) {

package/dist/packem_shared/{isAccessibleSync-DI8mM0fA.js → isAccessibleSync-38BmiIcx.js}

@@ -21,7 +21,7 @@ const {
   accessSync
 } = __cjs_getBuiltinModule("node:fs");
 import { toPath } from '@visulima/path/utils';
-import { F_OK } from './F_OK-MldBaGxb.js';
+import { F_OK } from './F_OK-BalxCn9n.js';
 import assertValidFileOrDirectoryPath from './assertValidFileOrDirectoryPath-8HANmVjk.js';
 
 function isAccessibleSync(path, mode = F_OK) {

package/dist/packem_shared/{move-DbpW5_vA.js → move-BD6JbYSu.js}

@@ -28,14 +28,14 @@ const {
   unlink
 } = __cjs_getBuiltinModule("node:fs/promises");
 import { dirname, resolve } from '@visulima/path';
-import isAccessible from './isAccessible-DuVrTNFV.js';
+import isAccessible from './isAccessible-iOp0Bou6.js';
 const {
   mkdirSync,
   renameSync: renameSync$1,
   copyFileSync,
   unlinkSync
 } = __cjs_getBuiltinModule("node:fs");
-import isAccessibleSync from './isAccessibleSync-DI8mM0fA.js';
+import isAccessibleSync from './isAccessibleSync-38BmiIcx.js';
 
 class SameDirectoryError extends Error {
   constructor(source, destination) {

package/dist/packem_shared/{readFile-iHOVXeH-.js → readFile-XVOjAw8r.js}

@@ -25,9 +25,9 @@ const {
   brotliDecompress
 } = __cjs_getBuiltinModule("node:zlib");
 import { toPath } from '@visulima/path/utils';
-import { R_OK } from './F_OK-MldBaGxb.js';
+import { R_OK } from './F_OK-BalxCn9n.js';
 import PermissionError from './PermissionError-1qs0skfo.js';
-import isAccessible from './isAccessible-DuVrTNFV.js';
+import isAccessible from './isAccessible-iOp0Bou6.js';
 import assertValidFileOrDirectoryPath from './assertValidFileOrDirectoryPath-8HANmVjk.js';
 
 const decompressionMethods = {
@@ -48,18 +48,15 @@ const readFile = async (path, options) => {
   }
   const { buffer, compression, encoding, flag } = options ?? {};
   return await readFile$1(path, flag ? { encoding, flag } : { encoding }).then(
-    async (content) => (
-      // eslint-disable-next-line compat/compat
-      await new Promise((resolve, reject) => {
-        decompressionMethods[compression ?? "none"](content, (error, result) => {
-          if (error) {
-            reject(error);
-          } else {
-            resolve(buffer ? result : result.toString());
-          }
-        });
-      })
-    )
+    async (content) => await new Promise((resolve, reject) => {
+      decompressionMethods[compression ?? "none"](content, (error, result) => {
+        if (error) {
+          reject(error);
+        } else {
+          resolve(buffer ? result : result.toString());
+        }
+      });
+    })
   ).catch((error) => {
     throw error;
   });

package/dist/packem_shared/{readFileSync-BkEj9BQY.js → readFileSync-B9Zg5PSF.js}

@@ -25,9 +25,9 @@ const {
   brotliDecompressSync
 } = __cjs_getBuiltinModule("node:zlib");
 import { toPath } from '@visulima/path/utils';
-import { R_OK } from './F_OK-MldBaGxb.js';
+import { R_OK } from './F_OK-BalxCn9n.js';
 import PermissionError from './PermissionError-1qs0skfo.js';
-import isAccessibleSync from './isAccessibleSync-DI8mM0fA.js';
+import isAccessibleSync from './isAccessibleSync-38BmiIcx.js';
 import assertValidFileOrDirectoryPath from './assertValidFileOrDirectoryPath-8HANmVjk.js';
 
 const decompressionMethods = {

package/dist/packem_shared/{readJson-pdfQBWDR.js → readJson-Dra2m6s-.js}

@@ -1,6 +1,6 @@
 import { toPath } from '@visulima/path/utils';
 import parseJson from './parseJson-CqUuRguZ.js';
-import readFile from './readFile-iHOVXeH-.js';
+import readFile from './readFile-XVOjAw8r.js';
 
 async function readJson(path, reviver, options) {
   if (typeof reviver === "object") {

package/dist/packem_shared/{readJsonSync-BZqGcA5d.js → readJsonSync-B6Dl1I_6.js}

@@ -1,6 +1,6 @@
 import { toPath } from '@visulima/path/utils';
 import parseJson from './parseJson-CqUuRguZ.js';
-import readFileSync from './readFileSync-BkEj9BQY.js';
+import readFileSync from './readFileSync-B9Zg5PSF.js';
 
 function readJsonSync(path, reviver, options) {
   if (typeof reviver === "object") {

package/dist/packem_shared/{readYaml-BQXTlR2p.js → readYaml-Bu1nsexB.js}

@@ -1,5 +1,5 @@
 import { parse } from 'yaml';
-import readFile from './readFile-iHOVXeH-.js';
+import readFile from './readFile-XVOjAw8r.js';
 
 async function readYaml(path, reviver, options) {
   const { buffer, compression, encoding = "utf8", flag, ...parseOptions } = options ?? {};

package/dist/packem_shared/{readYamlSync-BBBQ5ujx.js → readYamlSync-Di88aMME.js}

@@ -1,5 +1,5 @@
 import { parse } from 'yaml';
-import readFileSync from './readFileSync-BkEj9BQY.js';
+import readFileSync from './readFileSync-B9Zg5PSF.js';
 
 function readYamlSync(path, reviver, options) {
   const { buffer, compression, encoding = "utf8", flag, ...parseOptions } = options ?? {};

package/dist/packem_shared/{stripJsonComments-vo4k0mpF.js → stripJsonComments-21XWVDwP.js}

@@ -1,4 +1,4 @@
-import { INTERNAL_STRIP_JSON_REGEX } from './F_OK-MldBaGxb.js';
+import { INTERNAL_STRIP_JSON_REGEX } from './F_OK-BalxCn9n.js';
 
 const stripJsonComments = (jsonString, { whitespace = true } = {}) => (
   // This regular expression translates to:

package/dist/packem_shared/{writeFile-DSHERs0Z.js → writeFile-NT1fLEEe.js}

@@ -28,8 +28,8 @@ const {
 } = __cjs_getBuiltinModule("node:fs/promises");
 import { dirname } from '@visulima/path';
 import { toPath } from '@visulima/path/utils';
-import { F_OK } from './F_OK-MldBaGxb.js';
-import isAccessible from './isAccessible-DuVrTNFV.js';
+import { F_OK } from './F_OK-BalxCn9n.js';
+import isAccessible from './isAccessible-iOp0Bou6.js';
 import assertValidFileContents from './assertValidFileContents-BmcLtsGd.js';
 import assertValidFileOrDirectoryPath from './assertValidFileOrDirectoryPath-8HANmVjk.js';
 import { t as toUint8Array } from './to-uint-8-array-Dz2nF1y1.js';

package/dist/packem_shared/{writeFileSync-CJp1kXQR.js → writeFileSync-Bj5UDSf0.js}

@@ -28,8 +28,8 @@ const {
 } = __cjs_getBuiltinModule("node:fs");
 import { dirname } from '@visulima/path';
 import { toPath } from '@visulima/path/utils';
-import { F_OK } from './F_OK-MldBaGxb.js';
-import isAccessibleSync from './isAccessibleSync-DI8mM0fA.js';
+import { F_OK } from './F_OK-BalxCn9n.js';
+import isAccessibleSync from './isAccessibleSync-38BmiIcx.js';
 import assertValidFileContents from './assertValidFileContents-BmcLtsGd.js';
 import assertValidFileOrDirectoryPath from './assertValidFileOrDirectoryPath-8HANmVjk.js';
 import { t as toUint8Array } from './to-uint-8-array-Dz2nF1y1.js';

package/dist/packem_shared/{writeJson-C0OfLDbe.js → writeJson-DQLdAi0d.js}

@@ -21,9 +21,9 @@ const {
   readFile
 } = __cjs_getBuiltinModule("node:fs/promises");
 import { d as detectIndent } from './index-CHM-in-V.js';
-import { R_OK } from './F_OK-MldBaGxb.js';
-import isAccessible from './isAccessible-DuVrTNFV.js';
-import writeFile from './writeFile-DSHERs0Z.js';
+import { R_OK } from './F_OK-BalxCn9n.js';
+import isAccessible from './isAccessible-iOp0Bou6.js';
+import writeFile from './writeFile-NT1fLEEe.js';
 
 const writeJson = async (path, data, options = {}) => {
   const { detectIndent: detectIndent$1, indent: indentOption, replacer, stringify = JSON.stringify, ...writeOptions } = { indent: "	", ...options };

package/dist/packem_shared/{writeJsonSync-Cs21FE7v.js → writeJsonSync-DvTCjVUi.js}

@@ -21,9 +21,9 @@ const {
   readFileSync
 } = __cjs_getBuiltinModule("node:fs");
 import { d as detectIndent } from './index-CHM-in-V.js';
-import { R_OK } from './F_OK-MldBaGxb.js';
-import isAccessibleSync from './isAccessibleSync-DI8mM0fA.js';
-import writeFileSync from './writeFileSync-CJp1kXQR.js';
+import { R_OK } from './F_OK-BalxCn9n.js';
+import isAccessibleSync from './isAccessibleSync-38BmiIcx.js';
+import writeFileSync from './writeFileSync-Bj5UDSf0.js';
 
 const writeJsonSync = (path, data, options = {}) => {
   const { detectIndent: detectIndent$1, indent: indentOption, replacer, stringify = JSON.stringify, ...writeOptions } = { indent: "	", ...options };

package/dist/packem_shared/{writeYaml-n4xzYN9a.js → writeYaml-BMY0kOPf.js}

@@ -1,5 +1,5 @@
 import { stringify } from 'yaml';
-import writeFile from './writeFile-DSHERs0Z.js';
+import writeFile from './writeFile-NT1fLEEe.js';
 
 async function writeYaml(path, data, replacer, options) {
   let stringifyOptions;

package/dist/packem_shared/{writeYamlSync-DnOEnP10.js → writeYamlSync-DqPu8cCd.js}

@@ -1,5 +1,5 @@
 import { stringify } from 'yaml';
-import writeFileSync from './writeFileSync-CJp1kXQR.js';
+import writeFileSync from './writeFileSync-Bj5UDSf0.js';
 
 function writeYamlSync(path, data, replacer, options) {
   let stringifyOptions;

package/dist/read/read-file-sync.d.ts

@@ -0,0 +1,37 @@
+import type { ContentType, ReadFileOptions } from "../types.d.ts";
+type DecompressionMethod = (buffer: Buffer, callback: (error: Error | null, result: Buffer) => void) => void;
+declare const decompressionMethods: Record<string, DecompressionMethod>;
+/**
+ * Synchronously reads the entire contents of a file.
+ * It can also decompress the file content if a `compression` option is provided.
+ * @template O - The type of the options object, extending {@link ReadFileOptions}.
+ * @param path The path to the file to read. Can be a file URL or a string path.
+ * @param options Optional configuration for reading the file. See {@link ReadFileOptions}.
+ * Available `compression` methods: "brotli", "gzip", "none" (default).
+ * @returns The file content. The type of the content (string or Buffer)
+ * depends on the `buffer` option (defaults to string if `buffer` is false or not set).
+ * @example
+ * ```javascript
+ * import { readFileSync } from "@visulima/fs";
+ * import { join } from "node:path";
+ *
+ * try {
+ *   // Read a regular text file
+ *   const content = readFileSync(join("path", "to", "my-file.txt"));
+ *   console.log("File content:", content);
+ *
+ *   // Read a file as a Buffer
+ *   const bufferContent = readFileSync(join("path", "to", "another-file.bin"), { buffer: true });
+ *   console.log("Buffer length:", bufferContent.length);
+ *
+ *   // Read and decompress a gzipped file
+ *   // Assume my-archive.txt.gz exists
+ *   // const decompressedContent = readFileSync(join("path", "to", "my-archive.txt.gz"), { compression: "gzip", encoding: "utf8" });
+ *   // console.log("Decompressed content:", decompressedContent);
+ * } catch (error) {
+ *   console.error("Failed to read file:", error);
+ * }
+ * ```
+ */
+declare const readFileSync: <O extends ReadFileOptions<keyof typeof decompressionMethods> | undefined = undefined>(path: URL | string, options?: O) => ContentType<O>;
+export default readFileSync;

package/dist/read/read-file.d.ts

@@ -0,0 +1,41 @@
+import type { ContentType, ReadFileOptions } from "../types.d.ts";
+type DecompressionMethod = (buffer: Buffer, callback: (error: Error | null, result: Buffer) => void) => void;
+declare const decompressionMethods: Record<string, DecompressionMethod>;
+/**
+ * Asynchronously reads the entire contents of a file.
+ * It can also decompress the file content if a `compression` option is provided.
+ * @template O - The type of the options object, extending {@link ReadFileOptions}.
+ * @param path The path to the file to read. Can be a file URL or a string path.
+ * @param options Optional configuration for reading the file. See {@link ReadFileOptions}.
+ * Available `compression` methods: "brotli", "gzip", "none" (default).
+ * @returns A promise that resolves with the file content. The type of the content (string or Buffer)
+ * depends on the `buffer` option (defaults to string if `buffer` is false or not set).
+ * @example
+ * ```javascript
+ * import { readFile } from "@visulima/fs";
+ * import { join } from "node:path";
+ *
+ * const readMyFile = async () => {
+ *   try {
+ *     // Read a regular text file
+ *     const content = await readFile(join("path", "to", "my-file.txt"));
+ *     console.log("File content:", content);
+ *
+ *     // Read a file as a Buffer
+ *     const bufferContent = await readFile(join("path", "to", "another-file.bin"), { buffer: true });
+ *     console.log("Buffer length:", bufferContent.length);
+ *
+ *     // Read and decompress a gzipped file
+ *     // Assume my-archive.txt.gz exists
+ *     // const decompressedContent = await readFile(join("path", "to", "my-archive.txt.gz"), { compression: "gzip", encoding: "utf8" });
+ *     // console.log("Decompressed content:", decompressedContent);
+ *   } catch (error) {
+ *     console.error("Failed to read file:", error);
+ *   }
+ * };
+ *
+ * readMyFile();
+ * ```
+ */
+declare const readFile: <O extends ReadFileOptions<keyof typeof decompressionMethods> | undefined = undefined>(path: URL | string, options?: O) => Promise<ContentType<O>>;
+export default readFile;

package/dist/read/read-json-sync.d.ts

@@ -0,0 +1,5 @@
+import type { JsonValue } from "type-fest";
+import type { JsonReviver, ReadJsonOptions } from "../types.d.ts";
+declare function readJsonSync<T extends JsonValue>(path: URL | string, options?: ReadJsonOptions): T;
+declare function readJsonSync<T extends JsonValue>(path: URL | string, reviver: JsonReviver, options?: ReadJsonOptions): T;
+export default readJsonSync;

package/dist/read/read-json.d.ts

@@ -0,0 +1,5 @@
+import type { JsonValue } from "type-fest";
+import type { JsonReviver, ReadJsonOptions } from "../types.d.ts";
+declare function readJson<T extends JsonValue>(path: URL | string, options?: ReadJsonOptions): Promise<T>;
+declare function readJson<T extends JsonValue>(path: URL | string, reviver: JsonReviver, options?: ReadJsonOptions): Promise<T>;
+export default readJson;

package/dist/read/read-yaml-sync.d.ts

@@ -0,0 +1,4 @@
+import type { ReadYamlOptions, YamlReviver } from "../types.d.ts";
+declare function readYamlSync<R = Record<string, unknown>>(path: URL | string, options?: ReadYamlOptions<"brotli" | "gzip" | "none">): R;
+declare function readYamlSync<R = Record<string, unknown>>(path: URL | string, reviver?: YamlReviver, options?: ReadYamlOptions<"brotli" | "gzip" | "none">): R;
+export default readYamlSync;

package/dist/read/read-yaml.d.ts

@@ -0,0 +1,4 @@
+import type { ReadYamlOptions, YamlReviver } from "../types.d.ts";
+declare function readYaml<R = Record<string, unknown>>(path: URL | string, options?: ReadYamlOptions<"brotli" | "gzip" | "none">): Promise<R>;
+declare function readYaml<R = Record<string, unknown>>(path: URL | string, reviver?: YamlReviver, options?: ReadYamlOptions<"brotli" | "gzip" | "none">): Promise<R>;
+export default readYaml;

package/dist/remove/empty-dir-sync.d.ts

@@ -0,0 +1,24 @@
+import type { RetryOptions } from "../types.d.ts";
+/**
+ * Ensures that a directory is empty.
+ * Deletes directory contents if the directory is not empty.
+ * If the directory does not exist, it is created.
+ * The directory itself is not deleted.
+ * @param dir The path to the directory to empty.
+ * @param options Optional configuration for the operation. See {@link RetryOptions}.
+ * @returns void
+ * @example
+ * ```javascript
+ * import { emptyDirSync } from "@visulima/fs";
+ * import { join } from "node:path";
+ *
+ * try {
+ *   emptyDirSync(join("/tmp", "my-app-temp"));
+ *   console.log("Temporary directory emptied or created.");
+ * } catch (error) {
+ *   console.error("Failed to empty directory:", error);
+ * }
+ * ```
+ */
+declare const emptyDirSync: (dir: URL | string, options?: RetryOptions) => void;
+export default emptyDirSync;

package/dist/remove/empty-dir.d.ts

@@ -0,0 +1,28 @@
+import type { RetryOptions } from "../types.d.ts";
+/**
+ * Ensures that a directory is empty.
+ * Deletes directory contents if the directory is not empty.
+ * If the directory does not exist, it is created.
+ * The directory itself is not deleted.
+ * @param dir The path to the directory to empty.
+ * @param options Optional configuration for the operation. See {@link RetryOptions}.
+ * @returns A promise that resolves when the directory is empty.
+ * @example
+ * ```javascript
+ * import { emptyDir } from "@visulima/fs";
+ * import { join } from "node:path";
+ *
+ * const clearTempDir = async () => {
+ *   try {
+ *     await emptyDir(join("/tmp", "my-app-temp"));
+ *     console.log("Temporary directory emptied or created.");
+ *   } catch (error) {
+ *     console.error("Failed to empty directory:", error);
+ *   }
+ * };
+ *
+ * clearTempDir();
+ * ```
+ */
+declare const emptyDir: (dir: URL | string, options?: RetryOptions) => Promise<void>;
+export default emptyDir;

package/dist/remove/remove-sync.d.ts

@@ -0,0 +1,28 @@
+import type { RetryOptions } from "../types.d.ts";
+/**
+ * Synchronously removes a file or directory (recursively).
+ * If the path does not exist, it does nothing.
+ * @param path The path to the file or directory to remove.
+ * @param options Optional configuration for the operation. See {@link RetryOptions}.
+ * @returns void
+ * @example
+ * ```javascript
+ * import { removeSync } from "@visulima/fs";
+ * import { join } from "node:path";
+ *
+ * try {
+ *   removeSync(join("/tmp", "my-file.txt"));
+ *   console.log("File /tmp/my-file.txt removed.");
+ *
+ *   removeSync(join("/tmp", "my-empty-dir"));
+ *   console.log("Directory /tmp/my-empty-dir removed.");
+ *
+ *   removeSync(join("/tmp", "my-dir-with-contents"));
+ *   console.log("Directory /tmp/my-dir-with-contents and its contents removed.");
+ * } catch (error) {
+ *   console.error("Failed to remove path:", error);
+ * }
+ * ```
+ */
+declare const removeSync: (path: URL | string, options?: RetryOptions) => void;
+export default removeSync;

package/dist/remove/remove.d.ts

@@ -0,0 +1,32 @@
+import type { RetryOptions } from "../types.d.ts";
+/**
+ * Asynchronously removes a file or directory (recursively).
+ * If the path does not exist, it does nothing.
+ * @param path The path to the file or directory to remove.
+ * @param options Optional configuration for the operation. See {@link RetryOptions}.
+ * @returns A promise that resolves when the path has been removed.
+ * @example
+ * ```javascript
+ * import { remove } from "@visulima/fs";
+ * import { join } from "node:path";
+ *
+ * const deleteFileOrDir = async () => {
+ *   try {
+ *     await remove(join("/tmp", "my-file.txt"));
+ *     console.log("File /tmp/my-file.txt removed.");
+ *
+ *     await remove(join("/tmp", "my-empty-dir"));
+ *     console.log("Directory /tmp/my-empty-dir removed.");
+ *
+ *     await remove(join("/tmp", "my-dir-with-contents"));
+ *     console.log("Directory /tmp/my-dir-with-contents and its contents removed.");
+ *   } catch (error) {
+ *     console.error("Failed to remove path:", error);
+ *   }
+ * };
+ *
+ * deleteFileOrDir();
+ * ```
+ */
+declare const remove: (path: URL | string, options?: RetryOptions) => Promise<void>;
+export default remove;