@jestaubach/fs-helpers 0.2.24 → 0.2.26

package/README.md

@@ -2,8 +2,8 @@
 
 ## Badges
 
-[![Test Coverage](https://api.codeclimate.com/v1/badges/4896190d45c4fb79ce45/test_coverage)](https://codeclimate.com/github/JEStaubach/fs-helpers/test_coverage)
-[![Maintainability](https://api.codeclimate.com/v1/badges/4896190d45c4fb79ce45/maintainability)](https://codeclimate.com/github/JEStaubach/fs-helpers/maintainability)
+[![Maintainability](https://qlty.sh/gh/JEStaubach/projects/fs-helpers/maintainability.svg)](https://qlty.sh/gh/JEStaubach/projects/fs-helpers)
+[![Code Coverage](https://qlty.sh/gh/JEStaubach/projects/fs-helpers/coverage.svg)](https://qlty.sh/gh/JEStaubach/projects/fs-helpers)
 [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/626bca3c1fab45fcb7b6f658b7e04604)](https://app.codacy.com/gh/JEStaubach/fs-helpers/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/626bca3c1fab45fcb7b6f658b7e04604)](https://app.codacy.com/gh/JEStaubach/fs-helpers/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Known Vulnerabilities](https://snyk.io/test/github/JEStaubach/fs-helpers/badge.svg)](https://snyk.io/test/github/JEStaubach/fs-helpers)

package/dist/__tests__/fsHelpers.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/fs-helpers.js

@@ -1,36 +1,33 @@
-var N = Object.defineProperty;
-var q = (e, t, o) => t in e ? N(e, t, { enumerable: !0, configurable: !0, writable: !0, value: o }) : e[t] = o;
-var p = (e, t, o) => (q(e, typeof t != "symbol" ? t + "" : t, o), o);
-const { default: z } = (() => {
-  const e = require("fs-extra");
-  return e && e.__esModule ? e : Object.assign(/* @__PURE__ */ Object.create(null), e, { default: e, [Symbol.toStringTag]: "Module" });
-})(), { default: l } = (() => {
-  const e = require("path");
-  return e && e.__esModule ? e : Object.assign(/* @__PURE__ */ Object.create(null), e, { default: e, [Symbol.toStringTag]: "Module" });
-})(), n = /* @__PURE__ */ new Map();
-function R(e) {
-  const { root: t, dir: o } = l.parse(e), i = o.split(t).slice(1).join(t).split(l.sep);
-  for (let a = 0; a < i.length; a++) {
-    const d = [t, i.slice(0, a + 1).join(l.sep)].join("");
-    g(d);
-  }
-  const c = z.readFileSync(e).toString();
-  S(e, c);
+var d = Object.defineProperty;
+var S = (t, e, r) => e in t ? d(t, e, { enumerable: !0, configurable: !0, writable: !0, value: r }) : t[e] = r;
+var n = (t, e, r) => (S(t, typeof e != "symbol" ? e + "" : e, r), r);
+const c = {}, { default: v } = (() => {
+  const t = require("fs-extra");
+  return t && t.__esModule ? t : Object.assign(/* @__PURE__ */ Object.create(null), t, { default: t, [Symbol.toStringTag]: "Module" });
+})(), i = /* @__PURE__ */ new Map();
+function m(t) {
+  const { root: e, dir: r } = c.parse(t), s = r.split(e).slice(1).join(e).split(c.sep);
+  for (let u = 0; u < s.length; u++) {
+    const y = [e, s.slice(0, u + 1).join(c.sep)].join("");
+    f(y);
+  }
+  const o = v.readFileSync(t).toString();
+  l(t, o);
 }
-function B(e, t) {
-  const [o, i] = n.get(e) || ["", ""];
-  return Buffer.from(i);
+function p(t, e) {
+  const [r, s] = i.get(t) || ["", ""];
+  return Buffer.from(s);
 }
-function S(e, t, o) {
-  n.set(e, ["file", t]);
+function l(t, e, r) {
+  i.set(t, ["file", e]);
 }
-function L(e) {
-  return e === l.resolve(".") ? !0 : n.has(e);
+function g(t) {
+  return t === c.resolve(".") ? !0 : i.has(t);
 }
-function b(e, t) {
-  const [o, i] = n.get(e) || ["", ""], c = {
-    isDirectory: () => e === l.resolve(".") ? !0 : o === "dir",
-    isFile: () => n.has(e) && o === "file",
+function a(t, e) {
+  const [r, s] = i.get(t) || ["", ""], o = {
+    isDirectory: () => t === c.resolve(".") ? !0 : r === "dir",
+    isFile: () => i.has(t) && r === "file",
     isBlockDevice: () => !1,
     isCharacterDevice: () => !1,
     isSymbolicLink: () => !1,
@@ -55,230 +52,183 @@ function b(e, t) {
     ctime: /* @__PURE__ */ new Date(0),
     birthtime: /* @__PURE__ */ new Date(0)
   };
-  return c.isBlockDevice(), c.isCharacterDevice(), c.isSymbolicLink(), c.isFIFO(), c.isSocket(), c;
+  return o.isBlockDevice(), o.isCharacterDevice(), o.isSymbolicLink(), o.isFIFO(), o.isSocket(), o;
 }
-function P(e, t) {
+function b(t, e) {
 }
-class V extends Error {
-  constructor(o) {
-    super(o);
-    p(this, "code");
+class F extends Error {
+  constructor(r) {
+    super(r);
+    n(this, "code");
     this.code = "ENOENT";
   }
 }
-function J(e, t) {
-  if (!n.has(e))
-    throw new V("source path not found");
-  for (const o of Array.from(n.keys()))
-    if (o.includes(e)) {
-      const i = o.split(e).join(t), c = n.get(o) || /* istanbul ignore next */
-      ["", ""];
-      n.delete(o), n.set(i, c);
-    }
+function E(t, e) {
+  const r = t, s = e;
+  if (!i.has(r))
+    throw new F("source path not found");
+  h(r, s, !0);
 }
-function Z(e, t, o) {
-  if (n.has(t))
-    throw Error("destination directory exists");
-  for (const i of Array.from(n.keys()))
-    if (i.includes(e)) {
-      const c = i.split(e).join(t);
-      n.set(
-        c,
-        n.get(i) || /* istanbul ignore next */
-        ["", ""]
-      );
-    }
+function h(t, e, r) {
+  const s = { source: t, target: e, deleteSource: r };
+  for (const o of Array.from(i.keys()))
+    D(o, s);
 }
-function g(e) {
-  if (b(e).isFile())
-    throw Error("file exists at destination");
-  let t;
-  const o = e.split(l.resolve(".")).join("").split(l.sep);
-  for (let i = 0; i < o.length; i++) {
-    const c = o.slice(0, i + 1).join(l.sep);
-    !n.has(`${l.resolve(".")}${c}`) && c !== "" && (n.set(`${l.resolve(".")}${c}`, ["dir", ""]), t = t ?? `${l.resolve(".")}${c}`);
-  }
-  return t;
+function D(t, e) {
+  if (!t.includes(e.source))
+    return;
+  const r = t.split(e.source).join(e.target), s = i.get(t) || /* istanbul ignore next */
+  ["", ""];
+  e.deleteSource && i.delete(t), i.set(r, s);
+}
+function k(t, e, r) {
+  if (i.has(e))
+    throw new Error("destination directory exists");
+  h(t, e, !1);
+}
+function x(t) {
+  let e;
+  const r = c.resolve(".");
+  for (let s = 0; s < t.length; s++) {
+    const o = t.slice(0, s + 1).join(c.sep), u = `${r}${o}`;
+    e = w(u, o, e);
+  }
+  return e;
+}
+function w(t, e, r) {
+  return i.has(t) || e === "" ? r : (i.set(t, ["dir", ""]), r ?? t);
 }
-function G(e) {
-  for (const t of Array.from(n.keys()))
-    t.includes(e) && n.delete(t);
+function f(t) {
+  if (a(t).isFile())
+    throw new Error("file exists at destination");
+  const e = t.split(c.resolve(".")).join("").split(c.sep);
+  return x(e);
 }
-function H(e) {
-  n.has(e) || n.set(e, ["file", ""]);
+function $(t) {
+  for (const e of Array.from(i.keys()))
+    e.includes(t) && i.delete(e);
 }
-const K = { existsSync: L, lstatSync: b, chmodSync: P, renameSync: J, readFileSync: B, copySync: Z, removeSync: G, ensureFileSync: H, mkdirpSync: g, outputFileSync: S, seedFile: R }, { default: Q } = (() => {
-  const e = require("fs-extra");
-  return e && e.__esModule ? e : Object.assign(/* @__PURE__ */ Object.create(null), e, { default: e, [Symbol.toStringTag]: "Module" });
-})(), { default: h } = (() => {
-  const e = require("path");
-  return e && e.__esModule ? e : Object.assign(/* @__PURE__ */ Object.create(null), e, { default: e, [Symbol.toStringTag]: "Module" });
+function P(t) {
+  i.has(t) || i.set(t, ["file", ""]);
+}
+const A = { existsSync: g, lstatSync: a, chmodSync: b, renameSync: E, readFileSync: p, copySync: k, removeSync: $, ensureFileSync: P, mkdirpSync: f, outputFileSync: l, seedFile: m }, { default: _ } = (() => {
+  const t = require("fs-extra");
+  return t && t.__esModule ? t : Object.assign(/* @__PURE__ */ Object.create(null), t, { default: t, [Symbol.toStringTag]: "Module" });
 })();
-function U(e, t) {
-  const { existsSync: o, lstatSync: i, chmodSync: c, renameSync: a, readFileSync: d, copySync: D, removeSync: E, ensureFileSync: k, outputFileSync: $, mkdirpSync: F, seedFile: m } = e;
-  if (m !== void 0 && t !== void 0)
-    for (const r of t)
-      _(r);
-  function _(r) {
-    const s = u(r).value;
-    m(s);
-  }
-  function w(r, s) {
+class M {
+  constructor(e, r) {
+    n(this, "existsSync");
+    n(this, "lstatSync");
+    n(this, "chmodSync");
+    n(this, "renameSync");
+    n(this, "readFileSync");
+    n(this, "copySync");
+    n(this, "removeSync");
+    n(this, "ensureFileSync");
+    n(this, "outputFileSync");
+    n(this, "mkdirpSync");
+    n(this, "seedFile");
+    if ({
+      existsSync: this.existsSync,
+      lstatSync: this.lstatSync,
+      chmodSync: this.chmodSync,
+      renameSync: this.renameSync,
+      readFileSync: this.readFileSync,
+      copySync: this.copySync,
+      removeSync: this.removeSync,
+      ensureFileSync: this.ensureFileSync,
+      outputFileSync: this.outputFileSync,
+      mkdirpSync: this.mkdirpSync,
+      seedFile: this.seedFile
+    } = e, this.seedFile !== void 0 && r !== void 0)
+      for (const s of r)
+        this.mockExistingFile(s);
+  }
+  mockExistingFile(e) {
+    const r = this.getAbsolutePath(e).value;
+    this.seedFile(r);
+  }
+  readFile(e, r) {
     return {
       success: !0,
-      value: d(u(r).value, s),
+      value: this.readFileSync(this.getAbsolutePath(e).value, r),
       error: null
     };
   }
-  function j(r, s) {
-    return $(u(r).value, s), {
-      success: !0,
-      error: null
-    };
+  writeFile(e, r) {
+    return this.outputFileSync(this.getAbsolutePath(e).value, r), { success: !0, error: null };
   }
-  function x(r) {
-    const s = u(r).value;
-    return o(s) ? i(s).isFile() ? {
-      success: !0,
-      value: !0,
-      error: null
-    } : {
+  checkIfPathExists(e, r, s) {
+    const o = this.getAbsolutePath(e).value;
+    return this.existsSync(o) ? s(this.lstatSync(o)) ? { success: !0, value: !0, error: null } : {
       success: !1,
       value: !1,
-      error: `checkIfFileExists: '${r}' is not a file.`
-    } : {
-      success: !0,
-      value: !1,
-      error: null
-    };
+      error: `checkIf${r === "file" ? "File" : "Dir"}Exists: '${e}' is not a ${r}.`
+    } : { success: !0, value: !1, error: null };
   }
-  function v(r) {
-    const s = u(r).value;
-    return o(s) ? i(s).isDirectory() ? {
-      success: !0,
-      value: !0,
-      error: null
-    } : {
-      success: !1,
-      value: !1,
-      error: `checkIfDirExists: '${r}' is not a directory.`
-    } : {
-      success: !0,
-      value: !1,
-      error: null
-    };
+  checkIfFileExists(e) {
+    return this.checkIfPathExists(e, "file", (r) => r.isFile());
   }
-  function u(r) {
+  checkIfDirExists(e) {
+    return this.checkIfPathExists(e, "directory", (r) => r.isDirectory());
+  }
+  getAbsolutePath(e) {
     try {
-      if (r === void 0)
-        throw Error("Dir is undefined.");
-      if (r.match(/^[.a-zA-Z0-9\-_/:\\]+$/g) === null)
-        throw Error(`Dir contains unsupported characters. Received ${r}.`);
-      return {
-        success: !0,
-        value: h.normalize(h.resolve(r)),
-        error: null
-      };
-    } catch (s) {
-      return console.error(`Error resolving path: ${r}`), {
+      if (e === void 0)
+        throw new Error("Dir is undefined.");
+      if (e.match(/^[.a-zA-Z0-9\-_/:\\]+$/g) === null)
+        throw new Error(`Dir contains unsupported characters. Received ${e}.`);
+      return { success: !0, value: c.normalize(c.resolve(e)), error: null };
+    } catch (r) {
+      return console.error(`Error resolving path: ${e}`), {
         success: !1,
         value: void 0,
-        error: `Error resolving path: '${r}'. Received error: '${s}'`
+        error: `Error resolving path: '${e}'. Received error: '${r}'`
       };
     }
   }
-  function M(r) {
+  createDir(e) {
     try {
-      if (r === void 0)
-        throw Error(`Function "createDir" expected a path. Recieved "${r}".`);
-      const s = u(r).value;
-      return {
-        success: !0,
-        value: F(s),
-        error: null
-      };
+      if (e === void 0)
+        throw new Error(`Function "createDir" expected a path. Recieved "${e}".`);
+      const r = this.getAbsolutePath(e).value, s = this.mkdirpSync(r);
+      return { success: !0, value: c.normalize(s.replace(/^\\\\\?\\/, "")), error: null };
     } catch {
-      return console.error(`Error creating dir: ${r}`), {
-        success: !1,
-        value: void 0,
-        error: `Error creating dir: '${r}'`
-      };
+      return console.error(`Error creating dir: ${e}`), { success: !1, value: void 0, error: `Error creating dir: '${e}'` };
     }
   }
-  function O(r, s) {
-    const f = u(r).value;
-    return k(f), s !== void 0 && c(f, s), {
-      success: !0,
-      error: null
-    };
+  touchFile(e, r) {
+    const s = this.getAbsolutePath(e).value;
+    return this.ensureFileSync(s), r !== void 0 && this.chmodSync(s, r), { success: !0, error: null };
   }
-  function y(r) {
-    return u(r).value !== void 0 && v(r).value ? (E(r), {
-      success: !0,
-      value: r,
-      error: null
-    }) : (console.error(`Error deleting dir: ${r}`), {
-      success: !1,
-      value: void 0,
-      error: `Error deleting dir: '${r}'`
-    });
+  rimrafDir(e) {
+    return this.getAbsolutePath(e).value !== void 0 && this.checkIfDirExists(e).value ? (this.removeSync(e), { success: !0, value: e, error: null }) : (console.error(`Error deleting dir: ${e}`), { success: !1, value: void 0, error: `Error deleting dir: '${e}'` });
   }
-  function A(r) {
-    return r.map((s) => y(u(s).value));
+  rimrafDirs(e) {
+    return e.map((r) => this.rimrafDir(this.getAbsolutePath(r).value));
   }
-  function C(r) {
-    return r !== null && v(r).value ? (console.error(`Cleaning up due to abort, directories created starting at: ${JSON.stringify(r)}`), y(r), {
-      success: !0,
-      error: null
-    }) : (console.error("Cleaning up due to abort, no directory to clean up."), {
-      success: !1,
-      error: "Cleaning up due to abort, no directory to clean up."
-    });
+  abortDirCreation(e) {
+    return e !== null && this.checkIfDirExists(e).value ? (console.error(`Cleaning up due to abort, directories created starting at: ${JSON.stringify(e)}`), this.rimrafDir(e), { success: !0, error: null }) : (console.error("Cleaning up due to abort, no directory to clean up."), { success: !1, error: "Cleaning up due to abort, no directory to clean up." });
   }
-  function I(r, s) {
+  renameDir(e, r) {
     try {
-      return a(u(r).value, u(s).value), {
-        success: !0,
-        value: "Successfully renamed the directory.",
-        error: null
-      };
-    } catch (f) {
-      return console.error(f.code), {
-        success: !1,
-        value: void 0,
-        error: `renameDir from '${r}' to '${s} failed.`
-      };
+      return this.renameSync(this.getAbsolutePath(e).value, this.getAbsolutePath(r).value), { success: !0, value: "Successfully renamed the directory.", error: null };
+    } catch (s) {
+      return console.error(s.code), { success: !1, value: void 0, error: `renameDir from '${e}' to '${r} failed.` };
     }
   }
-  function T(r, s) {
+  copyDirAbs(e, r) {
     try {
-      return D(u(r).value, u(s).value, { overwrite: !1, errorOnExist: !0 }), {
-        success: !0,
-        error: null
-      };
+      return this.copySync(this.getAbsolutePath(e).value, this.getAbsolutePath(r).value, { overwrite: !1, errorOnExist: !0 }), { success: !0, error: null };
     } catch {
-      return {
-        success: !1,
-        error: `Error copying absolute from '${r}' to '${s}'`
-      };
+      return { success: !1, error: `Error copying absolute from '${e}' to '${r}'` };
     }
   }
-  return {
-    getAbsolutePath: u,
-    abortDirCreation: C,
-    checkIfDirExists: v,
-    copyDirAbs: T,
-    createDir: M,
-    renameDir: I,
-    rimrafDir: y,
-    rimrafDirs: A,
-    checkIfFileExists: x,
-    readFile: w,
-    writeFile: j,
-    touchFile: O
-  };
 }
-const X = { use: U, default: Q, mock: K };
+function I(t, e) {
+  return new M(t, e);
+}
+const O = { use: I, default: _, mock: A };
 export {
-  X as default
+  O as default
 };

package/dist/fs-helpers.umd.cjs

@@ -1 +1 @@
-(function(a,n){typeof exports=="object"&&typeof module<"u"?module.exports=n():typeof define=="function"&&define.amd?define(n):(a=typeof globalThis<"u"?globalThis:a||self,a["fs-helpers"]=n())})(this,function(){"use strict";var Q=Object.defineProperty;var U=(a,n,s)=>n in a?Q(a,n,{enumerable:!0,configurable:!0,writable:!0,value:s}):a[n]=s;var D=(a,n,s)=>(U(a,typeof n!="symbol"?n+"":n,s),s);const{default:a}=(()=>{const e=require("fs-extra");return e&&e.__esModule?e:Object.assign(Object.create(null),e,{default:e,[Symbol.toStringTag]:"Module"})})(),{default:n}=(()=>{const e=require("path");return e&&e.__esModule?e:Object.assign(Object.create(null),e,{default:e,[Symbol.toStringTag]:"Module"})})(),s=new Map;function E(e){const{root:o,dir:i}=n.parse(e),u=i.split(o).slice(1).join(o).split(n.sep);for(let f=0;f<u.length;f++){const v=[o,u.slice(0,f+1).join(n.sep)].join("");b(v)}const c=a.readFileSync(e).toString();m(e,c)}function k(e,o){const[i,u]=s.get(e)||["",""];return Buffer.from(u)}function m(e,o,i){s.set(e,["file",o])}function $(e){return e===n.resolve(".")?!0:s.has(e)}function h(e,o){const[i,u]=s.get(e)||["",""],c={isDirectory:()=>e===n.resolve(".")?!0:i==="dir",isFile:()=>s.has(e)&&i==="file",isBlockDevice:()=>!1,isCharacterDevice:()=>!1,isSymbolicLink:()=>!1,isFIFO:()=>!1,isSocket:()=>!1,dev:0,ino:0,mode:0,nlink:0,uid:0,gid:0,rdev:0,size:0,blksize:0,blocks:0,atimeMs:0,mtimeMs:0,ctimeMs:0,birthtimeMs:0,atime:new Date(0),mtime:new Date(0),ctime:new Date(0),birthtime:new Date(0)};return c.isBlockDevice(),c.isCharacterDevice(),c.isSymbolicLink(),c.isFIFO(),c.isSocket(),c}function F(e,o){}class x extends Error{constructor(i){super(i);D(this,"code");this.code="ENOENT"}}function _(e,o){if(!s.has(e))throw new x("source path not found");for(const i of Array.from(s.keys()))if(i.includes(e)){const u=i.split(e).join(o),c=s.get(i)||["",""];s.delete(i),s.set(u,c)}}function j(e,o,i){if(s.has(o))throw Error("destination directory exists");for(const u of Array.from(s.keys()))if(u.includes(e)){const c=u.split(e).join(o);s.set(c,s.get(u)||["",""])}}function b(e){if(h(e).isFile())throw Error("file exists at destination");let o;const i=e.split(n.resolve(".")).join("").split(n.sep);for(let u=0;u<i.length;u++){const c=i.slice(0,u+1).join(n.sep);!s.has(`${n.resolve(".")}${c}`)&&c!==""&&(s.set(`${n.resolve(".")}${c}`,["dir",""]),o=o??`${n.resolve(".")}${c}`)}return o}function w(e){for(const o of Array.from(s.keys()))o.includes(e)&&s.delete(o)}function M(e){s.has(e)||s.set(e,["file",""])}const O={existsSync:$,lstatSync:h,chmodSync:F,renameSync:_,readFileSync:k,copySync:j,removeSync:w,ensureFileSync:M,mkdirpSync:b,outputFileSync:m,seedFile:E},{default:T}=(()=>{const e=require("fs-extra");return e&&e.__esModule?e:Object.assign(Object.create(null),e,{default:e,[Symbol.toStringTag]:"Module"})})(),{default:S}=(()=>{const e=require("path");return e&&e.__esModule?e:Object.assign(Object.create(null),e,{default:e,[Symbol.toStringTag]:"Module"})})();function A(e,o){const{existsSync:i,lstatSync:u,chmodSync:c,renameSync:f,readFileSync:v,copySync:C,removeSync:I,ensureFileSync:N,outputFileSync:q,mkdirpSync:z,seedFile:g}=e;if(g!==void 0&&o!==void 0)for(const r of o)R(r);function R(r){const t=l(r).value;g(t)}function B(r,t){return{success:!0,value:v(l(r).value,t),error:null}}function L(r,t){return q(l(r).value,t),{success:!0,error:null}}function P(r){const t=l(r).value;return i(t)?u(t).isFile()?{success:!0,value:!0,error:null}:{success:!1,value:!1,error:`checkIfFileExists: '${r}' is not a file.`}:{success:!0,value:!1,error:null}}function y(r){const t=l(r).value;return i(t)?u(t).isDirectory()?{success:!0,value:!0,error:null}:{success:!1,value:!1,error:`checkIfDirExists: '${r}' is not a directory.`}:{success:!0,value:!1,error:null}}function l(r){try{if(r===void 0)throw Error("Dir is undefined.");if(r.match(/^[.a-zA-Z0-9\-_/:\\]+$/g)===null)throw Error(`Dir contains unsupported characters. Received ${r}.`);return{success:!0,value:S.normalize(S.resolve(r)),error:null}}catch(t){return console.error(`Error resolving path: ${r}`),{success:!1,value:void 0,error:`Error resolving path: '${r}'. Received error: '${t}'`}}}function V(r){try{if(r===void 0)throw Error(`Function "createDir" expected a path. Recieved "${r}".`);const t=l(r).value;return{success:!0,value:z(t),error:null}}catch{return console.error(`Error creating dir: ${r}`),{success:!1,value:void 0,error:`Error creating dir: '${r}'`}}}function J(r,t){const d=l(r).value;return N(d),t!==void 0&&c(d,t),{success:!0,error:null}}function p(r){return l(r).value!==void 0&&y(r).value?(I(r),{success:!0,value:r,error:null}):(console.error(`Error deleting dir: ${r}`),{success:!1,value:void 0,error:`Error deleting dir: '${r}'`})}function Z(r){return r.map(t=>p(l(t).value))}function G(r){return r!==null&&y(r).value?(console.error(`Cleaning up due to abort, directories created starting at: ${JSON.stringify(r)}`),p(r),{success:!0,error:null}):(console.error("Cleaning up due to abort, no directory to clean up."),{success:!1,error:"Cleaning up due to abort, no directory to clean up."})}function H(r,t){try{return f(l(r).value,l(t).value),{success:!0,value:"Successfully renamed the directory.",error:null}}catch(d){return console.error(d.code),{success:!1,value:void 0,error:`renameDir from '${r}' to '${t} failed.`}}}function K(r,t){try{return C(l(r).value,l(t).value,{overwrite:!1,errorOnExist:!0}),{success:!0,error:null}}catch{return{success:!1,error:`Error copying absolute from '${r}' to '${t}'`}}}return{getAbsolutePath:l,abortDirCreation:G,checkIfDirExists:y,copyDirAbs:K,createDir:V,renameDir:H,rimrafDir:p,rimrafDirs:Z,checkIfFileExists:P,readFile:B,writeFile:L,touchFile:J}}return{use:A,default:T,mock:O}});
+(function(n,c){typeof exports=="object"&&typeof module<"u"?module.exports=c():typeof define=="function"&&define.amd?define(c):(n=typeof globalThis<"u"?globalThis:n||self,n["fs-helpers"]=c())})(this,function(){"use strict";var M=Object.defineProperty;var j=(n,c,i)=>c in n?M(n,c,{enumerable:!0,configurable:!0,writable:!0,value:i}):n[c]=i;var u=(n,c,i)=>(j(n,typeof c!="symbol"?c+"":c,i),i);const n={},{default:c}=(()=>{const t=require("fs-extra");return t&&t.__esModule?t:Object.assign(Object.create(null),t,{default:t,[Symbol.toStringTag]:"Module"})})(),i=new Map;function y(t){const{root:e,dir:r}=n.parse(t),s=r.split(e).slice(1).join(e).split(n.sep);for(let l=0;l<s.length;l++){const _=[e,s.slice(0,l+1).join(n.sep)].join("");d(_)}const o=c.readFileSync(t).toString();a(t,o)}function S(t,e){const[r,s]=i.get(t)||["",""];return Buffer.from(s)}function a(t,e,r){i.set(t,["file",e])}function v(t){return t===n.resolve(".")?!0:i.has(t)}function h(t,e){const[r,s]=i.get(t)||["",""],o={isDirectory:()=>t===n.resolve(".")?!0:r==="dir",isFile:()=>i.has(t)&&r==="file",isBlockDevice:()=>!1,isCharacterDevice:()=>!1,isSymbolicLink:()=>!1,isFIFO:()=>!1,isSocket:()=>!1,dev:0,ino:0,mode:0,nlink:0,uid:0,gid:0,rdev:0,size:0,blksize:0,blocks:0,atimeMs:0,mtimeMs:0,ctimeMs:0,birthtimeMs:0,atime:new Date(0),mtime:new Date(0),ctime:new Date(0),birthtime:new Date(0)};return o.isBlockDevice(),o.isCharacterDevice(),o.isSymbolicLink(),o.isFIFO(),o.isSocket(),o}function m(t,e){}class p extends Error{constructor(r){super(r);u(this,"code");this.code="ENOENT"}}function g(t,e){const r=t,s=e;if(!i.has(r))throw new p("source path not found");f(r,s,!0)}function f(t,e,r){const s={source:t,target:e,deleteSource:r};for(const o of Array.from(i.keys()))b(o,s)}function b(t,e){if(!t.includes(e.source))return;const r=t.split(e.source).join(e.target),s=i.get(t)||["",""];e.deleteSource&&i.delete(t),i.set(r,s)}function F(t,e,r){if(i.has(e))throw new Error("destination directory exists");f(t,e,!1)}function E(t){let e;const r=n.resolve(".");for(let s=0;s<t.length;s++){const o=t.slice(0,s+1).join(n.sep),l=`${r}${o}`;e=D(l,o,e)}return e}function D(t,e,r){return i.has(t)||e===""?r:(i.set(t,["dir",""]),r??t)}function d(t){if(h(t).isFile())throw new Error("file exists at destination");const e=t.split(n.resolve(".")).join("").split(n.sep);return E(e)}function k(t){for(const e of Array.from(i.keys()))e.includes(t)&&i.delete(e)}function x(t){i.has(t)||i.set(t,["file",""])}const w={existsSync:v,lstatSync:h,chmodSync:m,renameSync:g,readFileSync:S,copySync:F,removeSync:k,ensureFileSync:x,mkdirpSync:d,outputFileSync:a,seedFile:y},{default:$}=(()=>{const t=require("fs-extra");return t&&t.__esModule?t:Object.assign(Object.create(null),t,{default:t,[Symbol.toStringTag]:"Module"})})();class P{constructor(e,r){u(this,"existsSync");u(this,"lstatSync");u(this,"chmodSync");u(this,"renameSync");u(this,"readFileSync");u(this,"copySync");u(this,"removeSync");u(this,"ensureFileSync");u(this,"outputFileSync");u(this,"mkdirpSync");u(this,"seedFile");if({existsSync:this.existsSync,lstatSync:this.lstatSync,chmodSync:this.chmodSync,renameSync:this.renameSync,readFileSync:this.readFileSync,copySync:this.copySync,removeSync:this.removeSync,ensureFileSync:this.ensureFileSync,outputFileSync:this.outputFileSync,mkdirpSync:this.mkdirpSync,seedFile:this.seedFile}=e,this.seedFile!==void 0&&r!==void 0)for(const s of r)this.mockExistingFile(s)}mockExistingFile(e){const r=this.getAbsolutePath(e).value;this.seedFile(r)}readFile(e,r){return{success:!0,value:this.readFileSync(this.getAbsolutePath(e).value,r),error:null}}writeFile(e,r){return this.outputFileSync(this.getAbsolutePath(e).value,r),{success:!0,error:null}}checkIfPathExists(e,r,s){const o=this.getAbsolutePath(e).value;return this.existsSync(o)?s(this.lstatSync(o))?{success:!0,value:!0,error:null}:{success:!1,value:!1,error:`checkIf${r==="file"?"File":"Dir"}Exists: '${e}' is not a ${r}.`}:{success:!0,value:!1,error:null}}checkIfFileExists(e){return this.checkIfPathExists(e,"file",r=>r.isFile())}checkIfDirExists(e){return this.checkIfPathExists(e,"directory",r=>r.isDirectory())}getAbsolutePath(e){try{if(e===void 0)throw new Error("Dir is undefined.");if(e.match(/^[.a-zA-Z0-9\-_/:\\]+$/g)===null)throw new Error(`Dir contains unsupported characters. Received ${e}.`);return{success:!0,value:n.normalize(n.resolve(e)),error:null}}catch(r){return console.error(`Error resolving path: ${e}`),{success:!1,value:void 0,error:`Error resolving path: '${e}'. Received error: '${r}'`}}}createDir(e){try{if(e===void 0)throw new Error(`Function "createDir" expected a path. Recieved "${e}".`);const r=this.getAbsolutePath(e).value,s=this.mkdirpSync(r);return{success:!0,value:n.normalize(s.replace(/^\\\\\?\\/,"")),error:null}}catch{return console.error(`Error creating dir: ${e}`),{success:!1,value:void 0,error:`Error creating dir: '${e}'`}}}touchFile(e,r){const s=this.getAbsolutePath(e).value;return this.ensureFileSync(s),r!==void 0&&this.chmodSync(s,r),{success:!0,error:null}}rimrafDir(e){return this.getAbsolutePath(e).value!==void 0&&this.checkIfDirExists(e).value?(this.removeSync(e),{success:!0,value:e,error:null}):(console.error(`Error deleting dir: ${e}`),{success:!1,value:void 0,error:`Error deleting dir: '${e}'`})}rimrafDirs(e){return e.map(r=>this.rimrafDir(this.getAbsolutePath(r).value))}abortDirCreation(e){return e!==null&&this.checkIfDirExists(e).value?(console.error(`Cleaning up due to abort, directories created starting at: ${JSON.stringify(e)}`),this.rimrafDir(e),{success:!0,error:null}):(console.error("Cleaning up due to abort, no directory to clean up."),{success:!1,error:"Cleaning up due to abort, no directory to clean up."})}renameDir(e,r){try{return this.renameSync(this.getAbsolutePath(e).value,this.getAbsolutePath(r).value),{success:!0,value:"Successfully renamed the directory.",error:null}}catch(s){return console.error(s.code),{success:!1,value:void 0,error:`renameDir from '${e}' to '${r} failed.`}}}copyDirAbs(e,r){try{return this.copySync(this.getAbsolutePath(e).value,this.getAbsolutePath(r).value,{overwrite:!1,errorOnExist:!0}),{success:!0,error:null}}catch{return{success:!1,error:`Error copying absolute from '${e}' to '${r}'`}}}}function A(t,e){return new P(t,e)}return{use:A,default:$,mock:w}});

package/dist/src/index.d.ts

@@ -0,0 +1,58 @@
+/// <reference types="node" />
+import fsExtra from 'fs-extra';
+import { RetBool, RetPath, RetString, RetVal, RetBuffer } from './types';
+declare class FsHelpers {
+    private readonly existsSync;
+    private readonly lstatSync;
+    private readonly chmodSync;
+    private readonly renameSync;
+    private readonly readFileSync;
+    private readonly copySync;
+    private readonly removeSync;
+    private readonly ensureFileSync;
+    private readonly outputFileSync;
+    private readonly mkdirpSync;
+    private readonly seedFile;
+    constructor(fsLibrary: any, seedFiles?: string[]);
+    private mockExistingFile;
+    readFile(fileName: string, options?: {
+        encoding: BufferEncoding;
+        flag?: string;
+    } | BufferEncoding): RetBuffer;
+    writeFile(fileName: string, data: string): RetVal;
+    private checkIfPathExists;
+    checkIfFileExists(filePath: string): RetBool;
+    checkIfDirExists(dir: string | undefined): RetBool;
+    getAbsolutePath(dir: string | undefined): RetPath;
+    createDir(dir: string | undefined): RetPath;
+    touchFile(filePath: string, perms?: number): RetVal;
+    rimrafDir(dir: string | undefined): RetPath;
+    rimrafDirs(dirs: string[]): RetPath[];
+    abortDirCreation(dir: string | null): RetVal;
+    renameDir(oldPath: string, newPath: string): RetString;
+    copyDirAbs(src: string, dest: string): RetVal;
+}
+declare function use(fsLibrary: any, seedFiles?: string[]): FsHelpers;
+declare const _default: {
+    use: typeof use;
+    default: typeof fsExtra;
+    mock: {
+        existsSync: (filePath: fsExtra.PathLike) => boolean;
+        lstatSync: (filePath: fsExtra.PathLike, _options?: (fsExtra.StatOptions & {
+            bigint?: false | undefined;
+        }) | undefined) => fsExtra.Stats;
+        chmodSync: (_filePath: fsExtra.PathLike, _mode: fsExtra.Mode) => void;
+        renameSync: (oldPath: fsExtra.PathLike, newPath: fsExtra.PathLike) => void;
+        readFileSync: (filePath: string, _options?: BufferEncoding | {
+            encoding: BufferEncoding;
+            flag?: string | undefined;
+        } | undefined) => Buffer;
+        copySync: (src: string, dest: string, _options?: fsExtra.CopyOptionsSync | undefined) => void;
+        removeSync: (filePath: string) => void;
+        ensureFileSync: (filename: string) => void;
+        mkdirpSync: (dir: string) => string | undefined;
+        outputFileSync: (filename: string, data: string, _options?: fsExtra.WriteFileOptions | undefined) => void;
+        seedFile: (fileName: string) => void;
+    };
+};
+export default _default;

package/dist/{mock.d.ts → src/mock.d.ts}

@@ -6,7 +6,7 @@ declare function readFileSync(filePath: string, _options?: {
     encoding: BufferEncoding;
     flag?: string;
 } | BufferEncoding): Buffer;
-declare function outputFileSync(filename: string, data: string, _options?: string | fs.WriteFileOptions): void;
+declare function outputFileSync(filename: string, data: string, _options?: fs.WriteFileOptions): void;
 declare function existsSync(filePath: fs.PathLike): boolean;
 declare function lstatSync(filePath: fs.PathLike, _options?: fs.StatOptions & {
     bigint?: false;
@@ -14,7 +14,7 @@ declare function lstatSync(filePath: fs.PathLike, _options?: fs.StatOptions & {
 declare function chmodSync(_filePath: fs.PathLike, _mode: fs.Mode): void;
 declare function renameSync(oldPath: fs.PathLike, newPath: fs.PathLike): void;
 declare function copySync(src: string, dest: string, _options?: fs.CopyOptionsSync): void;
-declare function mkdirpSync(dir: string): any;
+declare function mkdirpSync(dir: string): string | undefined;
 declare function removeSync(filePath: string): void;
 declare function ensureFileSync(filename: string): void;
 declare const _default: {

package/dist/{types.d.ts → src/types.d.ts}

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-type Path = string;
 type RetVal = {
     success: boolean;
     error?: string | null;
@@ -14,6 +13,6 @@ interface RetBool extends RetVal {
     value?: boolean;
 }
 interface RetPath extends RetVal {
-    value?: Path;
+    value?: string;
 }
-export type { Path, RetBool, RetString, RetVal, RetPath, RetBuffer, };
+export type { RetBool, RetString, RetVal, RetPath, RetBuffer, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jestaubach/fs-helpers",
-  "version": "0.2.24",
+  "version": "0.2.26",
   "type": "module",
   "main": "./dist/fs-helpers.umd.cjs",
   "module": "./dist/fs-helpers.js",
@@ -30,6 +30,7 @@
   ],
   "scripts": {
     "build": "tsc && vite build",
+    "lint": "eslint . --max-warnings 0",
     "test": "vitest run --coverage --reporter dot"
   },
   "dependencies": {
@@ -43,7 +44,11 @@
     "@types/fs-extra": "^11.0.2",
     "@types/lodash": "^4.14.199",
     "@types/node": "^20.7.0",
+    "@eslint/js": "^8.57.0",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
     "@vitest/coverage-istanbul": "^0.34.5",
+    "eslint": "^8.57.0",
     "typescript": "^5.2.2",
     "vite": "^4.4.9",
     "vite-plugin-dts": "^3.6.0",

package/dist/index.d.ts

@@ -1,30 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import fsExtra from 'fs-extra';
-declare function use(fsLibrary: any, seedFiles?: string[]): any;
-declare const _default: {
-    use: typeof use;
-    default: typeof fsExtra;
-    mock: {
-        existsSync: (filePath: fsExtra.PathLike) => boolean;
-        lstatSync: (filePath: fsExtra.PathLike, _options?: (fsExtra.StatOptions & {
-            bigint?: false | undefined;
-        }) | undefined) => fsExtra.Stats;
-        chmodSync: (_filePath: fsExtra.PathLike, _mode: fsExtra.Mode) => void;
-        renameSync: (oldPath: fsExtra.PathLike, newPath: fsExtra.PathLike) => void;
-        readFileSync: (filePath: string, _options?: BufferEncoding | {
-            encoding: BufferEncoding;
-            flag?: string | undefined;
-        } | undefined) => Buffer;
-        copySync: (src: string, dest: string, _options?: fsExtra.CopyOptionsSync | undefined) => void;
-        removeSync: (filePath: string) => void;
-        ensureFileSync: (filename: string) => void;
-        mkdirpSync: (dir: string) => any;
-        outputFileSync: (filename: string, data: string, _options?: string | (fsExtra.ObjectEncodingOptions & import("events").Abortable & {
-            mode?: fsExtra.Mode | undefined;
-            flag?: string | undefined;
-        }) | null | undefined) => void;
-        seedFile: (fileName: string) => void;
-    };
-};
-export default _default;