@thi.ng/file-io 1.1.4 → 1.2.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-12-31T09:44:23Z
+- **Last updated**: 2024-01-26T18:03:04Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,16 @@ 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.
 
+## [1.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/file-io@1.2.0) (2024-01-26)
+
+#### 🚀 Features
+
+- add fileWatcher() ([71c1d8f](https://github.com/thi-ng/umbrella/commit/71c1d8f))
+
+#### ♻️ Refactoring
+
+- migrate internal predicates ([52c985a](https://github.com/thi-ng/umbrella/commit/52c985a))
+
 ## [1.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/file-io@1.1.0) (2023-12-18)
 
 #### 🚀 Features

package/README.md

@@ -45,7 +45,7 @@ For Node.js REPL:
 const fileIo = await import("@thi.ng/file-io");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.30 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.98 KB
 
 ## Dependencies
 
@@ -78,4 +78,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2022 - 2023 Karsten Schmidt // Apache License 2.0
+© 2022 - 2024 Karsten Schmidt // Apache License 2.0

package/files.js

@@ -1,8 +1,7 @@
-import { isFunction } from "@thi.ng/checks/is-function";
-import { isString } from "@thi.ng/checks/is-string";
 import { readdirSync, statSync } from "fs";
 import { sep } from "path";
 import { isDirectory } from "./dir.js";
+import { __ensurePred } from "./internal/ensure.js";
 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)
@@ -39,8 +38,6 @@ function* __dirs(dir, match = "", logger, maxDepth = Infinity, depth = 0) {
     }
   }
 }
-const __ensureRegEx = (match) => isString(match) ? new RegExp(`${match.replace(/\./g, "\\.")}$`) : match;
-const __ensurePred = (match) => isFunction(match) ? match : (match = __ensureRegEx(match), (x) => match.test(x));
 export {
   dirs,
   files

package/index.d.ts

@@ -9,5 +9,6 @@ export * from "./mask.js";
 export * from "./read.js";
 export * from "./temp.js";
 export * from "./text.js";
+export * from "./watch.js";
 export * from "./write.js";
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -9,4 +9,5 @@ export * from "./mask.js";
 export * from "./read.js";
 export * from "./temp.js";
 export * from "./text.js";
+export * from "./watch.js";
 export * from "./write.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/file-io",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "description": "Assorted file I/O utils (with logging support) for NodeJS",
   "type": "module",
   "module": "./index.js",
@@ -35,11 +35,11 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.16",
-    "@thi.ng/checks": "^3.4.16",
-    "@thi.ng/hex": "^2.3.28",
-    "@thi.ng/logger": "^2.1.3",
-    "@thi.ng/random": "^3.6.23"
+    "@thi.ng/api": "^8.9.18",
+    "@thi.ng/checks": "^3.4.18",
+    "@thi.ng/hex": "^2.3.30",
+    "@thi.ng/logger": "^2.1.4",
+    "@thi.ng/random": "^3.6.25"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.39.0",
@@ -108,6 +108,9 @@
     "./text": {
       "default": "./text.js"
     },
+    "./watch": {
+      "default": "./watch.js"
+    },
     "./write": {
       "default": "./write.js"
     }
@@ -116,5 +119,5 @@
     "status": "stable",
     "year": 2022
   },
-  "gitHead": "b3db173682e1148cf08a6bd907b8d90b47b7c066\n"
+  "gitHead": "7426e2ae6fca5482c6eaf649872296fc89955374\n"
 }

package/watch.d.ts

@@ -0,0 +1,41 @@
+/// <reference types="node" />
+import { type Event, type IClear, type INotify, type IObjectOf, type Listener, type Predicate } from "@thi.ng/api";
+import type { ILogger } from "@thi.ng/logger";
+import { type FSWatcher } from "fs";
+export interface WatcherOpts {
+    /**
+     * Number of milliseconds between observing a file change and notifying
+     * attached listeners.
+     *
+     * @defaultValue 100
+     */
+    delay: number;
+    /**
+     * Logger instance for showing debug info (must have DEBUG level enabled)
+     */
+    logger: ILogger;
+}
+export interface PathWatchOpts {
+    recursive: boolean;
+    ext: string | RegExp | Predicate<string>;
+}
+export declare const EVENT_ADDED = "added";
+export declare const EVENT_CHANGED = "changed";
+export declare const EVENT_REMOVED = "removed";
+export declare class Watcher implements IClear, INotify {
+    watchers: IObjectOf<FSWatcher>;
+    opts: WatcherOpts;
+    protected _signal: boolean;
+    constructor(opts?: Partial<WatcherOpts>);
+    addAll(paths: (string | [string, Partial<PathWatchOpts>])[]): void;
+    add(path: string, opts?: Partial<PathWatchOpts>): boolean;
+    remove(path: string): boolean;
+    removeAll(paths: Iterable<string>): void;
+    clear(): void;
+    installSignalHandler(): void;
+    addListener(id: string, fn: Listener<string>, scope?: any): boolean;
+    removeListener(id: string, fn: Listener<string>, scope?: any): boolean;
+    notify(event: Event<string>): boolean;
+}
+export declare const fileWatcher: (opts?: Partial<WatcherOpts>) => Watcher;
+//# sourceMappingURL=watch.d.ts.map

package/watch.js

@@ -0,0 +1,119 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result)
+    __defProp(target, key, result);
+  return result;
+};
+import {
+  INotifyMixin
+} from "@thi.ng/api";
+import { isString } from "@thi.ng/checks/is-string";
+import { NULL_LOGGER } from "@thi.ng/logger/null";
+import { watch as $watch, existsSync } from "fs";
+import { join } from "path";
+import { isDirectory } from "./dir.js";
+import { __ensurePred } from "./internal/ensure.js";
+const EVENT_ADDED = "added";
+const EVENT_CHANGED = "changed";
+const EVENT_REMOVED = "removed";
+let Watcher = class {
+  watchers = {};
+  opts;
+  _signal = false;
+  constructor(opts) {
+    this.opts = {
+      logger: NULL_LOGGER,
+      delay: 100,
+      ...opts
+    };
+  }
+  addAll(paths) {
+    for (let p of paths) {
+      isString(p) ? this.add(p) : this.add(...p);
+    }
+  }
+  add(path, opts) {
+    if (this.watchers[path])
+      return false;
+    const isDir = isDirectory(path);
+    const pred = __ensurePred(opts?.ext || "");
+    this.opts.logger.debug(`adding watcher for: ${path}`);
+    this.watchers[path] = $watch(
+      path,
+      { recursive: opts?.recursive !== false },
+      (event, currPath) => {
+        if (!currPath)
+          return;
+        currPath = isDir ? join(path, currPath) : path;
+        if (!pred(currPath))
+          return;
+        setTimeout(() => {
+          if (event === "change") {
+            this.opts.logger.info(`file changed: ${currPath}`);
+            this.notify({
+              id: EVENT_CHANGED,
+              value: currPath
+            });
+          } else if (!isDir || path === currPath) {
+            this.opts.logger.info(`file removed: ${path}`);
+            this.notify({ id: EVENT_REMOVED, value: path });
+            this.remove(path);
+          } else {
+            const id = existsSync(currPath) ? EVENT_ADDED : EVENT_REMOVED;
+            this.opts.logger.info(`file ${id}: ${path}`);
+            this.notify({ id, value: currPath });
+          }
+        }, this.opts.delay);
+      }
+    );
+    return true;
+  }
+  remove(path) {
+    const watcher = this.watchers[path];
+    if (!watcher)
+      return false;
+    this.opts.logger.debug(`removing watcher for: ${path}`);
+    watcher.close();
+    delete this.watchers[path];
+    return true;
+  }
+  removeAll(paths) {
+    for (let p of paths) {
+      this.remove(p);
+    }
+  }
+  clear() {
+    this.removeAll(Object.keys(this.watchers));
+  }
+  installSignalHandler() {
+    if (!this._signal) {
+      process.on("SIGINT", () => this.clear());
+      this._signal = true;
+    }
+  }
+  // @ts-ignore mixin
+  addListener(id, fn, scope) {
+  }
+  // @ts-ignore mixin
+  removeListener(id, fn, scope) {
+  }
+  // @ts-ignore mixin
+  notify(event) {
+  }
+};
+Watcher = __decorateClass([
+  INotifyMixin
+], Watcher);
+const fileWatcher = (opts) => new Watcher(opts);
+export {
+  EVENT_ADDED,
+  EVENT_CHANGED,
+  EVENT_REMOVED,
+  Watcher,
+  fileWatcher
+};