rrdir 12.0.3 → 13.0.0

package/README.md

@@ -5,6 +5,8 @@
 
 `rrdir` recursively reads a directory and returns entries within via an async iterator or async/sync as Array. It can typically iterate millions of files in a matter of seconds. Memory usage is `O(1)` for the async iterator and `O(n)` for the Array variants.
 
+Contrary to other similar modules, this module is optionally able to read any path including ones that contain invalid UTF-8 sequences.
+
 ## Usage
 ```console
 npm i rrdir
@@ -31,9 +33,9 @@ const entries = rrdirSync("dir");
 
 `rrdir` is an async iterator which yields `entry`. `rrdirAsync` and `rrdirSync` return an Array of `entry`.
 
-#### `dir` *String* | *Buffer*
+#### `dir` *String* | *Uint8Array*
 
-The directory to read, either absolute or relative. Pass a `Buffer` to switch the module into `Buffer` mode which is required to be able to read every file, like for example files with names that are invalid UTF-8 sequences.
+The directory to read, either absolute or relative. Pass a `Uint8Array` to switch the module into `Uint8Array` mode which is required to be able to read every file, like for example files with names that are invalid UTF-8 sequences.
 
 #### `options` *Object*
 
@@ -46,7 +48,7 @@ The directory to read, either absolute or relative. Pass a `Buffer` to switch th
 
 #### `entry` *Object*
 
-- `path` *string* | *Buffer*: The path to the entry, will be relative if `dir` is given relative. If `dir` is a `Buffer`, this will be too. Always present.
+- `path` *string* | *Uint8Array*: The path to the entry, will be relative if `dir` is given relative. If `dir` is a `Uint8Array`, this will be too. Always present.
 - `directory` *boolean*: Boolean indicating whether the entry is a directory. `undefined` on error.
 - `symlink` *boolean*: Boolean indicating whether the entry is a symbolic link. `undefined` on error.
 - `stats` *Object*: A [`fs.stats`](https://nodejs.org/api/fs.html#fs_class_fs_stats) object, present when `options.stats` is set. `undefined` on error.

package/index.js

@@ -3,7 +3,11 @@ import {readdirSync, statSync, lstatSync} from "node:fs";
 import {sep, resolve} from "node:path";
 import picomatch from "picomatch";
 
-const sepBuffer = Buffer.from(sep);
+const encoder = new TextEncoder();
+const toUint8Array = encoder.encode.bind(encoder);
+const decoder = new TextDecoder();
+const toString = decoder.decode.bind(decoder);
+const sepUint8Array = toUint8Array(sep);
 
 const defaults = {
   strict: false,
@@ -16,7 +20,7 @@ const defaults = {
 
 function makePath(entry, dir, encoding) {
   if (encoding === "buffer") {
-    return dir === "." ? entry.name : Buffer.from([...dir, ...sepBuffer, ...entry.name]);
+    return dir === "." ? entry.name : Uint8Array.from([...dir, ...sepUint8Array, ...entry.name]);
   } else {
     return dir === "." ? entry.name : `${dir}${sep}${entry.name}`;
   }
@@ -51,7 +55,7 @@ export async function* rrdir(dir, opts = {}, {includeMatcher, excludeMatcher, en
     opts = {...defaults, ...opts};
     ({includeMatcher, excludeMatcher} = makeMatchers(opts));
     if (/[/\\]$/.test(dir)) dir = dir.substring(0, dir.length - 1);
-    encoding = Buffer.isBuffer(dir) ? "buffer" : undefined;
+    encoding = dir instanceof Uint8Array ? "buffer" : undefined;
   }
 
   let dirents = [];
@@ -65,10 +69,10 @@ export async function* rrdir(dir, opts = {}, {includeMatcher, excludeMatcher, en
 
   for (const dirent of dirents) {
     const path = makePath(dirent, dir, encoding);
-    if (excludeMatcher?.(encoding === "buffer" ? String(path) : path)) continue;
+    if (excludeMatcher?.(encoding === "buffer" ? toString(path) : path)) continue;
 
     const isSymbolicLink = opts.followSymlinks && dirent.isSymbolicLink();
-    const encodedPath = encoding === "buffer" ? String(path) : path;
+    const encodedPath = encoding === "buffer" ? toString(path) : path;
     const isIncluded = !includeMatcher || includeMatcher(encodedPath);
     let stats;
 
@@ -102,7 +106,7 @@ export async function rrdirAsync(dir, opts = {}, {includeMatcher, excludeMatcher
     opts = {...defaults, ...opts};
     ({includeMatcher, excludeMatcher} = makeMatchers(opts));
     if (/[/\\]$/.test(dir)) dir = dir.substring(0, dir.length - 1);
-    encoding = Buffer.isBuffer(dir) ? "buffer" : undefined;
+    encoding = dir instanceof Uint8Array ? "buffer" : undefined;
   }
 
   const results = [];
@@ -117,10 +121,10 @@ export async function rrdirAsync(dir, opts = {}, {includeMatcher, excludeMatcher
 
   await Promise.all(dirents.map(async dirent => {
     const path = makePath(dirent, dir, encoding);
-    if (excludeMatcher?.(encoding === "buffer" ? String(path) : path)) return;
+    if (excludeMatcher?.(encoding === "buffer" ? toString(path) : path)) return;
 
     const isSymbolicLink = opts.followSymlinks && dirent.isSymbolicLink();
-    const encodedPath = encoding === "buffer" ? String(path) : path;
+    const encodedPath = encoding === "buffer" ? toString(path) : path;
     const isIncluded = !includeMatcher || includeMatcher(encodedPath);
     let stats;
 
@@ -156,7 +160,7 @@ export function rrdirSync(dir, opts = {}, {includeMatcher, excludeMatcher, encod
     opts = {...defaults, ...opts};
     ({includeMatcher, excludeMatcher} = makeMatchers(opts));
     if (/[/\\]$/.test(dir)) dir = dir.substring(0, dir.length - 1);
-    encoding = Buffer.isBuffer(dir) ? "buffer" : undefined;
+    encoding = dir instanceof Uint8Array ? "buffer" : undefined;
   }
 
   const results = [];
@@ -171,10 +175,10 @@ export function rrdirSync(dir, opts = {}, {includeMatcher, excludeMatcher, encod
 
   for (const dirent of dirents) {
     const path = makePath(dirent, dir, encoding);
-    if (excludeMatcher?.(encoding === "buffer" ? String(path) : path)) continue;
+    if (excludeMatcher?.(encoding === "buffer" ? toString(path) : path)) continue;
 
     const isSymbolicLink = opts.followSymlinks && dirent.isSymbolicLink();
-    const encodedPath = encoding === "buffer" ? String(path) : path;
+    const encodedPath = encoding === "buffer" ? toString(path) : path;
     const isIncluded = !includeMatcher || includeMatcher(encodedPath);
     let stats;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rrdir",
-  "version": "12.0.3",
+  "version": "13.0.0",
   "description": "Recursive directory reader with a delightful API",
   "author": "silverwind <me@silverwind.io>",
   "repository": "silverwind/rrdir",
@@ -12,17 +12,17 @@
     "node": ">=18"
   },
   "files": [
-    "./index.js"
+    "index.js"
   ],
   "devDependencies": {
-    "eslint": "8.52.0",
-    "eslint-config-silverwind": "79.0.4",
-    "updates": "15.0.3",
-    "versions": "12.0.0",
-    "vitest": "0.34.6",
-    "vitest-config-silverwind": "3.0.0"
+    "eslint": "8.57.0",
+    "eslint-config-silverwind": "80.0.5",
+    "updates": "15.1.2",
+    "versions": "12.0.1",
+    "vitest": "1.3.1",
+    "vitest-config-silverwind": "5.1.1"
   },
   "dependencies": {
-    "picomatch": "2.3.1"
+    "picomatch": "4.0.1"
   }
 }