@thi.ng/file-io 0.1.0 → 0.3.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-05-18T12:59:20Z
+- **Last updated**: 2022-05-20T09:18:30Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,25 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [0.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/file-io@0.3.0) (2022-05-20)
+
+#### 🚀 Features
+
+- add more fns (hashing, masking etc.) ([95b9e2b](https://github.com/thi-ng/umbrella/commit/95b9e2b))
+  - add fileHash(), stringHash()
+  - add maskHomeDir()
+  - add fileExt(), isDirectory()
+
+#### 🩹 Bug fixes
+
+- fix ensureDir() for local file paths ([4ae95c2](https://github.com/thi-ng/umbrella/commit/4ae95c2))
+
+## [0.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/file-io@0.2.0) (2022-05-19)
+
+#### 🚀 Features
+
+- add dirs() iterator, add writeFile(), dry-run handling ([0279db8](https://github.com/thi-ng/umbrella/commit/0279db8))
+
 ## [0.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/file-io@0.1.0) (2022-05-18)
 
 #### 🚀 Features

package/delete.d.ts

@@ -1,3 +1,12 @@
 import type { ILogger } from "@thi.ng/logger";
-export declare const deleteFile: (path: string, logger?: ILogger | undefined) => void;
+/**
+ * Deletes file at given path. If `dryRun` is true (default: false), the file
+ * WON'T be deleted, however if a `logger` is provided then at least a dry-run
+ * log message will be emitted.
+ *
+ * @param path
+ * @param logger
+ * @param dryRun
+ */
+export declare const deleteFile: (path: string, logger?: ILogger | undefined, dryRun?: boolean) => void;
 //# sourceMappingURL=delete.d.ts.map

package/delete.js

@@ -1,5 +1,16 @@
 import { unlinkSync } from "fs";
-export const deleteFile = (path, logger) => {
-    logger && logger.debug("deleting file:", path);
+/**
+ * Deletes file at given path. If `dryRun` is true (default: false), the file
+ * WON'T be deleted, however if a `logger` is provided then at least a dry-run
+ * log message will be emitted.
+ *
+ * @param path
+ * @param logger
+ * @param dryRun
+ */
+export const deleteFile = (path, logger, dryRun = false) => {
+    logger && logger.info(`${dryRun ? "[dryrun] " : ""}deleting file: ${path}`);
+    if (dryRun)
+        return;
     unlinkSync(path);
 };

package/dir.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Checks if the directory for given file `path` already exists, and if not the
+ * case, creates it. Returns true if the latter case.
+ *
+ * @remarks
+ * If `path` only contains a filename (without any directory structure), the
+ * function does nothing.
+ *
+ * @param path
+ */
+export declare const ensureDirForFile: (path: string) => boolean;
+/**
+ * Returns true if `path` is a directory (assumes path exists).
+ *
+ * @param path
+ */
+export declare const isDirectory: (path: string) => boolean;
+//# sourceMappingURL=dir.d.ts.map

package/dir.js

@@ -0,0 +1,24 @@
+import { existsSync, mkdirSync, statSync } from "fs";
+import { sep } from "path";
+/**
+ * Checks if the directory for given file `path` already exists, and if not the
+ * case, creates it. Returns true if the latter case.
+ *
+ * @remarks
+ * If `path` only contains a filename (without any directory structure), the
+ * function does nothing.
+ *
+ * @param path
+ */
+export const ensureDirForFile = (path) => {
+    const dir = path.substring(0, path.lastIndexOf(sep));
+    return dir.length > 0 && !existsSync(dir)
+        ? (mkdirSync(dir, { recursive: true }), true)
+        : false;
+};
+/**
+ * Returns true if `path` is a directory (assumes path exists).
+ *
+ * @param path
+ */
+export const isDirectory = (path) => statSync(path).isDirectory();

package/ext.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns file extension of given file `path`.
+ *
+ * @param path
+ */
+export declare const fileExt: (path: string) => string;
+//# sourceMappingURL=ext.d.ts.map

package/ext.js

@@ -0,0 +1,9 @@
+/**
+ * Returns file extension of given file `path`.
+ *
+ * @param path
+ */
+export const fileExt = (path) => {
+    const match = /\.(\w+)$/.exec(path);
+    return match ? match[1].toLowerCase() : "";
+};

package/files.d.ts

@@ -3,10 +3,31 @@ import type { ILogger } from "@thi.ng/logger";
  * Recursively reads given directory (up to given max. depth, default: infinite)
  * and yields sequence of file names matching given extension (or regexp).
  *
+ * @remarks
+ * If NO `match` is given, all files will be matched. Directory names will not
+ * be tested and are always traversed (up to given `maxDepth`).
+ *
+ * The optional `logger` is only used to log errors for files which couldn't be
+ * accessed.
+ *
+ * @param dir
+ * @param match
+ * @param maxDepth
+ * @param logger
+ */
+export declare const files: (dir: string, match?: string | RegExp, maxDepth?: number, logger?: ILogger | undefined) => IterableIterator<string>;
+/**
+ * Similar to {@link files}, however yields iterator of only matching
+ * sub-directories in given `dir`. Normal files are being ignored.
+ *
+ * @remarks
+ * Unlike the regex matching in {@link files}, here the regex will be applied to
+ * the _full_ sub-path (starting with `dir`) in order to determine a match.
+ *
  * @param dir
  * @param match
  * @param maxDepth
  * @param logger
  */
-export declare const files: (dir: string, match: string | RegExp, maxDepth?: number, logger?: ILogger | undefined) => IterableIterator<string>;
+export declare const dirs: (dir: string, match?: string | RegExp, maxDepth?: number, logger?: ILogger | undefined) => IterableIterator<string>;
 //# sourceMappingURL=files.d.ts.map

package/files.js

@@ -1,31 +1,37 @@
 import { isString } from "@thi.ng/checks/is-string";
 import { readdirSync, statSync } from "fs";
 import { sep } from "path";
+import { isDirectory } from "./dir.js";
 /**
  * Recursively reads given directory (up to given max. depth, default: infinite)
  * and yields sequence of file names matching given extension (or regexp).
  *
+ * @remarks
+ * If NO `match` is given, all files will be matched. Directory names will not
+ * be tested and are always traversed (up to given `maxDepth`).
+ *
+ * The optional `logger` is only used to log errors for files which couldn't be
+ * accessed.
+ *
  * @param dir
  * @param match
  * @param maxDepth
  * @param logger
  */
-export const files = (dir, match, maxDepth = Infinity, logger) => __files(dir, match, logger, maxDepth, 0);
-function* __files(dir, match, logger, maxDepth = Infinity, depth = 0) {
+export const files = (dir, match = "", maxDepth = Infinity, logger) => __files(dir, match, logger, maxDepth, 0);
+function* __files(dir, match = "", logger, maxDepth = Infinity, depth = 0) {
     if (depth >= maxDepth)
         return;
-    const re = isString(match)
-        ? new RegExp(`${match.replace(/\./g, "\\.")}$`)
-        : match;
+    const re = __ensureRegEx(match);
     for (let f of readdirSync(dir)) {
         const curr = dir + sep + f;
         try {
-            if (re.test(f)) {
-                yield curr;
-            }
-            else if (statSync(curr).isDirectory()) {
+            if (isDirectory(curr)) {
                 yield* __files(curr, match, logger, maxDepth, depth + 1);
             }
+            else if (re.test(f)) {
+                yield curr;
+            }
         }
         catch (e) {
             logger &&
@@ -33,3 +39,38 @@ function* __files(dir, match, logger, maxDepth = Infinity, depth = 0) {
         }
     }
 }
+/**
+ * Similar to {@link files}, however yields iterator of only matching
+ * sub-directories in given `dir`. Normal files are being ignored.
+ *
+ * @remarks
+ * Unlike the regex matching in {@link files}, here the regex will be applied to
+ * the _full_ sub-path (starting with `dir`) in order to determine a match.
+ *
+ * @param dir
+ * @param match
+ * @param maxDepth
+ * @param logger
+ */
+export const dirs = (dir, match = "", maxDepth = Infinity, logger) => __dirs(dir, match, logger, maxDepth, 0);
+function* __dirs(dir, match = "", logger, maxDepth = Infinity, depth = 0) {
+    if (depth >= maxDepth)
+        return;
+    const re = __ensureRegEx(match);
+    for (let f of readdirSync(dir)) {
+        const curr = dir + sep + f;
+        try {
+            if (statSync(curr).isDirectory()) {
+                if (re.test(curr))
+                    yield curr;
+                yield* __dirs(curr, match, logger, maxDepth, depth + 1);
+            }
+        }
+        catch (e) {
+            logger &&
+                logger.warn(`ignoring file/dir: ${f} (${e.message})`);
+        }
+    }
+}
+/** @internal */
+const __ensureRegEx = (match) => isString(match) ? new RegExp(`${match.replace(/\./g, "\\.")}$`) : match;

package/hash.d.ts

@@ -0,0 +1,5 @@
+import type { ILogger } from "@thi.ng/logger";
+export declare type HashAlgo = "gost-mac" | "md4" | "md5" | "md_gost94" | "ripemd160" | "sha1" | "sha224" | "sha256" | "sha384" | "sha512" | "streebog256" | "streebog512" | "whirlpool";
+export declare const fileHash: (path: string, logger?: ILogger | undefined, algo?: HashAlgo) => string;
+export declare const stringHash: (src: string, logger?: ILogger | undefined, algo?: HashAlgo) => string;
+//# sourceMappingURL=hash.d.ts.map

package/hash.js

@@ -0,0 +1,16 @@
+import { createHash } from "crypto";
+import { readFileSync } from "fs";
+export const fileHash = (path, logger, algo = "sha256") => {
+    const sum = createHash(algo);
+    sum.update(readFileSync(path));
+    const hash = sum.digest("hex");
+    logger && logger.info(`${algo} hash for ${path}: ${hash}`);
+    return hash;
+};
+export const stringHash = (src, logger, algo = "sha256") => {
+    const sum = createHash(algo);
+    sum.update(src);
+    const hash = sum.digest("hex");
+    logger && logger.info(`${algo} hash for string: ${hash}`);
+    return hash;
+};

package/index.d.ts

@@ -1,7 +1,11 @@
 export * from "./delete.js";
-export * from "./ensure-dir.js";
+export * from "./dir.js";
+export * from "./ext.js";
 export * from "./files.js";
+export * from "./hash.js";
 export * from "./json.js";
+export * from "./mask.js";
 export * from "./temp.js";
 export * from "./text.js";
+export * from "./write.js";
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -1,6 +1,10 @@
 export * from "./delete.js";
-export * from "./ensure-dir.js";
+export * from "./dir.js";
+export * from "./ext.js";
 export * from "./files.js";
+export * from "./hash.js";
 export * from "./json.js";
+export * from "./mask.js";
 export * from "./temp.js";
 export * from "./text.js";
+export * from "./write.js";

package/json.d.ts

@@ -1,5 +1,20 @@
 import type { Fn3, NumOrString } from "@thi.ng/api";
 import type { ILogger } from "@thi.ng/logger";
 export declare const readJSON: (path: string, logger?: ILogger | undefined) => any;
-export declare const writeJSON: (path: string, obj: any, replacer?: Fn3<any, string, any, any> | NumOrString[] | null | undefined, space?: NumOrString | undefined, logger?: ILogger | undefined) => void;
+/**
+ * Serializes `obj` to JSON and writes result to UTF-8 file `path`. See
+ * {@link writeText} for more details.
+ *
+ * @remarks
+ * The `replacer` and `space` args are the same as supported by
+ * `JSON.stringify()`.
+ *
+ * @param path
+ * @param obj
+ * @param replacer
+ * @param space
+ * @param logger
+ * @param dryRun
+ */
+export declare const writeJSON: (path: string, obj: any, replacer?: Fn3<any, string, any, any> | NumOrString[] | null | undefined, space?: NumOrString | undefined, logger?: ILogger | undefined, dryRun?: boolean) => void;
 //# sourceMappingURL=json.d.ts.map

package/json.js

@@ -1,3 +1,18 @@
 import { readText, writeText } from "./text.js";
 export const readJSON = (path, logger) => JSON.parse(readText(path, logger));
-export const writeJSON = (path, obj, replacer, space, logger) => writeText(path, JSON.stringify(obj, replacer, space), logger);
+/**
+ * Serializes `obj` to JSON and writes result to UTF-8 file `path`. See
+ * {@link writeText} for more details.
+ *
+ * @remarks
+ * The `replacer` and `space` args are the same as supported by
+ * `JSON.stringify()`.
+ *
+ * @param path
+ * @param obj
+ * @param replacer
+ * @param space
+ * @param logger
+ * @param dryRun
+ */
+export const writeJSON = (path, obj, replacer, space, logger, dryRun = false) => writeText(path, JSON.stringify(obj, replacer, space) + "\n", logger, dryRun);

package/mask.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Replaces `home` (default: `process.env.HOME`) sub-path with given `mask`
+ * (default: `~`).
+ *
+ * @param path
+ * @param home
+ */
+export declare const maskHomeDir: (path: string, home?: string | undefined, mask?: string) => string;
+//# sourceMappingURL=mask.d.ts.map

package/mask.js

@@ -0,0 +1,8 @@
+/**
+ * Replaces `home` (default: `process.env.HOME`) sub-path with given `mask`
+ * (default: `~`).
+ *
+ * @param path
+ * @param home
+ */
+export const maskHomeDir = (path, home = process.env.HOME, mask = "~") => (home ? path.replace(home, mask) : path);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/file-io",
-  "version": "0.1.0",
+  "version": "0.3.1",
   "description": "Assorted file I/O utils (with logging support) for NodeJS",
   "type": "module",
   "module": "./index.js",
@@ -37,11 +37,11 @@
     "@thi.ng/api": "^8.3.6",
     "@thi.ng/checks": "^3.1.6",
     "@thi.ng/logger": "^1.1.6",
-    "@thi.ng/random": "^3.2.6"
+    "@thi.ng/random": "^3.3.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.23.1",
-    "@thi.ng/testament": "^0.2.6",
+    "@thi.ng/testament": "^0.2.7",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
     "typedoc": "^0.22.15",
@@ -49,6 +49,9 @@
   },
   "keywords": [
     "file",
+    "hash",
+    "json",
+    "logger",
     "node-only",
     "typescript"
   ],
@@ -73,25 +76,37 @@
     "./delete": {
       "default": "./delete.js"
     },
-    "./ensure-dir": {
-      "default": "./ensure-dir.js"
+    "./dir": {
+      "default": "./dir.js"
+    },
+    "./ext": {
+      "default": "./ext.js"
     },
     "./files": {
       "default": "./files.js"
     },
+    "./hash": {
+      "default": "./hash.js"
+    },
     "./json": {
       "default": "./json.js"
     },
+    "./mask": {
+      "default": "./mask.js"
+    },
     "./temp": {
       "default": "./temp.js"
     },
     "./text": {
       "default": "./text.js"
+    },
+    "./write": {
+      "default": "./write.js"
     }
   },
   "thi.ng": {
     "status": "stable",
     "year": 2022
   },
-  "gitHead": "f696c94665a3adef4fa475d99dd2e18ceb15863f\n"
+  "gitHead": "e23901b8582af71d8a29e0ce4929f15ac509f9e5\n"
 }

package/temp.js

@@ -3,7 +3,7 @@ import { randomID } from "@thi.ng/random/random-id";
 import { realpathSync, writeFileSync } from "fs";
 import { tmpdir } from "os";
 import { sep } from "path";
-import { ensureDirForFile } from "./ensure-dir.js";
+import { ensureDirForFile } from "./dir.js";
 export const createTempFile = (body, logger, name) => {
     const path = tempFilePath(name);
     logger && logger.debug("creating temp file:", path);

package/text.d.ts

@@ -1,4 +1,14 @@
 import type { ILogger } from "@thi.ng/logger";
 export declare const readText: (path: string, logger?: ILogger | undefined) => string;
-export declare const writeText: (path: string, body: string | string[], logger?: ILogger | undefined) => void;
+/**
+ * Writes `body` as UTF-8 file to given `path`. If `dryRun` is true (default:
+ * false), the file WON'T be written, however if a `logger` is provided then at
+ * least a dry-run log message will be emitted.
+ *
+ * @param path
+ * @param body
+ * @param logger
+ * @param dryRun
+ */
+export declare const writeText: (path: string, body: string | string[], logger?: ILogger | undefined, dryRun?: boolean) => void;
 //# sourceMappingURL=text.d.ts.map

package/text.js

@@ -1,12 +1,18 @@
 import { isArray } from "@thi.ng/checks/is-array";
-import { readFileSync, writeFileSync } from "fs";
-import { ensureDirForFile } from "./ensure-dir.js";
+import { readFileSync } from "fs";
+import { writeFile } from "./write.js";
 export const readText = (path, logger) => {
     logger && logger.debug("reading file:", path);
     return readFileSync(path, "utf-8");
 };
-export const writeText = (path, body, logger) => {
-    logger && logger.debug("writing file:", path);
-    ensureDirForFile(path);
-    writeFileSync(path, isArray(body) ? body.join("\n") : body, "utf-8");
-};
+/**
+ * Writes `body` as UTF-8 file to given `path`. If `dryRun` is true (default:
+ * false), the file WON'T be written, however if a `logger` is provided then at
+ * least a dry-run log message will be emitted.
+ *
+ * @param path
+ * @param body
+ * @param logger
+ * @param dryRun
+ */
+export const writeText = (path, body, logger, dryRun = false) => writeFile(path, isArray(body) ? body.join("\n") : body, "utf-8", logger, dryRun);

package/write.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+import type { TypedArray } from "@thi.ng/api";
+import type { ILogger } from "@thi.ng/logger";
+import { WriteFileOptions } from "fs";
+/**
+ * Writes `body` as to given `path` (using optional `opts` to define encoding).
+ * If `dryRun` is true (default: false), the file WON'T be written, however if a
+ * `logger` is provided then at least a dry-run log message will be emitted.
+ *
+ * @param path
+ * @param body
+ * @param opts
+ * @param logger
+ * @param dryRun
+ */
+export declare const writeFile: (path: string, body: string | TypedArray, opts?: WriteFileOptions | undefined, logger?: ILogger | undefined, dryRun?: boolean) => void;
+//# sourceMappingURL=write.d.ts.map

package/write.js

@@ -0,0 +1,21 @@
+import { isString } from "@thi.ng/checks/is-string";
+import { writeFileSync } from "fs";
+import { ensureDirForFile } from "./dir.js";
+/**
+ * Writes `body` as to given `path` (using optional `opts` to define encoding).
+ * If `dryRun` is true (default: false), the file WON'T be written, however if a
+ * `logger` is provided then at least a dry-run log message will be emitted.
+ *
+ * @param path
+ * @param body
+ * @param opts
+ * @param logger
+ * @param dryRun
+ */
+export const writeFile = (path, body, opts, logger, dryRun = false) => {
+    logger && logger.info(`${dryRun ? "[dryrun] " : ""}writing file: ${path}`);
+    if (dryRun)
+        return;
+    ensureDirForFile(path);
+    writeFileSync(path, body, !opts && isString(body) ? "utf-8" : opts);
+};

package/ensure-dir.d.ts

@@ -1,8 +0,0 @@
-/**
- * Checks if the directory for given file path already exists, and if not the
- * case, creates it. Returns true if the latter case.
- *
- * @param path
- */
-export declare const ensureDirForFile: (path: string) => boolean;
-//# sourceMappingURL=ensure-dir.d.ts.map

package/ensure-dir.js

@@ -1,14 +0,0 @@
-import { existsSync, mkdirSync } from "fs";
-import { sep } from "path";
-/**
- * Checks if the directory for given file path already exists, and if not the
- * case, creates it. Returns true if the latter case.
- *
- * @param path
- */
-export const ensureDirForFile = (path) => {
-    const dir = path.substring(0, path.lastIndexOf(sep));
-    return !existsSync(dir)
-        ? (mkdirSync(dir, { recursive: true }), true)
-        : false;
-};