@jeniex/utils 1.0.12 → 1.0.14

package/node/index.cjs

@@ -42,24 +42,67 @@ async function sleep(milliSeconds) {
     });
 }
 
+/**
+ * Get a list of files that are present in the provided folder path.
+ * If the provided folder path does not exists, it will return an empty array.
+ */
+async function listFiles({ folderPath, getFullPath, filter }) {
+    if (fs.existsSync(folderPath) === false) {
+        return [];
+    }
+    const entries = await fsp.readdir(folderPath, {
+        withFileTypes: true,
+    });
+    const files = entries
+        .filter((entry) => entry.isDirectory() === false)
+        .map((fileEntry) => {
+        if (getFullPath === true) {
+            return path.join(folderPath, fileEntry.name);
+        }
+        return fileEntry.name;
+    });
+    if (filter === undefined) {
+        return files;
+    }
+    return files.filter((fileName) => {
+        const fileExtension = path.extname(fileName);
+        return filter.includes(fileExtension);
+    });
+}
+
+/**
+ * Get a list of folders that are present in the provided folder path.
+ * If the provided folder path does not exists, an error will be thrown.
+ */
 async function listFolders({ folderPath, getFullPath }) {
     if (fs.existsSync(folderPath) === false) {
         throw new Error('The provided folder path does not exist!');
     }
-    const items = await fsp.readdir(folderPath, {
+    const entries = await fsp.readdir(folderPath, {
         withFileTypes: true,
     });
-    const folders = items
-        .filter((item) => item.isDirectory() === true)
-        .map((folderItem) => {
-        if (getFullPath === undefined) {
-            return folderItem.name;
+    const folders = entries
+        .filter((entry) => entry.isDirectory() === true)
+        .map((folderEntry) => {
+        if (getFullPath === true) {
+            return path.join(folderPath, folderEntry.name);
         }
-        return path.join(folderPath, folderItem.name);
+        return folderEntry.name;
     });
     return folders;
 }
 
+async function removeFiles({ folderPath, filter }) {
+    const nestedFilePathPattern = `${path.resolve('./')}\\`;
+    if (!folderPath.startsWith(nestedFilePathPattern)) {
+        throw new Error('Files are outside or at the root of the project folder.');
+    }
+    const filesPaths = await listFiles({ folderPath, getFullPath: true, filter });
+    for (const filePath of filesPaths) {
+        await fsp.unlink(filePath);
+    }
+}
+
 exports.asserted = asserted;
 exports.ensureJoin = ensureJoin;
 exports.isFalsy = isFalsy;
@@ -67,6 +110,8 @@ exports.isNotNullish = isNotNullish;
 exports.isNullish = isNullish;
 exports.isString = isString;
 exports.isTruthy = isTruthy;
+exports.listFiles = listFiles;
 exports.listFolders = listFolders;
 exports.noop = noop;
+exports.removeFiles = removeFiles;
 exports.sleep = sleep;

package/node/index.d.ts

@@ -15,10 +15,37 @@ declare function sleep(milliSeconds: number): Promise<void>;
 type Nullable<T> = T | null | undefined;
 type Fn<T = void, U = any> = (param?: U) => T;
 
-interface ListFoldersOpt {
+interface ListBaseOpt {
+    /** The absolute path of the target folder. */
     folderPath: string;
     getFullPath?: boolean;
 }
+interface ListFoldersOpt extends ListBaseOpt {
+}
+interface ListFilesOpt extends ListBaseOpt {
+    /**
+     * If provided, only files with these extensions will be processed.
+     *
+     * @example
+     * ['.css', '.html'];
+     */
+    filter?: string[];
+}
+interface RemoveFilesOpt extends Omit<ListFilesOpt, 'getFullPath'> {
+}
+
+/**
+ * Get a list of files that are present in the provided folder path.
+ * If the provided folder path does not exists, it will return an empty array.
+ */
+declare function listFiles({ folderPath, getFullPath, filter }: ListFilesOpt): Promise<string[]>;
+
+/**
+ * Get a list of folders that are present in the provided folder path.
+ * If the provided folder path does not exists, an error will be thrown.
+ */
 declare function listFolders({ folderPath, getFullPath }: ListFoldersOpt): Promise<string[]>;
 
-export { Fn, Nullable, asserted, ensureJoin, isFalsy, isNotNullish, isNullish, isString, isTruthy, listFolders, noop, sleep };
+declare function removeFiles({ folderPath, filter }: RemoveFilesOpt): Promise<void>;
+
+export { Fn, Nullable, asserted, ensureJoin, isFalsy, isNotNullish, isNullish, isString, isTruthy, listFiles, listFolders, noop, removeFiles, sleep };

package/node/index.js

@@ -40,22 +40,65 @@ async function sleep(milliSeconds) {
     });
 }
 
+/**
+ * Get a list of files that are present in the provided folder path.
+ * If the provided folder path does not exists, it will return an empty array.
+ */
+async function listFiles({ folderPath, getFullPath, filter }) {
+    if (fs.existsSync(folderPath) === false) {
+        return [];
+    }
+    const entries = await fsp.readdir(folderPath, {
+        withFileTypes: true,
+    });
+    const files = entries
+        .filter((entry) => entry.isDirectory() === false)
+        .map((fileEntry) => {
+        if (getFullPath === true) {
+            return path.join(folderPath, fileEntry.name);
+        }
+        return fileEntry.name;
+    });
+    if (filter === undefined) {
+        return files;
+    }
+    return files.filter((fileName) => {
+        const fileExtension = path.extname(fileName);
+        return filter.includes(fileExtension);
+    });
+}
+
+/**
+ * Get a list of folders that are present in the provided folder path.
+ * If the provided folder path does not exists, an error will be thrown.
+ */
 async function listFolders({ folderPath, getFullPath }) {
     if (fs.existsSync(folderPath) === false) {
         throw new Error('The provided folder path does not exist!');
     }
-    const items = await fsp.readdir(folderPath, {
+    const entries = await fsp.readdir(folderPath, {
         withFileTypes: true,
     });
-    const folders = items
-        .filter((item) => item.isDirectory() === true)
-        .map((folderItem) => {
-        if (getFullPath === undefined) {
-            return folderItem.name;
+    const folders = entries
+        .filter((entry) => entry.isDirectory() === true)
+        .map((folderEntry) => {
+        if (getFullPath === true) {
+            return path.join(folderPath, folderEntry.name);
         }
-        return path.join(folderPath, folderItem.name);
+        return folderEntry.name;
     });
     return folders;
 }
 
-export { asserted, ensureJoin, isFalsy, isNotNullish, isNullish, isString, isTruthy, listFolders, noop, sleep };
+async function removeFiles({ folderPath, filter }) {
+    const nestedFilePathPattern = `${path.resolve('./')}\\`;
+    if (!folderPath.startsWith(nestedFilePathPattern)) {
+        throw new Error('Files are outside or at the root of the project folder.');
+    }
+    const filesPaths = await listFiles({ folderPath, getFullPath: true, filter });
+    for (const filePath of filesPaths) {
+        await fsp.unlink(filePath);
+    }
+}
+
+export { asserted, ensureJoin, isFalsy, isNotNullish, isNullish, isString, isTruthy, listFiles, listFolders, noop, removeFiles, sleep };

package/node/inquirer/index.d.ts

@@ -0,0 +1,31 @@
+type ListChoice = number | string;
+type CheckboxValue = boolean | number | string;
+interface CheckboxChoice {
+    name: number | string;
+    value?: CheckboxValue;
+    checked?: boolean;
+    disabled?: boolean | string;
+}
+
+/**
+ * Shows the user a list of options to multi-select from.
+ */
+declare function checkbox(message: string, choices: CheckboxChoice[]): Promise<CheckboxValue[]>;
+
+/**
+ * Gets the user confirmation.
+ * @param defaultAnswer Defaults to false which is no.
+ */
+declare function confirm(message: string, defaultAnswer?: boolean): Promise<boolean>;
+
+/**
+ * Gets the user input if provided, otherwise throws an error.
+ */
+declare function input(message: string): Promise<string>;
+
+/**
+ * Shows the user a list of options to select from.
+ */
+declare function list(message: string, choices: (ListChoice)[]): Promise<ListChoice>;
+
+export { CheckboxChoice, checkbox, confirm, input, list };

package/node/inquirer/index.js

@@ -0,0 +1,86 @@
+import inquirer from 'inquirer';
+
+/**
+ * Shows the user a list of options to multi-select from.
+ */
+async function checkbox(message, choices) {
+    const { selectedChoices } = await inquirer.prompt([
+        {
+            type: 'checkbox',
+            message,
+            name: 'selectedChoices',
+            loop: false,
+            choices,
+            async validate(answer) {
+                if (answer.length === 0) {
+                    return 'You must choose at least one choice!';
+                }
+                return true;
+            },
+        },
+    ]);
+    return selectedChoices;
+}
+
+/**
+ * Gets the user confirmation.
+ * @param defaultAnswer Defaults to false which is no.
+ */
+async function confirm(message, defaultAnswer = false) {
+    const { confirmValue } = await inquirer.prompt([
+        {
+            type: 'confirm',
+            name: 'confirmValue',
+            message,
+            default: defaultAnswer,
+        },
+    ]);
+    // Extra checking as if the values are of type `any`.
+    if (typeof confirmValue !== 'boolean') {
+        throw new TypeError('Something went wrong!');
+    }
+    return confirmValue;
+}
+
+function isFalsy(object) {
+    return Boolean(object) === false;
+}
+
+/**
+ * Gets the user input if provided, otherwise throws an error.
+ */
+async function input(message) {
+    const { inputValue } = await inquirer.prompt([
+        {
+            type: 'input',
+            name: 'inputValue',
+            message,
+        },
+    ]);
+    // Extra checking as if the values are of type `any`.
+    if (isFalsy(inputValue) || typeof inputValue !== 'string') {
+        throw new Error('No input was provided!');
+    }
+    return inputValue;
+}
+
+/**
+ * Shows the user a list of options to select from.
+ */
+async function list(message, choices) {
+    const { selectedChoice } = await inquirer.prompt([
+        {
+            type: 'list',
+            name: 'selectedChoice',
+            message,
+            choices,
+            loop: false,
+        },
+    ]);
+    if (typeof selectedChoice !== 'string' && typeof selectedChoice !== 'number') {
+        throw new TypeError('Something went wrong!');
+    }
+    return selectedChoice;
+}
+
+export { checkbox, confirm, input, list };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jeniex/utils",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "author": "JenieX",
   "homepage": "https://github.com/JenieX/utils",
   "type": "module",
@@ -17,6 +17,10 @@
       "types": "./node/index.d.ts",
       "import": "./node/index.js",
       "require": "./node/index.cjs"
+    },
+    "./node/inquirer": {
+      "types": "./node/inquirer/index.d.ts",
+      "import": "./node/inquirer/index.js"
     }
   },
   "files": [
@@ -32,11 +36,14 @@
     "@commitlint/config-conventional": "^17.7.0",
     "@jeniex/eslint-config": "^0.0.3",
     "@rollup/plugin-typescript": "^11.1.3",
+    "@types/inquirer": "^9.0.3",
     "@types/node": "^20.5.7",
     "@violentmonkey/types": "^0.1.5",
+    "inquirer": "^9.2.11",
     "rollup": "^3.28.0",
     "rollup-plugin-dts": "^5.3.1",
-    "tslib": "^2.6.2"
+    "tslib": "^2.6.2",
+    "tsx": "^3.12.8"
   },
   "publishConfig": {
     "access": "public"