@thi.ng/file-io 0.5.28 → 1.0.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-10-23T07:37:37Z
+- **Last updated**: 2023-11-24T09:35:46Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,18 @@ 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.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/file-io@1.0.0) (2023-11-09)
+
+#### 🛑 Breaking changes
+
+- update matching logic for files()/dirs() ([8f275b5](https://github.com/thi-ng/umbrella/commit/8f275b5))
+- BREAKING CHANGE: files()/dirs() matchers use full relative sub-path
+  - add support for arbitrary predicate fns as matcher
+
+#### ♻️ Refactoring
+
+- update all tests (packages A-S) ([e3085e4](https://github.com/thi-ng/umbrella/commit/e3085e4))
+
 ## [0.5.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/file-io@0.5.0) (2023-02-05)
 
 #### 🚀 Features

package/README.md

@@ -44,7 +44,7 @@ For Node.js REPL:
 const fileIo = await import("@thi.ng/file-io");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.25 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.30 KB
 
 ## Dependencies
 

package/files.d.ts

@@ -1,11 +1,14 @@
+import type { Predicate } from "@thi.ng/api";
 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).
+ * and yields sequence of file names matching given extension (or regexp or
+ * predicate).
  *
  * @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`).
+ * Files will be matched using their _full_ relative sub-path (starting with
+ * given `dir`). If NO `match` is given, all files will be matched. Directories
+ * 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.
@@ -15,13 +18,13 @@ import type { ILogger } from "@thi.ng/logger";
  * @param maxDepth
  * @param logger
  */
-export declare const files: (dir: string, match?: string | RegExp, maxDepth?: number, logger?: ILogger) => IterableIterator<string>;
+export declare const files: (dir: string, match?: string | RegExp | Predicate<string>, maxDepth?: number, logger?: ILogger) => 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
+ * Like the matcher in {@link files}, the regex or predicate will be applied to
  * the _full_ sub-path (starting with `dir`) in order to determine a match.
  *
  * @param dir
@@ -29,5 +32,5 @@ export declare const files: (dir: string, match?: string | RegExp, maxDepth?: nu
  * @param maxDepth
  * @param logger
  */
-export declare const dirs: (dir: string, match?: string | RegExp, maxDepth?: number, logger?: ILogger) => IterableIterator<string>;
+export declare const dirs: (dir: string, match?: string | RegExp | Predicate<string>, maxDepth?: number, logger?: ILogger) => IterableIterator<string>;
 //# sourceMappingURL=files.d.ts.map

package/files.js

@@ -1,14 +1,17 @@
+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";
 /**
  * Recursively reads given directory (up to given max. depth, default: infinite)
- * and yields sequence of file names matching given extension (or regexp).
+ * and yields sequence of file names matching given extension (or regexp or
+ * predicate).
  *
  * @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`).
+ * Files will be matched using their _full_ relative sub-path (starting with
+ * given `dir`). If NO `match` is given, all files will be matched. Directories
+ * 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.
@@ -22,14 +25,14 @@ export const files = (dir, match = "", maxDepth = Infinity, logger) => __files(d
 function* __files(dir, match = "", logger, maxDepth = Infinity, depth = 0) {
     if (depth >= maxDepth)
         return;
-    const re = __ensureRegEx(match);
-    for (let f of readdirSync(dir)) {
+    const pred = __ensurePred(match);
+    for (let f of readdirSync(dir).sort()) {
         const curr = dir + sep + f;
         try {
             if (isDirectory(curr)) {
                 yield* __files(curr, match, logger, maxDepth, depth + 1);
             }
-            else if (re.test(f)) {
+            else if (pred(curr)) {
                 yield curr;
             }
         }
@@ -44,7 +47,7 @@ function* __files(dir, match = "", logger, maxDepth = Infinity, depth = 0) {
  * 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
+ * Like the matcher in {@link files}, the regex or predicate will be applied to
  * the _full_ sub-path (starting with `dir`) in order to determine a match.
  *
  * @param dir
@@ -56,12 +59,12 @@ export const dirs = (dir, match = "", maxDepth = Infinity, logger) => __dirs(dir
 function* __dirs(dir, match = "", logger, maxDepth = Infinity, depth = 0) {
     if (depth >= maxDepth)
         return;
-    const re = __ensureRegEx(match);
-    for (let f of readdirSync(dir)) {
+    const pred = __ensurePred(match);
+    for (let f of readdirSync(dir).sort()) {
         const curr = dir + sep + f;
         try {
             if (statSync(curr).isDirectory()) {
-                if (re.test(curr))
+                if (pred(curr))
                     yield curr;
                 yield* __dirs(curr, match, logger, maxDepth, depth + 1);
             }
@@ -74,3 +77,7 @@ function* __dirs(dir, match = "", logger, maxDepth = Infinity, depth = 0) {
 }
 /** @internal */
 const __ensureRegEx = (match) => isString(match) ? new RegExp(`${match.replace(/\./g, "\\.")}$`) : match;
+const __ensurePred = (match) => isFunction(match)
+    ? match
+    : ((match = __ensureRegEx(match)),
+        (x) => match.test(x));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/file-io",
-  "version": "0.5.28",
+  "version": "1.0.2",
   "description": "Assorted file I/O utils (with logging support) for NodeJS",
   "type": "module",
   "module": "./index.js",
@@ -28,25 +28,24 @@
     "clean": "rimraf --glob '*.js' '*.d.ts' '*.map' doc",
     "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
-    "doc:readme": "yarn doc:stats && tools:readme",
-    "doc:stats": "tools:module-stats",
+    "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
     "pub": "yarn npm publish --access public",
-    "test": "testament test"
+    "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.6",
-    "@thi.ng/checks": "^3.4.6",
-    "@thi.ng/hex": "^2.3.18",
-    "@thi.ng/logger": "^1.4.22",
-    "@thi.ng/random": "^3.6.12"
+    "@thi.ng/api": "^8.9.9",
+    "@thi.ng/checks": "^3.4.9",
+    "@thi.ng/hex": "^2.3.21",
+    "@thi.ng/logger": "^2.0.0",
+    "@thi.ng/random": "^3.6.15"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.38.0",
-    "@thi.ng/testament": "^0.3.24",
+    "@microsoft/api-extractor": "^7.38.3",
+    "@thi.ng/testament": "^0.4.2",
     "rimraf": "^5.0.5",
     "tools": "^0.0.1",
-    "typedoc": "^0.25.2",
-    "typescript": "^5.2.2"
+    "typedoc": "^0.25.3",
+    "typescript": "^5.3.2"
   },
   "keywords": [
     "file",
@@ -116,5 +115,5 @@
     "status": "stable",
     "year": 2022
   },
-  "gitHead": "336bd1bf95825b3c318a3ab49c54451c94aaa883\n"
+  "gitHead": "f6de41f4991704fdbbb2899bb430ed4f4f6efab0\n"
 }

package/write.d.ts

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