Tiny Readdir Glob

A simple promisified recursive readdir function, with support for globs.

Install

1npm install --save tiny-readdir-glob

Usage

1import readdir from 'tiny-readdir-glob';
2
3const aborter = new AbortController ();
4
5const result = await readdir ( ['src/**/*.js'], {
6  depth: 20, // Maximum depth to look at
7  limit: 1_000_000, // Maximum number of files explored, useful as a stop gap in some edge cases
8  followSymlinks: true, // Whether to follow symlinks or not
9  ignore: ['**/.git', '**/node_modules'], // Globs, or raw function, that if returns true will ignore this particular file or a directory and its descendants
10  signal: aborter.signal, // Optional abort signal, useful for aborting potentially expensive operations
11  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
12});
13
14console.log ( result.directories ); // => Array of absolute paths pointing to directories, filtered by the provided glob
15console.log ( result.files ); // => Array of absolute paths pointing to files, filtered by the provided glob
16console.log ( result.symlinks ); // => Array of absolute paths pointing to symlinks, filtered by the provided glob
17
18console.log ( result.directoriesFound ); // => Array of absolute paths pointing to directories, not fully filtered by the provided glob yet
19console.log ( result.filesFound ); // => Array of absolute paths pointing to files, not fully filtered by the provided glob yet
20console.log ( result.symlinksFound ); // => Array of absolute paths pointing to symlinks, not fully filtered by the provided glob yet
21
22console.log ( result.directoriesFoundNames ); // => Set of directories names found
23console.log ( result.filesFoundNames ); // => Set of files name found
24console.log ( result.symlinksFoundNames ); // => Set of symlinks names found
25
26console.log ( result.directoriesFoundNamesToPaths ); // => Record of directories names found to their paths
27console.log ( result.filesFoundNamesToPaths ); // => Record of files name found to their paths
28console.log ( result.symlinksFoundNamesToPaths ); // => Record of symlinks names found to their paths
29
30setTimeout ( () => aborter.abort (), 10000 ); // Aborting if it's going to take longer than 10s

License

MIT © Fabio Spampinato