@thi.ng/file-io 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-05-18T12:59:20Z
+- **Last updated**: 2022-05-19T13:17:54Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ 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.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/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

@@ -5,27 +5,32 @@ import { sep } from "path";
  * 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 (statSync(curr).isDirectory()) {
                 yield* __files(curr, match, logger, maxDepth, depth + 1);
             }
+            else if (re.test(f)) {
+                yield curr;
+            }
         }
         catch (e) {
             logger &&
@@ -33,3 +38,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/index.d.ts

@@ -4,4 +4,5 @@ export * from "./files.js";
 export * from "./json.js";
 export * from "./temp.js";
 export * from "./text.js";
+export * from "./write.js";
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -4,3 +4,4 @@ export * from "./files.js";
 export * from "./json.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/file-io",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Assorted file I/O utils (with logging support) for NodeJS",
   "type": "module",
   "module": "./index.js",
@@ -87,11 +87,14 @@
     },
     "./text": {
       "default": "./text.js"
+    },
+    "./write": {
+      "default": "./write.js"
     }
   },
   "thi.ng": {
     "status": "stable",
     "year": 2022
   },
-  "gitHead": "f696c94665a3adef4fa475d99dd2e18ceb15863f\n"
+  "gitHead": "ec1685021284dc0e98bbfe67abefc3d1f6c0f7dd\n"
 }

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 "./ensure-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);
+};