@wtasnorg/node-lib 0.0.6 → 0.0.7

package/docs/functions/createFindDirectories.md

@@ -8,7 +8,7 @@
 
 > **createFindDirectories**(`deps`): (`root`, `options`) => `Promise`\<`string`[]\>
 
-Defined in: [find.ts:19](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc3451098355b40ab686f5320efe/src/find.ts#L19)
+Defined in: [find.ts:19](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L19)
 
 Factory that produces an async findDirectories function with
 injected filesystem dependencies for full testability.

package/docs/functions/hello.md

@@ -8,7 +8,7 @@
 
 > **hello**(): `Promise`\<`string`\>
 
-Defined in: [hello.ts:6](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc3451098355b40ab686f5320efe/src/hello.ts#L6)
+Defined in: [hello.ts:6](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/hello.ts#L6)
 
 A sample function that should work to test if lib is installed correctly.
 

package/docs/functions/pojo.md

@@ -6,9 +6,9 @@
 
 # Function: pojo()
 
-> **pojo**\<`T`\>(`instance`): `Record`\<`string`, `any`\>
+> **pojo**\<`T`\>(`instance`): `Record`\<`string`, `unknown`\>
 
-Defined in: [pojo.ts:10](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc3451098355b40ab686f5320efe/src/pojo.ts#L10)
+Defined in: [pojo.ts:10](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/pojo.ts#L10)
 
 Convert a class instance into a plain JavaScript object.
 Copies only the instance's own enumerable data properties
@@ -30,6 +30,6 @@ A class instance to convert.
 
 ## Returns
 
-`Record`\<`string`, `any`\>
+`Record`\<`string`, `unknown`\>
 
 A plain JavaScript object containing only data fields.

package/docs/interfaces/FileSystemDependencies.md

@@ -6,7 +6,7 @@
 
 # Interface: FileSystemDependencies
 
-Defined in: [find.ts:3](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc3451098355b40ab686f5320efe/src/find.ts#L3)
+Defined in: [find.ts:3](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L3)
 
 ## Properties
 
@@ -14,7 +14,7 @@ Defined in: [find.ts:3](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc345
 
 > **readdir**: (`path`, `opts`) => `Promise`\<`object`[]\>
 
-Defined in: [find.ts:4](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc3451098355b40ab686f5320efe/src/find.ts#L4)
+Defined in: [find.ts:4](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L4)
 
 #### Parameters
 
@@ -38,7 +38,7 @@ Defined in: [find.ts:4](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc345
 
 > **stat**: (`path`) => `Promise`\<\{ `isDirectory`: `boolean`; \}\>
 
-Defined in: [find.ts:5](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc3451098355b40ab686f5320efe/src/find.ts#L5)
+Defined in: [find.ts:5](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L5)
 
 #### Parameters
 

package/docs/interfaces/FindDirectoriesOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: FindDirectoriesOptions
 
-Defined in: [find.ts:8](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc3451098355b40ab686f5320efe/src/find.ts#L8)
+Defined in: [find.ts:8](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L8)
 
 ## Properties
 
@@ -14,7 +14,7 @@ Defined in: [find.ts:8](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc345
 
 > `optional` **allowlist**: `string`[] \| (`absPath`, `name`) => `boolean`
 
-Defined in: [find.ts:11](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc3451098355b40ab686f5320efe/src/find.ts#L11)
+Defined in: [find.ts:11](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L11)
 
 ***
 
@@ -22,7 +22,7 @@ Defined in: [find.ts:11](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc34
 
 > `optional` **blocklist**: `string`[] \| (`absPath`, `name`) => `boolean`
 
-Defined in: [find.ts:12](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc3451098355b40ab686f5320efe/src/find.ts#L12)
+Defined in: [find.ts:12](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L12)
 
 ***
 
@@ -30,7 +30,7 @@ Defined in: [find.ts:12](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc34
 
 > `optional` **followSymlinks**: `boolean`
 
-Defined in: [find.ts:10](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc3451098355b40ab686f5320efe/src/find.ts#L10)
+Defined in: [find.ts:10](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L10)
 
 ***
 
@@ -38,4 +38,4 @@ Defined in: [find.ts:10](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc34
 
 > `optional` **maxDepth**: `number`
 
-Defined in: [find.ts:9](https://github.com/wtasg/node-lib/blob/01d2e57d5a7dbc3451098355b40ab686f5320efe/src/find.ts#L9)
+Defined in: [find.ts:9](https://github.com/wtasg/node-lib/blob/5ccb6028429af225c9ab29e1b6007075025c601f/src/find.ts#L9)

package/eslint.config.js

@@ -0,0 +1,47 @@
+// @ts-check
+
+import eslint from "@eslint/js";
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
+import prettier from "eslint-config-prettier";
+import globals from "globals";
+import stylistic from "@stylistic/eslint-plugin";
+
+export default defineConfig([
+    eslint.configs.recommended,
+    ...tseslint.configs.recommended,
+    ...tseslint.configs.strict,
+    ...tseslint.configs.stylistic,
+    prettier,
+
+    {
+        languageOptions: {
+            globals: {
+                ...globals.node,
+            }
+        }
+    },
+
+    {
+        plugins: {
+            "@stylistic": stylistic
+        }
+    },
+
+    {
+        rules: {
+            "@typescript-eslint/no-unused-vars": [
+                "warn",
+                {
+                    argsIgnorePattern: "^_",
+                    varsIgnorePattern: "^_",
+                    caughtErrorsIgnorePattern: "^_"
+                }
+            ],
+
+            semi: ["error", "always"],
+            // "no-unused-vars": ["error", { varsIgnorePattern: "^[A-Z_]" }],
+            "@stylistic/quotes": ["error", "double"]
+        }
+    }
+]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wtasnorg/node-lib",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "node library",
   "main": "src/index.js",
   "scripts": {
@@ -27,9 +27,15 @@
     "url": "git+https://github.com/wtasg/node-lib.git"
   },
   "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@stylistic/eslint-plugin": "^5.6.1",
     "@types/node": "^24.10.1",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^16.5.0",
     "typedoc": "^0.28.15",
     "typedoc-plugin-markdown": "^4.9.0",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.48.1"
   }
 }

package/src/find.js

@@ -39,7 +39,7 @@ function createFindDirectories(deps) {
             const entries = await readdir(currentPath, { withFileTypes: true });
             for (const entry of entries) {
                 const childPath = resolve(join(currentPath, entry.name));
-                let isDirectory = entry.isDirectory();
+                const isDirectory = entry.isDirectory();
                 if (!isDirectory)
                     continue;
                 if (isBlocked(childPath, entry.name))

package/src/find.test.js

@@ -58,10 +58,8 @@ test("find: findDirectories symlink is NOT treated as a directory", async () =>
     ]);
 });
 test("find: findDirectories at depth=2", async () => {
-    const calls = [];
     const deps = {
         readdir: async (path) => {
-            calls.push(path);
             switch (path) {
                 case "/root":
                     return [dir("a"), dir("b"), file("ignore.txt")];
@@ -73,7 +71,7 @@ test("find: findDirectories at depth=2", async () => {
                     return [];
             }
         },
-        stat: async (_) => ({
+        stat: async () => ({
             isDirectory: () => false
         })
     };
@@ -88,10 +86,8 @@ test("find: findDirectories at depth=2", async () => {
     ].sort());
 });
 test("find: findDirectories at depth=3", async () => {
-    const calls = [];
     const deps = {
         readdir: async (path) => {
-            calls.push(path);
             switch (path) {
                 case "/root":
                     return [dir("a"), dir("b")];
@@ -108,7 +104,7 @@ test("find: findDirectories at depth=3", async () => {
                     return [];
             }
         },
-        stat: async (_) => ({
+        stat: async () => ({
             isDirectory: () => false
         })
     };

package/src/find.test.ts

@@ -77,12 +77,8 @@ test("find: findDirectories symlink is NOT treated as a directory", async () =>
 
 
 test("find: findDirectories at depth=2", async () => {
-    const calls: string[] = [];
-
     const deps: FileSystemDependencies = {
         readdir: async (path: string): Promise<{ name: string; isDirectory(): boolean }[]> => {
-            calls.push(path);
-
             switch (path) {
                 case "/root":
                     return [dir("a"), dir("b"), file("ignore.txt")];
@@ -94,7 +90,7 @@ test("find: findDirectories at depth=2", async () => {
                     return [];
             }
         },
-        stat: async (_: string) => ({
+        stat: async () => ({
             isDirectory: () => false
         })
     };
@@ -113,12 +109,8 @@ test("find: findDirectories at depth=2", async () => {
 });
 
 test("find: findDirectories at depth=3", async () => {
-    const calls: string[] = [];
-
     const deps: FileSystemDependencies = {
         readdir: async (path: string): Promise<{ name: string; isDirectory(): boolean }[]> => {
-            calls.push(path);
-
             switch (path) {
                 case "/root":
                     return [dir("a"), dir("b")];
@@ -130,12 +122,12 @@ test("find: findDirectories at depth=3", async () => {
                 case "/root/b/b1":
                     return [dir("c")];
                 case "/root/b/b1/c":
-                    return [dir("d"), file("fd")]
+                    return [dir("d"), file("fd")];
                 default:
                     return [];
             }
         },
-        stat: async (_: string) => ({
+        stat: async () => ({
             isDirectory: () => false
         })
     };

package/src/find.ts

@@ -65,7 +65,7 @@ function createFindDirectories(deps: FileSystemDependencies) {
             for (const entry of entries) {
                 const childPath = resolve(join(currentPath, entry.name));
 
-                let isDirectory = entry.isDirectory();
+                const isDirectory = entry.isDirectory();
 
                 if (!isDirectory) continue;
 
@@ -91,9 +91,9 @@ function createFindDirectories(deps: FileSystemDependencies) {
 
 export {
     createFindDirectories,
-}
+};
 
 export type {
     FileSystemDependencies,
     FindDirectoriesOptions,
-}
+};

package/src/index.ts

@@ -12,4 +12,4 @@ export {
 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",
 }