@brianbuie/node-kit 0.3.0 → 0.5.0

package/README.md

@@ -1,4 +1,6 @@
-# Node Kit • ![NPM Version](https://img.shields.io/npm/v/%40brianbuie%2Fnode-kit)
+[![NPM Version](https://img.shields.io/npm/v/%40brianbuie%2Fnode-kit)](https://www.npmjs.com/package/@brianbuie/node-kit)
+
+# Node Kit
 
 Basic tools for quick node.js projects
 

package/{.dist → dist}/Cache.d.ts

@@ -1,6 +1,5 @@
 export declare class Cache<T> {
     file: {
-        addExt(filepath: string): string;
         read(): {
             createdAt: number;
             value: T;

package/{.dist → dist}/Fetcher.js

@@ -10,7 +10,7 @@ export class Fetcher {
     constructor(opts = {}) {
         const defaultOptions = {
             timeout: 60000,
-            retries: 3,
+            retries: 0,
             retryDelay: 3000,
         };
         this.defaultOptions = merge(defaultOptions, opts);

package/{.dist → dist}/File.d.ts

@@ -14,26 +14,25 @@ export declare class File {
      */
     lines(): string[];
     static get Adaptor(): typeof FileAdaptor;
-    json<T>(): JsonFile<T>;
+    json<T>(contents?: T): JsonFile<T>;
     static get json(): typeof JsonFile;
-    ndjson<T>(): NdjsonFile<T>;
+    ndjson<T>(contents?: T): NdjsonFile<T>;
     static get ndjson(): typeof NdjsonFile;
 }
-declare class FileAdaptor {
+declare class FileAdaptor<T = string> {
     file: File;
-    constructor(file: string | File);
-    addExt(filepath: string): string;
+    constructor(filepath: string, contents?: T);
     get exists(): boolean;
     get path(): string;
 }
 declare class JsonFile<T> extends FileAdaptor {
-    addExt(filepath: string): string;
+    constructor(filepath: string, contents?: T);
     read(): T | undefined;
     write(contents: T): void;
 }
 declare class NdjsonFile<T> extends FileAdaptor {
-    addExt(filepath: string): string;
-    lines(): T[];
+    constructor(filepath: string, contents?: T);
     append(lines: T | T[]): void;
+    lines(): T[];
 }
 export {};

package/{.dist → dist}/File.js

@@ -36,14 +36,14 @@ export class File {
     static get Adaptor() {
         return FileAdaptor;
     }
-    json() {
-        return new JsonFile(this);
+    json(contents) {
+        return new JsonFile(this.path, contents);
     }
     static get json() {
         return JsonFile;
     }
-    ndjson() {
-        return new NdjsonFile(this);
+    ndjson(contents) {
+        return new NdjsonFile(this.path, contents);
     }
     static get ndjson() {
         return NdjsonFile;
@@ -51,23 +51,15 @@ export class File {
 }
 class FileAdaptor {
     file;
-    constructor(file) {
-        if (file instanceof File) {
-            const withExt = this.addExt(file.path);
-            if (withExt === file.path) {
-                this.file = file;
+    constructor(filepath, contents) {
+        this.file = new File(filepath);
+        if (contents) {
+            if (typeof contents !== 'string') {
+                throw new Error('File contents must be a string');
             }
-            else {
-                this.file = new File(withExt);
-            }
-        }
-        else {
-            this.file = new File(this.addExt(file));
+            this.file.write(contents);
         }
     }
-    addExt(filepath) {
-        return filepath;
-    }
     get exists() {
         return this.file.exists;
     }
@@ -76,8 +68,10 @@ class FileAdaptor {
     }
 }
 class JsonFile extends FileAdaptor {
-    addExt(filepath) {
-        return filepath.endsWith('.json') ? filepath : filepath + '.json';
+    constructor(filepath, contents) {
+        super(filepath.endsWith('.json') ? filepath : filepath + '.json');
+        if (contents)
+            this.write(contents);
     }
     read() {
         const contents = this.file.read();
@@ -88,16 +82,15 @@ class JsonFile extends FileAdaptor {
     }
 }
 class NdjsonFile extends FileAdaptor {
-    addExt(filepath) {
-        return filepath.endsWith('.ndjson') ? filepath : filepath + '.ndjson';
+    constructor(filepath, contents) {
+        super(filepath.endsWith('.ndjson') ? filepath : filepath + '.ndjson');
+        if (contents)
+            this.append(contents);
+    }
+    append(lines) {
+        this.file.append(Array.isArray(lines) ? lines.map((l) => JSON.stringify(snapshot(l))) : JSON.stringify(snapshot(lines)));
     }
     lines() {
         return this.file.lines().map((l) => JSON.parse(l));
     }
-    append(lines) {
-        const contents = Array.isArray(lines)
-            ? lines.map((l) => JSON.stringify(snapshot(l)))
-            : JSON.stringify(snapshot(lines));
-        this.file.append(contents);
-    }
 }

package/{.dist → dist}/Log.js

@@ -23,7 +23,7 @@ export class Log {
     static #toConsole(entry, color) {
         if (entry.message)
             console.log(color(`[${entry.severity}] ${entry.message}`));
-        entry.details?.forEach(detail => {
+        entry.details?.forEach((detail) => {
             console.log(inspect(detail, { depth: 10, breakLength: 100, compact: true, colors: true }));
         });
     }
@@ -46,7 +46,7 @@ export class Log {
      * Also snapshots special objects (eg Error, Response) to keep props in later JSON.stringify output
      */
     static prepare(...input) {
-        let [first, ...rest] = input.map(snapshot);
+        let [first, ...rest] = input.map((i) => snapshot(i));
         if (typeof first === 'string')
             return { message: first, details: rest };
         // @ts-ignore
@@ -73,7 +73,7 @@ export class Log {
         return this.#log({ severity: 'INFO', color: chalk.white }, ...input);
     }
     static debug(...input) {
-        const debugging = process.argv.some(arg => arg.includes('--debug')) || process.env.DEBUG !== undefined;
+        const debugging = process.argv.some((arg) => arg.includes('--debug')) || process.env.DEBUG !== undefined;
         if (debugging || process.env.NODE_ENV !== 'production') {
             return this.#log({ severity: 'DEBUG', color: chalk.gray }, ...input);
         }

package/{.dist → dist}/snapshot.d.ts

@@ -2,4 +2,4 @@
  * Allows special objects (Error, Headers, Set) to be included in JSON.stringify output
  * functions are removed
  */
-export declare function snapshot(i: unknown): any;
+export declare function snapshot(i: unknown, max?: number, depth?: number): any;

package/{.dist → dist}/snapshot.js

@@ -3,19 +3,24 @@ import { isObjectLike } from 'lodash-es';
  * Allows special objects (Error, Headers, Set) to be included in JSON.stringify output
  * functions are removed
  */
-export function snapshot(i) {
-    if (Array.isArray(i))
-        return i.map(snapshot);
+export function snapshot(i, max = 50, depth = 0) {
+    if (Array.isArray(i)) {
+        if (depth === max)
+            return [];
+        return i.map((c) => snapshot(c, max, depth + 1));
+    }
     if (typeof i === 'function')
         return undefined;
     if (!isObjectLike(i))
         return i;
+    if (depth === max)
+        return {};
     let output = {};
     // @ts-ignore If it has an 'entries' function, use that for looping (eg. Set, Map, Headers)
     if (typeof i.entries === 'function') {
         // @ts-ignore
         for (let [k, v] of i.entries()) {
-            output[k] = snapshot(v);
+            output[k] = snapshot(v, max, depth + 1);
         }
         return output;
     }
@@ -23,11 +28,11 @@ export function snapshot(i) {
     // Get Enumerable, inherited properties
     const obj = i;
     for (let key in obj) {
-        output[key] = snapshot(obj[key]);
+        output[key] = snapshot(obj[key], max, depth + 1);
     }
     // Get Non-enumberable, own properties
-    Object.getOwnPropertyNames(obj).forEach(key => {
-        output[key] = snapshot(obj[key]);
+    Object.getOwnPropertyNames(obj).forEach((key) => {
+        output[key] = snapshot(obj[key], max, depth + 1);
     });
     return output;
 }

package/package.json

@@ -1,24 +1,24 @@
 {
   "name": "@brianbuie/node-kit",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "license": "ISC",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/brianbuie/node-kit.git"
   },
   "scripts": {
-    "test": "tsc && node --test \".dist/**/*.test.js\" --quiet",
+    "test": "tsc && node --test \"dist/**/*.test.js\" --quiet",
     "preversion": "npm test",
     "postversion": "git push --follow-tags"
   },
   "type": "module",
   "exports": {
-    ".": "./.dist/_index.js"
+    ".": "./dist/_index.js"
   },
   "files": [
     "src",
-    ".dist",
-    "!.dist/**/*.test.*",
+    "dist",
+    "!dist/**/*.test.*",
     "README.md"
   ],
   "engines": {

package/src/Fetcher.ts

@@ -27,7 +27,7 @@ export class Fetcher {
   constructor(opts: FetchOptions = {}) {
     const defaultOptions = {
       timeout: 60000,
-      retries: 3,
+      retries: 0,
       retryDelay: 3000,
     };
     this.defaultOptions = merge(defaultOptions, opts);

package/src/File.test.ts

@@ -51,8 +51,7 @@ describe('File.ndjson', () => {
 
 describe('File.json', () => {
   it('Saves data as json', () => {
-    const file = testDir.file('jsonfile-data').json<typeof thing>();
-    file.write(thing);
+    const file = testDir.file('jsonfile-data').json(thing);
     assert(isEqual(file.read(), thing));
     file.write(thing);
     assert(isEqual(file.read(), thing));

package/src/File.ts

@@ -44,16 +44,16 @@ export class File {
     return FileAdaptor;
   }
 
-  json<T>() {
-    return new JsonFile<T>(this);
+  json<T>(contents?: T) {
+    return new JsonFile<T>(this.path, contents);
   }
 
   static get json() {
     return JsonFile;
   }
 
-  ndjson<T>() {
-    return new NdjsonFile<T>(this);
+  ndjson<T>(contents?: T) {
+    return new NdjsonFile<T>(this.path, contents);
   }
 
   static get ndjson() {
@@ -61,26 +61,19 @@ export class File {
   }
 }
 
-class FileAdaptor {
+class FileAdaptor<T = string> {
   file;
 
-  constructor(file: string | File) {
-    if (file instanceof File) {
-      const withExt = this.addExt(file.path);
-      if (withExt === file.path) {
-        this.file = file;
-      } else {
-        this.file = new File(withExt);
+  constructor(filepath: string, contents?: T) {
+    this.file = new File(filepath);
+    if (contents) {
+      if (typeof contents !== 'string') {
+        throw new Error('File contents must be a string');
       }
-    } else {
-      this.file = new File(this.addExt(file));
+      this.file.write(contents);
     }
   }
 
-  addExt(filepath: string) {
-    return filepath;
-  }
-
   get exists() {
     return this.file.exists;
   }
@@ -91,8 +84,9 @@ class FileAdaptor {
 }
 
 class JsonFile<T> extends FileAdaptor {
-  addExt(filepath: string) {
-    return filepath.endsWith('.json') ? filepath : filepath + '.json';
+  constructor(filepath: string, contents?: T) {
+    super(filepath.endsWith('.json') ? filepath : filepath + '.json');
+    if (contents) this.write(contents);
   }
 
   read() {
@@ -106,18 +100,18 @@ class JsonFile<T> extends FileAdaptor {
 }
 
 class NdjsonFile<T> extends FileAdaptor {
-  addExt(filepath: string) {
-    return filepath.endsWith('.ndjson') ? filepath : filepath + '.ndjson';
+  constructor(filepath: string, contents?: T) {
+    super(filepath.endsWith('.ndjson') ? filepath : filepath + '.ndjson');
+    if (contents) this.append(contents);
   }
 
-  lines() {
-    return this.file.lines().map((l) => JSON.parse(l) as T);
+  append(lines: T | T[]) {
+    this.file.append(
+      Array.isArray(lines) ? lines.map((l) => JSON.stringify(snapshot(l))) : JSON.stringify(snapshot(lines))
+    );
   }
 
-  append(lines: T | T[]) {
-    const contents = Array.isArray(lines)
-      ? lines.map((l) => JSON.stringify(snapshot(l)))
-      : JSON.stringify(snapshot(lines));
-    this.file.append(contents);
+  lines() {
+    return this.file.lines().map((l) => JSON.parse(l) as T);
   }
 }

package/src/Log.ts

@@ -38,7 +38,7 @@ export class Log {
    */
   static #toConsole(entry: Entry, color: ChalkInstance) {
     if (entry.message) console.log(color(`[${entry.severity}] ${entry.message}`));
-    entry.details?.forEach(detail => {
+    entry.details?.forEach((detail) => {
       console.log(inspect(detail, { depth: 10, breakLength: 100, compact: true, colors: true }));
     });
   }
@@ -63,7 +63,7 @@ export class Log {
    * Also snapshots special objects (eg Error, Response) to keep props in later JSON.stringify output
    */
   static prepare(...input: unknown[]): { message?: string; details: unknown[] } {
-    let [first, ...rest] = input.map(snapshot);
+    let [first, ...rest] = input.map((i) => snapshot(i));
     if (typeof first === 'string') return { message: first, details: rest };
     // @ts-ignore
     if (isObjectLike(first) && typeof first['message'] === 'string') {
@@ -94,7 +94,7 @@ export class Log {
   }
 
   static debug(...input: unknown[]) {
-    const debugging = process.argv.some(arg => arg.includes('--debug')) || process.env.DEBUG !== undefined;
+    const debugging = process.argv.some((arg) => arg.includes('--debug')) || process.env.DEBUG !== undefined;
     if (debugging || process.env.NODE_ENV !== 'production') {
       return this.#log({ severity: 'DEBUG', color: chalk.gray }, ...input);
     }

package/src/snapshot.test.ts

@@ -1,6 +1,7 @@
 import { describe, it } from 'node:test';
 import assert from 'node:assert';
 import { snapshot } from './snapshot.js';
+import { temp } from './Dir.js';
 
 describe('snapshot', () => {
   it('Captures Error details', () => {
@@ -32,4 +33,22 @@ describe('snapshot', () => {
     const shot = snapshot(test) as Record<string, any>;
     assert(shot.func === undefined);
   });
+
+  it('Handles recursive references', () => {
+    type Thing = { id: number; thing?: Thing; things: Thing[] };
+    function createThing(id: number, thing?: Thing) {
+      const newThing: Thing = { id, thing, things: [] };
+      if (thing) {
+        thing.things.push(newThing);
+      }
+      return newThing;
+    }
+    const t1 = createThing(1);
+    const t2 = createThing(2, t1);
+    const result = snapshot(t1, 20) as Thing;
+    const f1 = temp.file('recursive').json(result);
+    const parsed = f1.read();
+    const f2 = temp.file('recursive2').json(parsed);
+    assert.deepEqual(f1.read(), f2.read());
+  });
 });

package/src/snapshot.ts

@@ -4,17 +4,21 @@ import { isObjectLike } from 'lodash-es';
  * Allows special objects (Error, Headers, Set) to be included in JSON.stringify output
  * functions are removed
  */
-export function snapshot(i: unknown): any {
-  if (Array.isArray(i)) return i.map(snapshot);
+export function snapshot(i: unknown, max = 50, depth = 0): any {
+  if (Array.isArray(i)) {
+    if (depth === max) return [];
+    return i.map((c) => snapshot(c, max, depth + 1));
+  }
   if (typeof i === 'function') return undefined;
   if (!isObjectLike(i)) return i;
 
+  if (depth === max) return {};
   let output: Record<string, any> = {};
   // @ts-ignore If it has an 'entries' function, use that for looping (eg. Set, Map, Headers)
   if (typeof i.entries === 'function') {
     // @ts-ignore
     for (let [k, v] of i.entries()) {
-      output[k] = snapshot(v);
+      output[k] = snapshot(v, max, depth + 1);
     }
     return output;
   }
@@ -24,12 +28,12 @@ export function snapshot(i: unknown): any {
   // Get Enumerable, inherited properties
   const obj: Record<string, any> = i!;
   for (let key in obj) {
-    output[key] = snapshot(obj[key]);
+    output[key] = snapshot(obj[key], max, depth + 1);
   }
 
   // Get Non-enumberable, own properties
-  Object.getOwnPropertyNames(obj).forEach(key => {
-    output[key] = snapshot(obj[key]);
+  Object.getOwnPropertyNames(obj).forEach((key) => {
+    output[key] = snapshot(obj[key], max, depth + 1);
   });
 
   return output;