@brianbuie/node-kit 0.4.0 → 0.5.1

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

@@ -11,6 +11,7 @@ export declare class Cache<T> {
         file: import("./File.js").File;
         get exists(): boolean;
         get path(): string;
+        delete(): void;
     };
     ttl: number;
     refresh: () => T | Promise<T>;

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

@@ -13,10 +13,11 @@ export declare class File {
      * @returns lines as strings, removes trailing '\n'
      */
     lines(): string[];
+    delete(): void;
     static get Adaptor(): typeof FileAdaptor;
     json<T>(contents?: T): JsonFile<T>;
     static get json(): typeof JsonFile;
-    ndjson<T>(contents?: T): NdjsonFile<T>;
+    ndjson<T>(lines?: T | T[]): NdjsonFile<T>;
     static get ndjson(): typeof NdjsonFile;
 }
 declare class FileAdaptor<T = string> {
@@ -24,6 +25,7 @@ declare class FileAdaptor<T = string> {
     constructor(filepath: string, contents?: T);
     get exists(): boolean;
     get path(): string;
+    delete(): void;
 }
 declare class JsonFile<T> extends FileAdaptor {
     constructor(filepath: string, contents?: T);
@@ -31,7 +33,7 @@ declare class JsonFile<T> extends FileAdaptor {
     write(contents: T): void;
 }
 declare class NdjsonFile<T> extends FileAdaptor {
-    constructor(filepath: string, contents?: T);
+    constructor(filepath: string, lines?: T | T[]);
     append(lines: T | T[]): void;
     lines(): T[];
 }

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

@@ -33,6 +33,9 @@ export class File {
         const contents = (this.read() || '').split('\n');
         return contents.slice(0, contents.length - 1);
     }
+    delete() {
+        fs.rmSync(this.path, { force: true });
+    }
     static get Adaptor() {
         return FileAdaptor;
     }
@@ -42,8 +45,8 @@ export class File {
     static get json() {
         return JsonFile;
     }
-    ndjson(contents) {
-        return new NdjsonFile(this.path, contents);
+    ndjson(lines) {
+        return new NdjsonFile(this.path, lines);
     }
     static get ndjson() {
         return NdjsonFile;
@@ -66,6 +69,9 @@ class FileAdaptor {
     get path() {
         return this.file.path;
     }
+    delete() {
+        this.file.delete();
+    }
 }
 class JsonFile extends FileAdaptor {
     constructor(filepath, contents) {
@@ -82,10 +88,10 @@ class JsonFile extends FileAdaptor {
     }
 }
 class NdjsonFile extends FileAdaptor {
-    constructor(filepath, contents) {
+    constructor(filepath, lines) {
         super(filepath.endsWith('.ndjson') ? filepath : filepath + '.ndjson');
-        if (contents)
-            this.append(contents);
+        if (lines)
+            this.append(lines);
     }
     append(lines) {
         this.file.append(Array.isArray(lines) ? lines.map((l) => JSON.stringify(snapshot(l))) : JSON.stringify(snapshot(lines)));

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.4.0",
+  "version": "0.5.1",
   "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/File.test.ts

@@ -15,7 +15,7 @@ const thing = {
 };
 
 describe('FileAdaptor', () => {
-  it('Instances can be created', () => {
+  it('Creates instances', () => {
     const test1 = new File.Adaptor(testDir.filepath('test1.txt'));
     assert(test1.file.path.includes('test1.txt'));
 
@@ -26,6 +26,14 @@ describe('FileAdaptor', () => {
     const eg3 = eg3File.json();
     assert(eg1.path === eg2.path && eg2.path === eg3.path);
   });
+
+  it('Deletes files', () => {
+    const test = testDir.file('delete-test.txt');
+    test.write('test');
+    assert.equal(test.read(), 'test');
+    test.delete();
+    assert.equal(test.exists, false);
+  });
 });
 
 describe('File.ndjson', () => {

package/src/File.ts

@@ -40,6 +40,10 @@ export class File {
     return contents.slice(0, contents.length - 1);
   }
 
+  delete() {
+    fs.rmSync(this.path, { force: true });
+  }
+
   static get Adaptor() {
     return FileAdaptor;
   }
@@ -52,8 +56,8 @@ export class File {
     return JsonFile;
   }
 
-  ndjson<T>(contents?: T) {
-    return new NdjsonFile<T>(this.path, contents);
+  ndjson<T>(lines?: T | T[]) {
+    return new NdjsonFile<T>(this.path, lines);
   }
 
   static get ndjson() {
@@ -81,6 +85,10 @@ class FileAdaptor<T = string> {
   get path() {
     return this.file.path;
   }
+
+  delete() {
+    this.file.delete();
+  }
 }
 
 class JsonFile<T> extends FileAdaptor {
@@ -100,9 +108,9 @@ class JsonFile<T> extends FileAdaptor {
 }
 
 class NdjsonFile<T> extends FileAdaptor {
-  constructor(filepath: string, contents?: T) {
+  constructor(filepath: string, lines?: T | T[]) {
     super(filepath.endsWith('.ndjson') ? filepath : filepath + '.ndjson');
-    if (contents) this.append(contents);
+    if (lines) this.append(lines);
   }
 
   append(lines: T | 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;