@wtasnorg/node-lib 0.0.5 → 0.0.7

package/src/find.ts

@@ -0,0 +1,99 @@
+import { resolve, join } from "node:path";
+
+interface FileSystemDependencies {
+    readdir: (path: string, opts: { withFileTypes: true }) => Promise<{ name: string; isDirectory(): boolean; }[]>;
+    stat: (path: string) => Promise<{ isDirectory(): boolean }>;
+}
+
+interface FindDirectoriesOptions {
+    maxDepth?: number;
+    followSymlinks?: boolean;
+    allowlist?: string[] | ((absPath: string, name: string) => boolean);
+    blocklist?: string[] | ((absPath: string, name: string) => boolean);
+}
+
+/**
+ * Factory that produces an async findDirectories function with
+ * injected filesystem dependencies for full testability.
+ */
+function createFindDirectories(deps: FileSystemDependencies) {
+
+    const { readdir } = deps;
+
+    return async function findDirectories(
+        root: string,
+        options: FindDirectoriesOptions = {}
+    ): Promise<string[]> {
+
+        const {
+            maxDepth = 1,
+            allowlist,
+            blocklist
+        } = options;
+
+        const absRoot = resolve(root);
+        const results: string[] = [];
+
+
+        function isAllowed(absPath: string, name: string): boolean {
+            if (allowlist) {
+                if (Array.isArray(allowlist)) {
+                    if (!allowlist.includes(name)) return false;
+                } else if (!allowlist(absPath, name)) {
+                    return false;
+                }
+            }
+            return true;
+        }
+
+        function isBlocked(absPath: string, name: string): boolean {
+            if (blocklist) {
+                if (Array.isArray(blocklist)) {
+                    if (blocklist.includes(name)) return true;
+                } else if (blocklist(absPath, name)) {
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        async function walk(currentPath: string, depth: number): Promise<void> {
+            if (depth > maxDepth) return;
+
+            const entries = await readdir(currentPath, { withFileTypes: true });
+
+            for (const entry of entries) {
+                const childPath = resolve(join(currentPath, entry.name));
+
+                const isDirectory = entry.isDirectory();
+
+                if (!isDirectory) continue;
+
+                if (isBlocked(childPath, entry.name)) continue;
+                if (!isAllowed(childPath, entry.name)) continue;
+
+                results.push(childPath);
+
+                if (depth < maxDepth) {
+                    await walk(childPath, depth + 1);
+                }
+            }
+        }
+
+        // match find(1): root is always included
+        results.push(absRoot);
+
+        await walk(absRoot, 1);
+
+        return results;
+    };
+}
+
+export {
+    createFindDirectories,
+};
+
+export type {
+    FileSystemDependencies,
+    FindDirectoriesOptions,
+};

package/src/index.d.ts

@@ -1,4 +1,7 @@
 import { hello } from "./hello.js";
 import { pojo } from "./pojo.js";
-export { hello, pojo };
+import type { FindDirectoriesOptions, FileSystemDependencies } from "./find.js";
+import { createFindDirectories } from "./find.js";
+export { hello, pojo, createFindDirectories };
+export type { FindDirectoriesOptions, FileSystemDependencies, };
 //# sourceMappingURL=index.d.ts.map

package/src/index.js

@@ -1,4 +1,5 @@
 import { hello } from "./hello.js";
 import { pojo } from "./pojo.js";
-export { hello, pojo };
+import { createFindDirectories } from "./find.js";
+export { hello, pojo, createFindDirectories };
 //# sourceMappingURL=index.js.map

package/src/index.ts

@@ -1,7 +1,15 @@
 import { hello } from "./hello.js";
 import { pojo } from "./pojo.js";
+import type { FindDirectoriesOptions, FileSystemDependencies } from "./find.js";
+import { createFindDirectories } from "./find.js";
 
 export {
     hello,
-    pojo
+    pojo,
+    createFindDirectories
+};
+
+export type {
+    FindDirectoriesOptions,
+    FileSystemDependencies,
 };

package/src/pojo.d.ts

@@ -5,8 +5,8 @@
  *
  * @template T
  * @param {T} instance - A class instance to convert.
- * @returns {Object<string, any>} A plain JavaScript object containing only data fields.
+ * @returns {Object<string, unknown>} A plain JavaScript object containing only data fields.
  */
-declare function pojo<T extends object>(instance: T): Record<string, any>;
+declare function pojo<T extends object>(instance: T): Record<string, unknown>;
 export { pojo };
 //# sourceMappingURL=pojo.d.ts.map

package/src/pojo.js

@@ -5,7 +5,7 @@
  *
  * @template T
  * @param {T} instance - A class instance to convert.
- * @returns {Object<string, any>} A plain JavaScript object containing only data fields.
+ * @returns {Object<string, unknown>} A plain JavaScript object containing only data fields.
  */
 function pojo(instance) {
     return Object.fromEntries(Object.entries(instance).filter(([_, value]) => typeof value !== "function"));

package/src/pojo.ts

@@ -5,9 +5,9 @@
  *
  * @template T
  * @param {T} instance - A class instance to convert.
- * @returns {Object<string, any>} A plain JavaScript object containing only data fields.
+ * @returns {Object<string, unknown>} A plain JavaScript object containing only data fields.
  */
-function pojo<T extends object>(instance: T): Record<string, any> {
+function pojo<T extends object>(instance: T): Record<string, unknown> {
     return Object.fromEntries(
         Object.entries(instance).filter(([_, value]) => typeof value !== "function")
     );

package/test_report

@@ -0,0 +1,26 @@
+
+> @wtasnorg/node-lib@0.0.7 test
+> bash -c 'node --test src/**/*.test.js'
+
+✔ find: findDirectories success (1.077042ms)
+✔ find: findDirectories symlink is NOT treated as a directory (0.181028ms)
+✔ find: findDirectories at depth=2 (0.264408ms)
+✔ find: findDirectories at depth=3 (0.225558ms)
+hello from @wtasnorg/node-lib
+hello from @wtasnorg/node-lib
+▶ hello
+  ✔ returns a string that has the word 'hello' in it (0.855703ms)
+  ✔ returns exact string (0.132439ms)
+✔ hello (1.649597ms)
+✔ pojo() should return only enumerable data fields (0.948072ms)
+✔ pojo() should exclude methods (0.137609ms)
+✔ pojo() should exclude prototype properties (0.141089ms)
+✔ pojo() should ignore non-enumerable own properties (0.671565ms)
+ℹ tests 10
+ℹ suites 1
+ℹ pass 10
+ℹ fail 0
+ℹ cancelled 0
+ℹ skipped 0
+ℹ todo 0
+ℹ duration_ms 50.692585

package/typedoc.json

@@ -1,11 +1,15 @@
 {
   "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts"],
+  "entryPoints": [
+    "./src/index.ts"
+  ],
   "excludePrivate": true,
   "excludeProtected": true,
   "name": "@wtasnorg/node-lib",
   "out": "docs",
-  "plugin": ["typedoc-plugin-markdown"],
+  "plugin": [
+    "typedoc-plugin-markdown"
+  ],
   "theme": "default",
   "tsconfig": "./tsconfig.json",
 }