@ix-xs/node-comfort 1.0.57 → 1.1.0

package/src/fs.js

@@ -1,656 +0,0 @@
-const { readdirSync, existsSync, mkdirSync, rmSync, writeFileSync, unlinkSync, copyFileSync, readFileSync, watch } = require("node:fs");
-const { resolve, dirname, sep, isAbsolute, join, relative, basename } = require("node:path");
-
-try {
-  process.loadEnvFile();
-}
-catch {}
-
-/**
- * @param {string} path
- */
-const _format = (path) => {
-  return path.replace(/\//g, sep).replace(/\\/g, sep);
-};
-/**
- * @returns {string|undefined}
- */
-const _caller = () => {
-  const opst = Error.prepareStackTrace;
-  Error.prepareStackTrace = (_, stack) => stack;
-  const e = new Error();
-  const s = e.stack;
-  Error.prepareStackTrace = opst;
-
-  if (s) {
-    for (const cs of s) {
-      const name = cs.getFileName();
-      if (
-        name &&
-      !name.startsWith("node:internal") &&
-      !name.includes("node_modules") &&
-      name !== s[0].getFileName()
-      ) {
-        return _format(name);
-      }
-    }
-  }
-  return undefined;
-};
-/**
- * @param {string} path
- * @param {boolean} [recursive=true]
- * @param {"folder"|"file"} [type="folder"]
- * @returns {string[]}
- */
-const _walk = (path = process.cwd(), recursive = true, type = "folder") => {
-  let result = [];
-  try {
-    for (const entry of readdirSync(path, { withFileTypes: true })) {
-      if (entry.name.includes("node_modules")) continue;
-      const _ = resolve(path, entry.name);
-
-      if (type === "folder" && entry.isDirectory()) {
-        result.push(_);
-        if (recursive) result = result.concat(_walk(_, recursive, type));
-      } else if (type === "file" && entry.isFile()) {
-        result.push(_);
-      } else if (type === "file" && entry.isDirectory() && recursive) {
-        result = result.concat(_walk(_, recursive, type));
-      }
-    }
-    return result;
-  } catch (error) {
-    return result;
-  }
-};
-/**
- * @param {string} path
- * @param {string} name
- * @returns {string|undefined}
- */
-const _firstFolder = (path, name) => {
-  try {
-    const entries = readdirSync(path, { withFileTypes: true });
-    for (const entry of entries) {
-      if (entry.name === name && entry.isDirectory()) {
-        return resolve(path, name);
-      }
-    }
-    for (const entry of entries) {
-      if (entry.isDirectory() && !entry.name.includes("node_modules")) {
-        const result = _firstFolder(resolve(path, entry.name), name);
-        if (result) return result;
-      }
-    }
-  } catch {}
-  return undefined;
-};
-/**
- * @param {string} path
- * @param {string} name
- * @returns {string|undefined}
- */
-const _firstFile = (path, name) => {
-  try {
-    const entries = readdirSync(path, { withFileTypes: true });
-    for (const entry of entries) {
-      if (entry.name === name && entry.isFile()) {
-        return resolve(path, name);
-      }
-    }
-    for (const entry of entries) {
-      if (entry.isDirectory() && !entry.name.includes("node_modules")) {
-        const result = _firstFile(resolve(path, entry.name), name);
-        if (result) return result;
-      }
-    }
-  } catch {}
-  return undefined;
-};
-/**
- * @param {string} [path=process.cwd()]
- * @param {"folder"|"file"} [type="folder"]
- * @returns {string|undefined}
- */
-const _target = (path = process.cwd(), type = "folder") => {
-  if (path === process.cwd()) return path;
-
-  let absolute;
-  const caller = dirname(_caller() || process.cwd());
-
-  if (
-    _format(path).startsWith(_format("./")) ||
-  _format(path).startsWith(_format("../"))
-  ) {
-    absolute = resolve(caller, path);
-  } else if (isAbsolute(path)) {
-    absolute = _format(path);
-  } else {
-    absolute = resolve(process.cwd(), _format(path));
-    if (!existsSync(absolute)) {
-      absolute =
-      type === "folder"
-        ? (_firstFolder(process.cwd(), _format(path)) ?? undefined)
-        : (_firstFile(process.cwd(), _format(path)) ?? undefined);
-    }
-  }
-
-  if (absolute && existsSync(absolute)) return _format(absolute);
-  return undefined;
-};
-
-module.exports = {
-  /**
-   * @param {string} value
-   */
-  getEnv(value, envFilePath) {
-    return process.env[value];
-  },
-  /**
-	 * @param {string} [path=process.cwd()]
-	 */
-  createPath(path = process.cwd()) {
-    const target = _target(path);
-    return target
-      ? target
-      : isAbsolute(path)
-        ? path
-        : path.startsWith("./") || path.startsWith("../")
-          ? resolve(dirname(_caller()), path)
-          : resolve(process.cwd(), path);
-  },
-  /**
-	 * @param {string} [path]
-	 * @param {boolean} [recursive]
-	 */
-  getFoldersIn(path = process.cwd(), recursive = true) {
-    const target = _target(path ?? process.cwd());
-    return target ? _walk(target, recursive) : undefined;
-  },
-  /**
-	 * @param {string} [path]
-	 */
-  getFolder(path = process.cwd()) {
-    return _target(path ?? process.cwd());
-  },
-  /**
-	 * @param {string} [path]
-	 * @param {boolean} [recursive]
-	 */
-  getFilesIn(path = process.cwd(), recursive = true) {
-    const target = _target(path ?? process.cwd());
-    return target ? _walk(target, recursive, "file") : undefined;
-  },
-  /**
-	 * @param {string} path
-	 */
-  getFile(path) {
-    return path ? _target(path, "file") : path;
-  },
-  /**
-	 * @param {string} path
-	 * @param {boolean} [force]
-	 */
-  createFolder(path, force = false) {
-    if (!path) return undefined;
-    const target = this.createPath(path);
-
-    try {
-      if (this.getFolder(target)) {
-        if (force) {
-          this.deleteFolder(target);
-          mkdirSync(target, { recursive: true });
-          return true;
-        }
-        return false;
-      }
-      mkdirSync(target, { recursive: true });
-      return true;
-    } catch {
-      return false;
-    }
-  },
-  /**
-	 * @param {string} path
-	 * @param {boolean} [force]
-	 * @param {string|object|null|undefined} [data]
-	 */
-  createFile(path, force = false, data) {
-    if (!path) return undefined;
-    const target = this.createPath(path);
-    const content =
-			data === null || typeof data === "undefined"
-			  ? ""
-			  : typeof data === "string"
-			    ? data
-			    : JSON.stringify(data, null, 2);
-
-    try {
-      if (this.getFile(target)) {
-        if (force) {
-          this.deleteFile(target);
-          writeFileSync(target, content, "utf8");
-          return true;
-        }
-        return false;
-      }
-
-      if (!this.getFolder(dirname(target))) {
-        this.createFolder(dirname(target));
-      }
-
-      writeFileSync(target, content, "utf8");
-      return true;
-    } catch {
-      return false;
-    }
-  },
-  /**
-	 * @param {string} [path]
-	 * @param {(folder: string) => boolean} [filter]
-	 */
-  deleteFoldersIn(path = process.cwd(), filter = () => true) {
-    const target = _target(path);
-    if (!target) return undefined;
-
-    const folders = this.getFoldersIn(target);
-    let deleted = 0;
-
-    for (const folder of folders.map(_format)) {
-      if (!filter(folder)) continue;
-      this.deleteFolder(folder);
-      deleted++;
-    }
-    return deleted;
-  },
-  /**
-	 * @param {string} path
-	 */
-  deleteFolder(path) {
-    const target = path ? _target(path) : path;
-    if (!target || !this.getFolder(target)) return undefined;
-
-    try {
-      rmSync(target, { recursive: true, force: true });
-      return true;
-    } catch {
-      return false;
-    }
-  },
-  /**
-	 * @param {string} [path=process.cwd()]
-	 * @param {boolean} [recursive=false]
-	 * @param {(file: string) => boolean} [filter]
-	 */
-  deleteFilesIn(path = process.cwd(), recursive = false, filter = () => true) {
-    const target = _target(path);
-    if (!target) return undefined;
-
-    const files = this.getFilesIn(target, recursive);
-    let deleted = 0;
-
-    for (const file of files.map(_format)) {
-      if (!filter(file)) continue;
-      this.deleteFile(file);
-      deleted++;
-    }
-    return deleted;
-  },
-  /**
-	 * @param {string} path
-	 */
-  deleteFile(path) {
-    const target = path ? _target(path, "file") : path;
-    if (!target || !this.getFile(target)) return undefined;
-
-    try {
-      unlinkSync(target);
-      return true;
-    } catch {
-      return false;
-    }
-  },
-  /**
-	 * @param {Object} options
-	 * @param {string} options.dest
-	 * @param {string} [options.path]
-	 * @param {boolean} [options.recursive=true]
-	 * @param {boolean} [options.withFiles=false]
-	 * @param {boolean} [options.force=false]
-	 * @param {(folder: string) => boolean} [options.filter]
-	 */
-  copyFoldersIn(options) {
-    const target = _target(options.path ?? process.cwd());
-    if (!target || !options.dest) return undefined;
-
-    const folders = this.getFoldersIn(target, options.recursive ?? true) ?? [];
-    options.filter =
-			typeof options.filter === "function" ? options.filter : () => true;
-    let copied = 0;
-
-    for (const folder of folders.map(_format)) {
-      if (!options.filter(folder)) continue;
-
-      const destFolder = join(
-        this.createPath(options.dest),
-        relative(target, folder),
-      );
-
-      if (options.force && this.getFolder(destFolder)) {
-        this.deleteFolder(destFolder);
-      }
-
-      this.createFolder(destFolder);
-      copied++;
-
-      if (options.withFiles) {
-        if (options.recursive) {
-          for (const file of this.getFilesIn(folder, true) ?? []) {
-            const destFile = join(destFolder, relative(folder, file));
-            this.createFolder(dirname(destFile));
-            copyFileSync(file, destFile);
-          }
-        } else {
-          for (const file of this.getFilesIn(folder, false) ?? []) {
-            const destFile = join(destFolder, basename(file));
-            copyFileSync(file, destFile);
-          }
-        }
-      }
-    }
-    return copied;
-  },
-  /**
-	 * @param {Object} options
-	 * @param {string} options.dest
-	 * @param {string} [options.path]
-	 * @param {boolean} [options.recursive=false]
-	 * @param {boolean} [options.withFiles=false]
-	 * @param {boolean} [options.force=false]
-	 */
-  copyFolder(options) {
-    const target = _target(options.path ?? process.cwd());
-    const dest = this.createPath(options.dest);
-
-    if (!target || !dest) return undefined;
-
-    if (options.force && this.getFolder(dest)) {
-      this.deleteFolder(dest);
-    }
-
-    this.createFolder(dest);
-
-    if (options.recursive) {
-      for (const folder of this.getFoldersIn(target, true) ?? []) {
-        const destFolder = join(dest, relative(target, folder));
-        this.createFolder(destFolder);
-
-        if (options.withFiles) {
-          for (const file of this.getFilesIn(folder, false) ?? []) {
-            const destFile = join(destFolder, basename(file));
-            copyFileSync(file, destFile);
-          }
-        }
-      }
-
-      if (options.withFiles) {
-        for (const file of this.getFilesIn(target, false) ?? []) {
-          const destFile = join(dest, basename(file));
-          copyFileSync(file, destFile);
-        }
-      }
-    } else {
-      if (options.withFiles) {
-        for (const file of this.getFilesIn(target, false) ?? []) {
-          const destFile = join(dest, basename(file));
-          copyFileSync(file, destFile);
-        }
-      }
-    }
-    return true;
-  },
-  /**
-	 * @param {Object} options
-	 * @param {string} options.dest
-	 * @param {string} [options.path]
-	 * @param {boolean} [options.recursive=true]
-	 * @param {boolean} [options.force=false]
-	 * @param {(file: string) => boolean} [options.filter]
-	 */
-  copyFilesIn(options) {
-    const target = _target(options.path ?? process.cwd());
-    const destBase = this.createPath(options.dest);
-
-    if (!target || !options.dest) return undefined;
-
-    const recursive = options.recursive ?? true;
-    const files = this.getFilesIn(target, recursive) ?? [];
-    const filter =
-			typeof options.filter === "function" ? options.filter : () => true;
-    let copied = 0;
-
-    for (const file of files.map(_format)) {
-      if (!filter(file)) continue;
-
-      const destFile = join(
-        destBase,
-        recursive ? relative(target, file) : basename(file),
-      );
-
-      if (options.force && this.getFile(destFile)) {
-        this.deleteFile(destFile);
-      }
-
-      this.createFolder(dirname(destFile));
-      copyFileSync(file, destFile);
-      copied++;
-    }
-    return copied;
-  },
-  /**
-	 * @param {Object} options
-	 * @param {string} options.path
-	 * @param {string} options.dest
-	 * @param {boolean} [options.force=false]
-	 */
-  copyFile(options) {
-    const target = _target(options.path, "file");
-    if (!target || !options.dest) return undefined;
-
-    let destFile;
-    if (
-      !basename(options.dest) ||
-			options.dest.endsWith("/") ||
-			options.dest.endsWith("\\")
-    ) {
-      destFile = join(this.createPath(options.dest), basename(target));
-    } else {
-      destFile = this.createPath(options.dest);
-    }
-
-    if (options.force && this.getFile(destFile)) {
-      this.deleteFile(destFile);
-    }
-
-    this.createFolder(dirname(destFile));
-    copyFileSync(target, destFile);
-    return true;
-  },
-  /**
-   * @param {Object} options
-   * @param {string} options.dest
-   * @param {string} [options.path]
-   * @param {boolean} [options.recursive=true]
-   * @param {boolean} [options.withFiles=false]
-   * @param {boolean} [options.force=false]
-   * @param {(folder: string) => boolean} [options.filter]
-	 */
-  moveFoldersIn(options) {
-    const copied = this.copyFoldersIn(options);
-    if (copied === undefined || !options.path) return copied;
-
-    const target = _target(options.path);
-    if (!target) return copied;
-
-    const folders = this.getFoldersIn(target, options.recursive ?? true) ?? [];
-    options.filter =
-			typeof options.filter === "function" ? options.filter : () => true;
-
-    for (const folder of folders.map(_format)) {
-      if (!options.filter(folder)) continue;
-      this.deleteFolder(folder);
-    }
-    return copied;
-  },
-  /**
-   * @param {Object} options
-   * @param {string} options.path
-   * @param {string} options.dest
-   * @param {boolean} [options.recursive=false]
-   * @param {boolean} [options.withFiles=false]
-   * @param {boolean} [options.force=false]
-	 */
-  moveFolder(options) {
-    const copied = this.copyFolder(options);
-    const target = _target(options.path);
-    if (!target) return copied;
-
-    this.deleteFolder(target);
-    return copied;
-  },
-  /**
-   * @param {Object} options
-   * @param {string} options.dest
-   * @param {string} [options.path]
-   * @param {boolean} [options.recursive=true]
-   * @param {boolean} [options.force=false]
-   * @param {(file: string) => boolean} [options.filter]
-	 */
-  moveFilesIn(options) {
-    const copied = this.copyFilesIn(options);
-    if (copied === undefined || !options.path) return copied;
-
-    const target = _target(options.path ?? process.cwd());
-    if (!target) return copied;
-
-    const files = this.getFilesIn(target, options.recursive ?? true) ?? [];
-    const filter =
-			typeof options.filter === "function" ? options.filter : () => true;
-
-    for (const file of files.map(_format)) {
-      if (!filter(file)) continue;
-      this.deleteFile(file);
-    }
-    return copied;
-  },
-  /**
-   * @param {Object} options
-   * @param {string} options.path
-   * @param {string} options.dest
-   * @param {boolean} [options.force=false]
-	 */
-  moveFile(options) {
-    const moved = this.copyFile(options);
-    if (moved) {
-      const target = _target(options.path, "file");
-      if (target) this.deleteFile(target);
-    }
-    return moved;
-  },
-  /**
-	 * @param {string} path
-	 */
-  readFile(path) {
-    const target = _target(path, "file");
-    if (!target) return undefined;
-
-    try {
-      return readFileSync(target, "utf8");
-    } catch {
-      return undefined;
-    }
-  },
-  /**
-	 * @param {Object} [options]
-	 * @param {string} [options.path=process.cwd()]
-	 * @param {boolean} [options.recursive=false]
-	 * @param {(event: string, file: string) => boolean} [options.filter]
-	 */
-  watch(options = {}) {
-    const target = _target(options.path ?? process.cwd());
-    if (!target) return undefined;
-
-    let paused = false;
-    const listeners = {};
-
-    /**
-     * @param {"rename"|"change"|"all"} event
-     * @param {string} file
-     */
-    const handler = (event, file) => {
-      if (paused) return;
-      if (
-        typeof options.filter === "function" &&
-				!options.filter(event, file)
-      ) {
-        return;
-      }
-
-      if (listeners[event]) {
-        for (const cb of listeners[event]) cb(file);
-      }
-      if (listeners["all"]) {
-        for (const cb of listeners["all"]) cb(event, file);
-      }
-    };
-
-    const addListener = (type, callback) => {
-      listeners[type] = listeners[type] ?? [];
-      listeners[type].push(callback);
-    };
-
-    const watcher = watch(
-      target,
-      { recursive: options.recursive ?? false },
-      (eventType, fileName) => {
-        handler(eventType, fileName ? join(target, fileName) : target);
-      },
-    );
-
-    return {
-      /**
-       * @typedef { "change" | "rename" | "all" } EventNames
-       * @typedef {{
-       * change: (file: string) => void|Promise<void>,
-       * rename: (file: string) => void|Promise<void>,
-       * all: (event: EventNames, file: string) => void|Promise<void>,
-       * }} EventHandlers
-       */
-      /**
-       * @template {EventNames} E
-			 * @param {E} event
-			 * @param {EventHandlers[E]} callback
-			 */
-      on(event, callback) {
-        addListener(event, callback);
-        return this;
-      },
-      stop() {
-        if (watcher) {
-          try {
-            watcher.close();
-          } catch {}
-        }
-      },
-      pause() {
-        paused = true;
-        return this;
-      },
-      resume() {
-        paused = false;
-        return this;
-      },
-    };
-  },
-};