tiny-readdir 3.0.0 → 3.1.0

package/dist/index.js

@@ -11,7 +11,7 @@ const readdir = (rootPath, options) => {
     const maxPaths = options?.limit ?? Infinity;
     const ignore = options?.ignore ?? [];
     const ignores = castArray(ignore).map(ignore => isFunction(ignore) ? ignore : (targetPath) => ignore.test(targetPath));
-    const isIgnored = (targetPath) => ignores.some(ignore => ignore(targetPath));
+    const isIgnored = (targetPath, targetContext) => ignores.some(ignore => ignore(targetPath, targetContext));
     const signal = options?.signal ?? { aborted: false };
     const onDirents = options?.onDirents || (() => { });
     const directories = [];
@@ -64,7 +64,7 @@ const readdir = (rootPath, options) => {
     const handleStat = (rootPath, stat, depth) => {
         if (signal.aborted)
             return;
-        if (isIgnored(rootPath))
+        if (isIgnored(rootPath, stat))
             return;
         if (stat.isDirectory()) {
             handleDirectory(rootPath, depth);
@@ -82,7 +82,7 @@ const readdir = (rootPath, options) => {
         const separator = (rootPath === path.sep) ? '' : path.sep;
         const name = dirent.name;
         const subPath = `${rootPath}${separator}${name}`;
-        if (isIgnored(subPath))
+        if (isIgnored(subPath, dirent))
             return;
         if (dirent.isDirectory()) {
             handleDirectory(subPath, depth);

package/dist/types.d.ts

@@ -1,7 +1,7 @@
 type Callback = () => void;
 type ArrayMaybe<T> = T[] | T;
 type PromiseMaybe<T> = Promise<T> | T;
-type Dirent = {
+type DirentLike = {
     isFile: () => boolean;
     isDirectory: () => boolean;
     isBlockDevice: () => boolean;
@@ -9,6 +9,8 @@ type Dirent = {
     isSymbolicLink: () => boolean;
     isFIFO: () => boolean;
     isSocket: () => boolean;
+};
+type Dirent = DirentLike & {
     name: string;
     path: string;
 };
@@ -16,7 +18,7 @@ type Options = {
     depth?: number;
     limit?: number;
     followSymlinks?: boolean;
-    ignore?: ArrayMaybe<((targetPath: string) => boolean) | RegExp>;
+    ignore?: ArrayMaybe<((targetPath: string, targetContext: DirentLike) => boolean) | RegExp>;
     signal?: {
         aborted: boolean;
     };
@@ -27,4 +29,4 @@ type Result = {
     files: string[];
     symlinks: string[];
 };
-export type { Callback, PromiseMaybe, Dirent, Options, Result };
+export type { Callback, PromiseMaybe, DirentLike, Dirent, Options, Result };

package/package.json

@@ -3,7 +3,7 @@
   "repository": "github:fabiospampinato/tiny-readdir",
   "description": "A simple promisified recursive readdir function.",
   "license": "MIT",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "type": "module",
   "main": "dist/index.js",
   "exports": "./dist/index.js",
@@ -15,9 +15,9 @@
     "clean": "tsex clean",
     "compile": "tsex compile",
     "compile:watch": "tsex compile --watch",
-    "test": "node test/index.js",
+    "test": "tsex test",
     "test:watch": "tsex test --watch",
-    "prepublishOnly": "npm run compile && npm run test"
+    "prepublishOnly": "npm run compile && node test/index.js"
   },
   "keywords": [
     "readdir",

package/readme.md

@@ -20,16 +20,16 @@ const result = await readdir ( '/foo/bar', {
   depth: 20, // Maximum depth to look at
   limit: 1_000_000, // Maximum number of files explored, useful as a stop gap in some edge cases
   followSymlinks: true, // Whether to follow symlinks or not
-  ignore: targetPath => /node_modules/.test ( targetPath ), // Function that if returns true will ignore this particular file or a directory and its descendants
+  ignore: ( targetPath, targetContext ) => /node_modules/.test ( targetPath ), // Function that if returns true will ignore this particular file or a directory and its descendants
   signal: aborter.signal, // Optional abort signal, useful for aborting potentially expensive operations
   onDirents: dirents => console.log ( dirents ) // Optional callback that will be called as soon as new dirents are available, useful for example for discovering ".gitignore" files while searching
 });
 
-// This is how we would abort the reactive read after 10s
+// This is how we would abort the recursive read after 10s
 
 setTimeout ( () => aborter.abort (), 10_000 ); // Aborting if it's going to take longer than 10s
 
-// This is the result object will look like
+// This is what the result object will look like
 
 result.directories; // => Array of absolute paths pointing to directories
 result.files; // => Array of absolute paths pointing to files