@brianbuie/node-kit 0.2.4 → 0.2.5

package/.dist/Dir.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Reference to a specific directory with helpful methods for resolving filepaths,
+ * sanitizing filenames, and saving files
+ */
+export declare class Dir {
+    path: string;
+    /**
+     * @param path can be relative to workspace or absolute
+     */
+    constructor(_path: string);
+    make(): void;
+    /**
+     * Create a new Dir inside the current Dir
+     * @param subPath to create in current Dir
+     * @example
+     * const folder = new Dir('example');
+     * // folder.path = './example'
+     * const child = folder.subDir('path/to/dir');
+     * // child.path = './example/path/to/dir'
+     */
+    subDir(subPath: string): Dir;
+    sanitize(name: string): string;
+    /**
+     * @param base - The file name with extension
+     * @example
+     * const folder = new Dir('example');
+     * const filepath = folder.resolve('file.json');
+     * // 'example/file.json'
+     */
+    resolve(base: string): string;
+    /**
+     * Save something in this Dir
+     * @param base filename with extension. `.json` will be used if base doesn't include an ext.
+     * @param contents `string`, or `any` if it's a json file
+     * @returns the filepath of the saved file
+     */
+    save(base: string, contents: any): string;
+}
+/**
+ * Extends Dir class with method to `clear()` contents
+ */
+export declare class TempDir extends Dir {
+    subDir(subPath: string): TempDir;
+    clear(): void;
+}
+/**
+ * Common temp dir location
+ */
+export declare const temp: TempDir;

package/.dist/Dir.js

@@ -0,0 +1,77 @@
+import fs from 'fs';
+import path from 'path';
+import sanitizeFilename from 'sanitize-filename';
+import { snapshot } from './snapshot.js';
+/**
+ * Reference to a specific directory with helpful methods for resolving filepaths,
+ * sanitizing filenames, and saving files
+ */
+export class Dir {
+    path;
+    /**
+     * @param path can be relative to workspace or absolute
+     */
+    constructor(_path) {
+        this.path = _path;
+    }
+    make() {
+        fs.mkdirSync(this.path, { recursive: true });
+    }
+    /**
+     * Create a new Dir inside the current Dir
+     * @param subPath to create in current Dir
+     * @example
+     * const folder = new Dir('example');
+     * // folder.path = './example'
+     * const child = folder.subDir('path/to/dir');
+     * // child.path = './example/path/to/dir'
+     */
+    subDir(subPath) {
+        return new Dir(path.resolve(this.path, subPath));
+    }
+    sanitize(name) {
+        return sanitizeFilename(name.replace('https://', '').replace('www.', ''), { replacement: '_' });
+    }
+    /**
+     * @param base - The file name with extension
+     * @example
+     * const folder = new Dir('example');
+     * const filepath = folder.resolve('file.json');
+     * // 'example/file.json'
+     */
+    resolve(base) {
+        return path.resolve(this.path, this.sanitize(base));
+    }
+    /**
+     * Save something in this Dir
+     * @param base filename with extension. `.json` will be used if base doesn't include an ext.
+     * @param contents `string`, or `any` if it's a json file
+     * @returns the filepath of the saved file
+     */
+    save(base, contents) {
+        if (typeof contents !== 'string') {
+            if (!/\.json$/.test(base))
+                base += '.json';
+            contents = JSON.stringify(snapshot(contents), null, 2);
+        }
+        const filepath = this.resolve(base);
+        this.make();
+        fs.writeFileSync(filepath, contents);
+        return filepath;
+    }
+}
+/**
+ * Extends Dir class with method to `clear()` contents
+ */
+export class TempDir extends Dir {
+    subDir(subPath) {
+        return new TempDir(path.resolve(this.path, subPath));
+    }
+    clear() {
+        fs.rmSync(this.path, { recursive: true, force: true });
+    }
+}
+/**
+ * Common temp dir location
+ */
+export const temp = new TempDir('.temp');

package/.dist/_index.d.ts

@@ -1,5 +1,6 @@
+export { Dir, TempDir, temp } from './Dir.js';
 export { Fetcher, type Route, Query, FetchOptions } from './Fetcher.js';
 export { Jwt } from './Jwt.js';
-export { snapshot } from './snapshot.js';
 export { Log } from './Log.js';
+export { snapshot } from './snapshot.js';
 export { TypeWriter } from './TypeWriter.js';

package/.dist/_index.js

@@ -1,5 +1,6 @@
+export { Dir, TempDir, temp } from './Dir.js';
 export { Fetcher } from './Fetcher.js';
 export { Jwt } from './Jwt.js';
-export { snapshot } from './snapshot.js';
 export { Log } from './Log.js';
+export { snapshot } from './snapshot.js';
 export { TypeWriter } from './TypeWriter.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brianbuie/node-kit",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "license": "ISC",
   "repository": {
     "type": "git",
@@ -32,7 +32,8 @@
     "extract-domain": "^5.0.2",
     "jsonwebtoken": "^9.0.2",
     "lodash-es": "^4.17.21",
-    "quicktype-core": "^23.2.6"
+    "quicktype-core": "^23.2.6",
+    "sanitize-filename": "^1.6.3"
   },
   "devDependencies": {
     "typescript": "^5.9.3"

package/src/Dir.test.ts

@@ -0,0 +1,25 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert';
+import { Dir, TempDir, temp } from './Dir.js';
+
+describe('Dir', () => {
+  const test = new Dir('test');
+
+  it('Sanitizes filenames', () => {
+    const name = test.sanitize(':/something/else.json');
+    assert(!name.includes('/'));
+    assert(!name.includes(':'));
+  });
+
+  it('Creates sub directories', () => {
+    const subPath = 'sub/dir';
+    const sub = test.subDir(subPath);
+    assert(sub.path.includes(test.path));
+    assert(sub.path.includes(subPath));
+  });
+
+  it('TempDir.subDir returns instance of TempDir', () => {
+    const sub = temp.subDir('example');
+    assert(sub instanceof TempDir);
+  });
+});

package/src/Dir.ts

@@ -0,0 +1,86 @@
+import fs from 'fs';
+import path from 'path';
+import sanitizeFilename from 'sanitize-filename';
+import { snapshot } from './snapshot.js';
+
+/**
+ * Reference to a specific directory with helpful methods for resolving filepaths,
+ * sanitizing filenames, and saving files
+ */
+export class Dir {
+  path;
+
+  /**
+   * @param path can be relative to workspace or absolute
+   */
+  constructor(_path: string) {
+    this.path = _path;
+  }
+
+  make() {
+    fs.mkdirSync(this.path, { recursive: true });
+  }
+
+  /**
+   * Create a new Dir inside the current Dir
+   * @param subPath to create in current Dir
+   * @example
+   * const folder = new Dir('example');
+   * // folder.path = './example'
+   * const child = folder.subDir('path/to/dir');
+   * // child.path = './example/path/to/dir'
+   */
+  subDir(subPath: string) {
+    return new Dir(path.resolve(this.path, subPath));
+  }
+
+  sanitize(name: string) {
+    return sanitizeFilename(name.replace('https://', '').replace('www.', ''), { replacement: '_' });
+  }
+
+  /**
+   * @param base - The file name with extension
+   * @example
+   * const folder = new Dir('example');
+   * const filepath = folder.resolve('file.json');
+   * // 'example/file.json'
+   */
+  resolve(base: string) {
+    return path.resolve(this.path, this.sanitize(base));
+  }
+
+  /**
+   * Save something in this Dir
+   * @param base filename with extension. `.json` will be used if base doesn't include an ext.
+   * @param contents `string`, or `any` if it's a json file
+   * @returns the filepath of the saved file
+   */
+  save(base: string, contents: any) {
+    if (typeof contents !== 'string') {
+      if (!/\.json$/.test(base)) base += '.json';
+      contents = JSON.stringify(snapshot(contents), null, 2);
+    }
+    const filepath = this.resolve(base);
+    this.make();
+    fs.writeFileSync(filepath, contents);
+    return filepath;
+  }
+}
+
+/**
+ * Extends Dir class with method to `clear()` contents
+ */
+export class TempDir extends Dir {
+  subDir(subPath: string) {
+    return new TempDir(path.resolve(this.path, subPath));
+  }
+
+  clear() {
+    fs.rmSync(this.path, { recursive: true, force: true });
+  }
+}
+
+/**
+ * Common temp dir location
+ */
+export const temp = new TempDir('.temp');

package/src/_index.ts

@@ -1,5 +1,6 @@
+export { Dir, TempDir, temp } from './Dir.js';
 export { Fetcher, type Route, Query, FetchOptions } from './Fetcher.js';
 export { Jwt } from './Jwt.js';
-export { snapshot } from './snapshot.js';
 export { Log } from './Log.js';
+export { snapshot } from './snapshot.js';
 export { TypeWriter } from './TypeWriter.js';