tiny-readdir 2.4.0 → 2.6.0

package/dist/constants.d.ts

@@ -0,0 +1,5 @@
+import type { Callback } from './types';
+declare const NOOP_PROMISE_LIKE: {
+    then: (fn: Callback) => void;
+};
+export { NOOP_PROMISE_LIKE };

package/dist/constants.js

@@ -0,0 +1,9 @@
+/* IMPORT */
+/* MAIN */
+const NOOP_PROMISE_LIKE = {
+    then: (fn) => {
+        fn();
+    }
+};
+/* EXPORT */
+export { NOOP_PROMISE_LIKE };

package/dist/index.d.ts

@@ -1,3 +1,4 @@
-import type { Options, Result } from './types';
+import type { Dirent, Options, Result } from './types';
 declare const readdir: (rootPath: string, options?: Options) => Promise<Result>;
 export default readdir;
+export type { Dirent, Options, Result };

package/dist/index.js

@@ -1,6 +1,7 @@
 /* IMPORT */
 import fs from 'node:fs';
 import path from 'node:path';
+import { NOOP_PROMISE_LIKE } from './constants.js';
 import { isFunction, makeCounterPromise } from './utils.js';
 /* MAIN */
 //TODO: Streamline the type of dirnmaps
@@ -11,6 +12,7 @@ const readdir = (rootPath, options) => {
     const ignore = options?.ignore ?? (() => false);
     const isIgnored = isFunction(ignore) ? ignore : (targetPath) => ignore.test(targetPath);
     const signal = options?.signal ?? { aborted: false };
+    const onDirents = options?.onDirents || (() => { });
     const directories = [];
     const directoriesNames = new Set();
     const directoriesNamesToPaths = {};
@@ -139,9 +141,12 @@ const readdir = (rootPath, options) => {
                 return decrement();
             if (!dirents.length)
                 return decrement();
-            const dirmap = map[rootPath] = { directories: [], directoriesNames: new Set(), directoriesNamesToPaths: {}, files: [], filesNames: new Set(), filesNamesToPaths: {}, symlinks: [], symlinksNames: new Set(), symlinksNamesToPaths: {} };
-            handleDirents(dirmap, rootPath, dirents, depth);
-            decrement();
+            const promise = onDirents(dirents) || NOOP_PROMISE_LIKE;
+            promise.then(() => {
+                const dirmap = map[rootPath] = { directories: [], directoriesNames: new Set(), directoriesNamesToPaths: {}, files: [], filesNames: new Set(), filesNamesToPaths: {}, symlinks: [], symlinksNames: new Set(), symlinksNamesToPaths: {} };
+                handleDirents(dirmap, rootPath, dirents, depth);
+                decrement();
+            });
         });
     };
     const populateResultFromSymlink = async (rootPath, depth) => {

package/dist/types.d.ts

@@ -1,4 +1,16 @@
 type Callback = () => void;
+type PromiseMaybe<T> = Promise<T> | T;
+type Dirent = {
+    isFile: () => boolean;
+    isDirectory: () => boolean;
+    isBlockDevice: () => boolean;
+    isCharacterDevice: () => boolean;
+    isSymbolicLink: () => boolean;
+    isFIFO: () => boolean;
+    isSocket: () => boolean;
+    name: string;
+    path: string;
+};
 type Options = {
     depth?: number;
     limit?: number;
@@ -7,6 +19,7 @@ type Options = {
     signal?: {
         aborted: boolean;
     };
+    onDirents?: (dirents: Dirent[]) => PromiseMaybe<undefined>;
 };
 type ResultDirectory = {
     directories: string[];
@@ -25,4 +38,4 @@ type ResultDirectories = {
 type Result = ResultDirectory & {
     map: ResultDirectories;
 };
-export type { Callback, Options, ResultDirectory, ResultDirectories, Result };
+export type { Callback, PromiseMaybe, Dirent, Options, ResultDirectory, ResultDirectories, Result };

package/package.json

@@ -2,7 +2,7 @@
   "name": "tiny-readdir",
   "repository": "github:fabiospampinato/tiny-readdir",
   "description": "A simple promisified recursive readdir function.",
-  "version": "2.4.0",
+  "version": "2.6.0",
   "type": "module",
   "main": "dist/index.js",
   "exports": "./dist/index.js",

package/readme.md

@@ -20,7 +20,8 @@ const result = await readdir ( '/foo/bar', {
   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
-  signal: aborter.signal // Optional abort signal, useful for aborting potentially expensive operations
+  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
 });
 
 console.log ( result.directories ); // => Array of absolute paths pointing to directories

package/src/constants.ts

@@ -0,0 +1,16 @@
+
+/* IMPORT */
+
+import type {Callback} from './types';
+
+/* MAIN */
+
+const NOOP_PROMISE_LIKE = {
+  then: ( fn: Callback ) => {
+    fn ();
+  }
+};
+
+/* EXPORT */
+
+export {NOOP_PROMISE_LIKE};

package/src/index.ts

@@ -3,8 +3,9 @@
 
 import fs from 'node:fs';
 import path from 'node:path';
+import {NOOP_PROMISE_LIKE} from './constants';
 import {isFunction, makeCounterPromise} from './utils';
-import type {Options, ResultDirectory, ResultDirectories, Result} from './types';
+import type {Dirent, Options, ResultDirectory, ResultDirectories, Result} from './types';
 
 /* MAIN */
 
@@ -18,6 +19,7 @@ const readdir = ( rootPath: string, options?: Options ): Promise<Result> => {
   const ignore = options?.ignore ?? (() => false);
   const isIgnored = isFunction ( ignore ) ? ignore : ( targetPath: string ) => ignore.test ( targetPath );
   const signal = options?.signal ?? { aborted: false };
+  const onDirents = options?.onDirents || (() => {});
   const directories: string[] = [];
   const directoriesNames: Set<string> = new Set ();
   const directoriesNamesToPaths: Record<string, string[]> = {};
@@ -182,11 +184,17 @@ const readdir = ( rootPath: string, options?: Options ): Promise<Result> => {
 
       if ( !dirents.length ) return decrement ();
 
-      const dirmap = map[rootPath] = { directories: [], directoriesNames: new Set (), directoriesNamesToPaths: {}, files: [], filesNames: new Set (), filesNamesToPaths: {}, symlinks: [], symlinksNames: new Set (), symlinksNamesToPaths: {} };
+      const promise = onDirents ( dirents ) || NOOP_PROMISE_LIKE;
 
-      handleDirents ( dirmap, rootPath, dirents, depth );
+      promise.then ( () => {
 
-      decrement ();
+        const dirmap = map[rootPath] = { directories: [], directoriesNames: new Set (), directoriesNamesToPaths: {}, files: [], filesNames: new Set (), filesNamesToPaths: {}, symlinks: [], symlinksNames: new Set (), symlinksNamesToPaths: {} };
+
+        handleDirents ( dirmap, rootPath, dirents, depth );
+
+        decrement ();
+
+      });
 
     });
 
@@ -244,3 +252,4 @@ const readdir = ( rootPath: string, options?: Options ): Promise<Result> => {
 /* EXPORT */
 
 export default readdir;
+export type {Dirent, Options, Result};

package/src/types.ts

@@ -3,14 +3,29 @@
 
 type Callback = () => void;
 
+type PromiseMaybe<T> = Promise<T> | T;
+
 /* MAIN */
 
+type Dirent = {
+  isFile: () => boolean,
+  isDirectory: () => boolean,
+  isBlockDevice: () => boolean,
+  isCharacterDevice: () => boolean,
+  isSymbolicLink: () => boolean,
+  isFIFO: () => boolean,
+  isSocket: () => boolean,
+  name: string,
+  path: string
+};
+
 type Options = {
   depth?: number,
   limit?: number,
   followSymlinks?: boolean,
   ignore?: (( targetPath: string ) => boolean) | RegExp,
-  signal?: { aborted: boolean }
+  signal?: { aborted: boolean },
+  onDirents?: ( dirents: Dirent[] ) => PromiseMaybe<undefined>
 };
 
 type ResultDirectory = {
@@ -35,4 +50,4 @@ type Result = ResultDirectory & {
 
 /* EXPORT */
 
-export type {Callback, Options, ResultDirectory, ResultDirectories, Result};
+export type {Callback, PromiseMaybe, Dirent, Options, ResultDirectory, ResultDirectories, Result};