@stryke/fs 0.4.0 → 0.5.1

package/dist/files/helpers.cjs

@@ -7,10 +7,12 @@ exports.createDirectory = createDirectory;
 exports.createDirectorySync = createDirectorySync;
 exports.extractFileFromTar = extractFileFromTar;
 exports.extractFileFromTarGzip = extractFileFromTarGzip;
-var _exists = require("@stryke/path/utilities/exists");
-var _nanotar = require("nanotar");
+exports.removeDirectory = removeDirectory;
+exports.removeDirectorySync = removeDirectorySync;
 var _nodeFs = require("node:fs");
 var _promises = require("node:fs/promises");
+var _exists = require("@stryke/path/utilities/exists");
+var _nanotar = require("nanotar");
 function createDirectorySync(r) {
   if (!(0, _exists.existsSync)(r)) return (0, _nodeFs.mkdirSync)(r, {
     recursive: !0
@@ -21,17 +23,27 @@ async function createDirectory(r) {
     recursive: !0
   });
 }
-async function extractFileFromTar(r, a, t) {
-  const e = (0, _nanotar.parseTar)(await (0, _promises.readFile)(r)).find(i => i.name === a);
+function removeDirectorySync(r) {
+  if ((0, _exists.existsSync)(r)) return (0, _nodeFs.rmdirSync)(r, {
+    recursive: !0
+  });
+}
+async function removeDirectory(r) {
+  if ((0, _exists.existsSync)(r)) return (0, _promises.rmdir)(r, {
+    recursive: !0
+  });
+}
+async function extractFileFromTar(r, i, t) {
+  const e = (0, _nanotar.parseTar)(await (0, _promises.readFile)(r)).find(n => n.name === i);
   if (!e?.data) return;
   (await (0, _exists.exists)(t)) || (await (0, _promises.mkdir)(t, {
     recursive: !0
-  })), await (0, _nodeFs.createWriteStream)(t).write(e.data);
+  })), (0, _nodeFs.createWriteStream)(t).write(e.data);
 }
-async function extractFileFromTarGzip(r, a, t) {
-  const e = (await (0, _nanotar.parseTarGzip)(await (0, _promises.readFile)(r))).find(i => i.name === a);
+async function extractFileFromTarGzip(r, i, t) {
+  const e = (await (0, _nanotar.parseTarGzip)(await (0, _promises.readFile)(r))).find(n => n.name === i);
   if (!e?.data) return;
   (await (0, _exists.exists)(t)) || (await (0, _promises.mkdir)(t, {
     recursive: !0
-  })), await (0, _nodeFs.createWriteStream)(t).write(e.data);
+  })), (0, _nodeFs.createWriteStream)(t).write(e.data);
 }

package/dist/files/helpers.d.ts

@@ -1,17 +1,31 @@
 /**
  * Create a directory if it does not exist.
  *
- * @param filePath - The directory path to check
+ * @param path - The directory path to check
  * @returns An indicator specifying if the directory exists
  */
 export declare function createDirectorySync(path: string): string | undefined;
 /**
  * Create a directory if it does not exist.
  *
- * @param filePath - The directory path to check
+ * @param path - The directory path to check
  * @returns An indicator specifying if the directory exists
  */
 export declare function createDirectory(path: string): Promise<string | undefined>;
+/**
+ * Remove a directory if it exists.
+ *
+ * @param path - The directory path to check
+ * @returns An indicator specifying if the directory exists
+ */
+export declare function removeDirectorySync(path: string): void;
+/**
+ * Remove a directory if it exists.
+ *
+ * @param path - The directory path to check
+ * @returns An indicator specifying if the directory exists
+ */
+export declare function removeDirectory(path: string): Promise<void>;
 /**
  * Extracts a file from a given tarball to the specified destination.
  *

package/dist/files/helpers.mjs

@@ -1 +1 @@
-import{exists as n,existsSync as f}from"@stryke/path/utilities/exists";import{parseTar as w,parseTarGzip as p}from"nanotar";import{createWriteStream as c,mkdirSync as y}from"node:fs";import{mkdir as s,readFile as o}from"node:fs/promises";export function createDirectorySync(r){if(!f(r))return y(r,{recursive:!0})}export async function createDirectory(r){if(!await n(r))return s(r,{recursive:!0})}export async function extractFileFromTar(r,a,t){const e=w(await o(r)).find(i=>i.name===a);if(!e?.data)return;await n(t)||await s(t,{recursive:!0}),await c(t).write(e.data)}export async function extractFileFromTarGzip(r,a,t){const e=(await p(await o(r))).find(i=>i.name===a);if(!e?.data)return;await n(t)||await s(t,{recursive:!0}),await c(t).write(e.data)}
+import{createWriteStream as u,mkdirSync as y,rmdirSync as g}from"node:fs";import{mkdir as c,readFile as o,rmdir as p}from"node:fs/promises";import{exists as s,existsSync as a}from"@stryke/path/utilities/exists";import{parseTar as w,parseTarGzip as x}from"nanotar";export function createDirectorySync(r){if(!a(r))return y(r,{recursive:!0})}export async function createDirectory(r){if(!await s(r))return c(r,{recursive:!0})}export function removeDirectorySync(r){if(a(r))return g(r,{recursive:!0})}export async function removeDirectory(r){if(a(r))return p(r,{recursive:!0})}export async function extractFileFromTar(r,i,t){const e=w(await o(r)).find(n=>n.name===i);if(!e?.data)return;await s(t)||await c(t,{recursive:!0}),u(t).write(e.data)}export async function extractFileFromTarGzip(r,i,t){const e=(await x(await o(r))).find(n=>n.name===i);if(!e?.data)return;await s(t)||await c(t,{recursive:!0}),u(t).write(e.data)}

package/dist/files/index.cjs

@@ -47,6 +47,17 @@ Object.keys(_helpers).forEach(function (key) {
     }
   });
 });
+var _listFiles = require("./list-files.cjs");
+Object.keys(_listFiles).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _listFiles[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _listFiles[key];
+    }
+  });
+});
 var _readFile = require("./read-file.cjs");
 Object.keys(_readFile).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/dist/files/index.d.ts

@@ -2,6 +2,7 @@ export * from "./chmod-x";
 export * from "./constants";
 export * from "./copy-files";
 export * from "./helpers";
+export * from "./list-files";
 export * from "./read-file";
 export * from "./remove-file";
 export * from "./write-file";

package/dist/files/index.mjs

@@ -1 +1 @@
-export*from"./chmod-x";export*from"./constants";export*from"./copy-files";export*from"./helpers";export*from"./read-file";export*from"./remove-file";export*from"./write-file";
+export*from"./chmod-x";export*from"./constants";export*from"./copy-files";export*from"./helpers";export*from"./list-files";export*from"./read-file";export*from"./remove-file";export*from"./write-file";

package/dist/files/list-files.cjs

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.listFiles = listFiles;
+var _promises = require("node:fs/promises");
+var _isFile = require("@stryke/path/utilities/is-file");
+var _joinPaths = require("@stryke/path/utilities/join-paths");
+async function listFiles(a) {
+  const s = [],
+    t = async r => {
+      const n = await (0, _promises.readdir)(r);
+      await Promise.all(n.map(async o => {
+        const i = (0, _joinPaths.joinPaths)(r, o);
+        (0, _isFile.isDirectory)(i) ? await t(i) : s.push(i);
+      }));
+    };
+  return await t(a), s;
+}

package/dist/files/list-files.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The file listing library used by Storm Software for building TypeScript applications.
+ *
+ * @param directoryPath - The directory path to list files from
+ * @returns A list of file paths
+ */
+export declare function listFiles(directoryPath: string): Promise<string[]>;

package/dist/files/list-files.mjs

@@ -0,0 +1 @@
+import{readdir as e}from"node:fs/promises";import{isDirectory as m}from"@stryke/path/utilities/is-file";import{joinPaths as c}from"@stryke/path/utilities/join-paths";export async function listFiles(a){const s=[],t=async r=>{const n=await e(r);await Promise.all(n.map(async o=>{const i=c(r,o);m(i)?await t(i):s.push(i)}))};return await t(a),s}

package/dist/files/remove-file.cjs

@@ -10,7 +10,7 @@ const removeFileSync = r => {
     if (!r || !(0, _nodeFs.existsSync)(r)) throw new Error("Invalid file path provided to remove data");
     (0, _nodeFs.rmSync)(r);
   },
-  removeFile = r => {
+  removeFile = async r => {
     if (!r || !(0, _nodeFs.existsSync)(r)) throw new Error("Invalid file path provided to remove data");
     return (0, _promises.rm)(r);
   };

package/dist/files/remove-file.mjs

@@ -1 +1 @@
-import{existsSync as o,rmSync as e}from"node:fs";import{rm as i}from"node:fs/promises";export const removeFileSync=r=>{if(!r||!o(r))throw new Error("Invalid file path provided to remove data");e(r)},removeFile=r=>{if(!r||!o(r))throw new Error("Invalid file path provided to remove data");return i(r)};
+import{existsSync as o,rmSync as e}from"node:fs";import{rm as i}from"node:fs/promises";export const removeFileSync=r=>{if(!r||!o(r))throw new Error("Invalid file path provided to remove data");e(r)},removeFile=async r=>{if(!r||!o(r))throw new Error("Invalid file path provided to remove data");return i(r)};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/fs",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "type": "module",
   "description": "A package containing various file system utilities that expand the functionality of NodeJs's `fs` module.",
   "repository": {
@@ -17,9 +17,9 @@
     "chalk": "^5.4.1",
     "nanotar": "^0.2.0",
     "semver": "7.7.1",
-    "@stryke/json": ">=0.4.0",
-    "@stryke/path": ">=0.2.0",
-    "@stryke/types": ">=0.5.0"
+    "@stryke/json": ">=0.4.2",
+    "@stryke/path": ">=0.3.1",
+    "@stryke/types": ">=0.5.1"
   },
   "devDependencies": {
     "@types/node": "^22.13.1",
@@ -191,6 +191,20 @@
         "default": "./dist/files/read-file.mjs"
       }
     },
+    "./files/list-files": {
+      "import": {
+        "types": "./dist/files/list-files.d.ts",
+        "default": "./dist/files/list-files.mjs"
+      },
+      "require": {
+        "types": "./dist/files/list-files.d.ts",
+        "default": "./dist/files/list-files.cjs"
+      },
+      "default": {
+        "types": "./dist/files/list-files.d.ts",
+        "default": "./dist/files/list-files.mjs"
+      }
+    },
     "./files/index": {
       "import": {
         "types": "./dist/files/index.d.ts",