Add readFiles() utility to normalize path slashes

Author: dpilafian

cli-argv-util.ts

@@ -1,7 +1,11 @@
 // cli-argv-util ~~ MIT License
 
+// Imports
 import { execSync } from 'node:child_process';
+import fs    from 'fs';
+import slash from 'slash';
 
+// Types
 export type StringFlagMap =  { [flag: string]: string | undefined };
 export type BooleanFlagMap = { [flag: string]: boolean };
 export type Result = {
@@ -46,6 +50,11 @@ const cliArgvUtil = {
       return execSync(command.replace(name, 'node bin/cli.js'), { stdio: 'inherit' });
       },
 
+
+   readFiles(folder: string): string[] {
+      return fs.readdirSync(folder, { recursive: true }).map(file => slash(String(file))).sort();
+      },
+
    };
 
 export { cliArgvUtil };

package.json

@@ -60,25 +60,30 @@
       "clean": [
          "rimraf build dist"
       ],
-      "build": [
+      "lint": [
          "jshint . --exclude-path .gitignore",
-         "eslint --max-warnings 0 . --ext .ts",
+         "eslint --max-warnings 0 . --ext .ts"
+      ],
+      "build": [
          "tsc",
          "add-dist-header build dist"
       ]
    },
    "scripts": {
-      "pretest": "run-scripts clean build",
+      "pretest": "run-scripts clean lint build",
       "test": "mocha spec/*.spec.js"
    },
+   "dependencies": {
+      "slash": "~5.1"
+   },
    "devDependencies": {
-      "@types/node": "~20.4",
-      "@typescript-eslint/eslint-plugin": "~6.0",
-      "@typescript-eslint/parser": "~6.0",
-      "add-dist-header": "~1.1",
+      "@types/node": "~20.5",
+      "@typescript-eslint/eslint-plugin": "~6.4",
+      "@typescript-eslint/parser": "~6.4",
+      "add-dist-header": "~1.2",
       "assert-deep-strict-equal": "~1.1",
       "copy-file-util": "~1.1",
-      "eslint": "~8.44",
+      "eslint": "~8.47",
       "jshint": "~2.13",
       "mocha": "~10.2",
       "rimraf": "~5.0",

spec/mocha.spec.js

@@ -32,14 +32,14 @@ describe('Library module', () => {
       assertDeepStrictEqual(actual, expected);
       });
 
-   it('has functions named parse() and run()', () => {
+   it('has functions named parse(), run(), and readFiles()', () => {
       const actual =   {
          names: Object.keys(cliArgvUtil),
          types: Object.values(cliArgvUtil).map(fn => typeof fn),
          };
       const expected = {
-         names: ['parse',    'run'],
-         types: ['function', 'function'],
+         names: ['parse',    'run',      'readFiles'],
+         types: ['function', 'function', 'function'],
          };
       assertDeepStrictEqual(actual, expected);
       });