https://github.com/fabiospampinato/tiny-readdir-glob-gitignore

A simple promisified recursive readdir function, with support for globs and .gitignore files.
https://github.com/fabiospampinato/tiny-readdir-glob-gitignore

gitignore glob promise readdir recursive simple tiny

Last synced: 10 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/fabiospampinato/tiny-readdir-glob-gitignore
• Owner: fabiospampinato
• License: mit
• Created: 2024-03-19T15:40:31.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-20T23:10:13.000Z (almost 2 years ago)
• Last Synced: 2024-11-25T01:04:36.675Z (over 1 year ago)
• Topics: gitignore, glob, promise, readdir, recursive, simple, tiny
• Language: TypeScript
• Homepage:
• Size: 28.3 KB
• Stars: 13
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

          
# Tiny Readdir Glob Gitignore

A simple promisified recursive readdir function, with support for globs and `.gitignore` files.

Compared to simply searching for `.gitignore` files first, and normal files second, this approach is more efficient because both are searched for simultaneously, meaning that a single folder is entered at most once, and if a folder is discarded by a `.gitignore` file it won't be entered at all.

## Install

```sh

npm install --save tiny-readdir-glob-gitignore

```

## Usage

```ts

import readdir from 'tiny-readdir-glob-gitignore';

// Let's recursively read into a directory using a glob, in a .gitignore-aware fashion

const aborter = new AbortController ();

const result = await readdir ( ['src/**/*.js'], {

  cwd: process.cwd (), // The root directory to start searching from

  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: ['**/.git', '**/node_modules'], // Globs, or raw function, that if returns true will ignore this particular file or a directory and its descendants

  ignoreFiles: ['.gitignore'], // List of .gitignore-like files to look for, defaults to ['.gitignore']

  ignoreFilesFindAbove: true, // Whether to look for .gitignore-like files in parent directories also, defaults to true

  ignoreFilesFindBetween: true, // Whether to look for .gitignore-like files between the "cwd" directory, and the actual search directories, which due to some optimizations could not be the same

  ignoreFilesStrictly: true, // Whether to strictly follow the rules in .gitignore-like files, even if they exclude the folder you are explicitly searching into, defaults to false

  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 the basic information we'll get

result.directories; // => Array of absolute paths pointing to directories, filtered by the provided glob

result.files; // => Array of absolute paths pointing to files, filtered by the provided glob

result.symlinks; // => Array of absolute paths pointing to symlinks, filtered by the provided glob

// This is more advanced information we'll get, which is useful in some cases

result.directoriesFound; // => Array of absolute paths pointing to directories, not fully filtered by the provided glob yet

result.filesFound; // => Array of absolute paths pointing to files, not fully filtered by the provided glob yet

result.symlinksFound; // => Array of absolute paths pointing to symlinks, not fully filtered by the provided glob yet

result.directoriesFoundNames; // => Set of directories names found

result.filesFoundNames; // => Set of files name found

result.symlinksFoundNames; // => Set of symlinks names found

result.directoriesFoundNamesToPaths; // => Record of directories names found to their paths

result.filesFoundNamesToPaths; // => Record of files name found to their paths

result.symlinksFoundNamesToPaths; // => Record of symlinks names found to their paths

setTimeout ( () => aborter.abort (), 10000 ); // Aborting if it's going to take longer than 10s

```

## License

MIT © Fabio Spampinato