@thi.ng/file-io 2.1.1 → 2.1.3

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-04-25T19:44:55Z
+- **Last updated**: 2024-06-21T19:34:38Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 192 standalone projects, maintained as part
+> This is one of 193 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -54,7 +54,7 @@ For Node.js REPL:
 const fio = await import("@thi.ng/file-io");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 2.06 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 2.05 KB
 
 ## Dependencies
 

package/delete.js

@@ -1,14 +1,12 @@
 import { rmSync, unlinkSync } from "node:fs";
 const deleteFile = (path, logger, dryRun = false) => {
   logger && logger.info(`${dryRun ? "[dryrun] " : ""}deleting file: ${path}`);
-  if (dryRun)
-    return;
+  if (dryRun) return;
   unlinkSync(path);
 };
 const deleteDir = (path, logger, dryRun = false) => {
   logger && logger.info(`${dryRun ? "[dryrun] " : ""}deleting file: ${path}`);
-  if (dryRun)
-    return;
+  if (dryRun) return;
   rmSync(path, { recursive: true, force: true });
 };
 export {

package/file-chunks.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { ILogger } from "@thi.ng/logger";
 export interface FileChunkOpts {
     /**

package/file-chunks.js

@@ -17,11 +17,9 @@ async function* fileChunks(path, opts = {}) {
         length: size,
         position: start
       });
-      if (bytesRead === 0)
-        break;
+      if (bytesRead === 0) break;
       yield buffer;
-      if (bytesRead < size)
-        break;
+      if (bytesRead < size) break;
       start += bytesRead;
     }
   } finally {

package/files.js

@@ -1,11 +1,10 @@
-import { readdirSync, statSync } from "node:fs";
+import { readdirSync } from "node:fs";
 import { sep } from "node: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)
-    return;
+  if (depth >= maxDepth) return;
   const pred = __ensurePred(match);
   for (let f of readdirSync(dir).sort()) {
     const curr = dir + sep + f;
@@ -22,15 +21,13 @@ function* __files(dir, match = "", logger, maxDepth = Infinity, depth = 0) {
 }
 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;
+  if (depth >= maxDepth) return;
   const pred = __ensurePred(match);
   for (let f of readdirSync(dir).sort()) {
     const curr = dir + sep + f;
     try {
-      if (statSync(curr).isDirectory()) {
-        if (pred(curr))
-          yield curr;
+      if (isDirectory(curr)) {
+        if (pred(curr)) yield curr;
         yield* __dirs(curr, match, logger, maxDepth, depth + 1);
       }
     } catch (e) {

package/hash.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import type { TypedArray } from "@thi.ng/api";
 import type { ILogger } from "@thi.ng/logger";
 import type { Readable } from "node:stream";
@@ -18,7 +16,7 @@ export declare const fileHash: (path: string, logger?: ILogger, algo?: HashAlgo)
  * "sha256"). If `logger` is given, the hash will be logged too.
  *
  * @remarks
- * Also see {@link fileHash} and {@link stringHash}.
+ * Also see {@link fileHash} and {@link bufferHash}.
  *
  * @param src
  * @param logger

package/hash.js

@@ -6,8 +6,7 @@ const fileHash = async (path, logger, algo = "sha256") => {
 };
 const streamHash = async (src, logger, algo = "sha256") => {
   const sum = createHash(algo);
-  for await (let chunk of src)
-    sum.update(chunk);
+  for await (let chunk of src) sum.update(chunk);
   const hash = sum.digest("hex");
   logger && logger.info(`${algo} hash: ${hash}`);
   return hash;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/file-io",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "description": "Assorted file I/O utils (with logging support) for NodeJS/Bun",
   "type": "module",
   "module": "./index.js",
@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/thi-ng/umbrella.git"
   },
-  "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/file-io#readme",
+  "homepage": "https://thi.ng/file-io",
   "funding": [
     {
       "type": "github",
@@ -36,17 +36,17 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.1",
-    "@thi.ng/checks": "^3.6.3",
-    "@thi.ng/hex": "^2.3.45",
-    "@thi.ng/logger": "^3.0.11",
-    "@thi.ng/random": "^3.7.5"
+    "@thi.ng/api": "^8.11.3",
+    "@thi.ng/checks": "^3.6.5",
+    "@thi.ng/hex": "^2.3.47",
+    "@thi.ng/logger": "^3.0.13",
+    "@thi.ng/random": "^3.8.1"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.43.0",
-    "esbuild": "^0.20.2",
-    "typedoc": "^0.25.12",
-    "typescript": "^5.4.3"
+    "@microsoft/api-extractor": "^7.47.0",
+    "esbuild": "^0.21.5",
+    "typedoc": "^0.25.13",
+    "typescript": "^5.5.2"
   },
   "keywords": [
     "async",
@@ -123,5 +123,5 @@
     "status": "stable",
     "year": 2022
   },
-  "gitHead": "aed3421c21044c005fbcb7cc37965ccf85a870d2\n"
+  "gitHead": "154c95cf9d6bab32174498ec3b5b5d87e42be7f9\n"
 }

package/text.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { ILogger } from "@thi.ng/logger";
 /**
  * Reads text from given file `path`, optionally with custom encoding (default:

package/watch.d.ts

@@ -1,4 +1,3 @@
-/// <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 "node:fs";
@@ -16,7 +15,15 @@ export interface WatcherOpts {
     logger: ILogger;
 }
 export interface PathWatchOpts {
+    /**
+     * If enabled (default) and if the path refers to a directory, any file
+     * changes within that dir (or any subdir) will trigger an event.
+     */
     recursive: boolean;
+    /**
+     * File extension filter. If given, events are only triggered for paths
+     * matching this filter.
+     */
     ext: string | RegExp | Predicate<string>;
 }
 export declare const EVENT_ADDED = "added";

package/watch.js

@@ -5,8 +5,7 @@ var __decorateClass = (decorators, target, key, kind) => {
   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);
+  if (kind && result) __defProp(target, key, result);
   return result;
 };
 import {
@@ -38,8 +37,7 @@ let Watcher = class {
     }
   }
   add(path, opts) {
-    if (this.watchers[path])
-      return false;
+    if (this.watchers[path]) return false;
     const isDir = isDirectory(path);
     const pred = __ensurePred(opts?.ext || "");
     this.opts.logger.debug(`adding watcher for: ${path}`);
@@ -47,11 +45,9 @@ let Watcher = class {
       path,
       { recursive: opts?.recursive !== false },
       (event, currPath) => {
-        if (!currPath)
-          return;
+        if (!currPath) return;
         currPath = isDir ? join(path, currPath) : path;
-        if (!pred(currPath))
-          return;
+        if (!pred(currPath)) return;
         setTimeout(() => {
           if (event === "change") {
             this.opts.logger.info(`file changed: ${currPath}`);
@@ -75,8 +71,7 @@ let Watcher = class {
   }
   remove(path) {
     const watcher = this.watchers[path];
-    if (!watcher)
-      return false;
+    if (!watcher) return false;
     this.opts.logger.debug(`removing watcher for: ${path}`);
     watcher.close();
     delete this.watchers[path];

package/write.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { TypedArray } from "@thi.ng/api";
 import type { ILogger } from "@thi.ng/logger";
 import { type WriteFileOptions } from "node:fs";

package/write.js

@@ -3,8 +3,7 @@ import { writeFileSync } from "node:fs";
 import { ensureDirForFile } from "./dir.js";
 const writeFile = (path, body, opts, logger, dryRun = false) => {
   logger && logger.info(`${dryRun ? "[dryrun] " : ""}writing file: ${path}`);
-  if (dryRun)
-    return;
+  if (dryRun) return;
   ensureDirForFile(path);
   writeFileSync(path, body, !opts && isString(body) ? "utf-8" : opts);
 };