Updates in this fork

In this fork, we add options.fileSystem to make it work in browsers. All tests are passed after these updates.

Original README.md

The Fastest Directory Crawler & Globber for NodeJS

⚡ The Fastest: Nothing similar (in the NodeJS world) beats fdir in speed. It can easily crawl a directory containing 1 million files in < 1 second.

💡 Stupidly Easy: fdir uses expressive Builder pattern to build the crawler increasing code readability.

🤖 Zero Dependencies*: fdir only uses NodeJS fs & path modules.

🕺 Astonishingly Small: < 2KB in size gzipped & minified.

🖮 Hackable: Extending fdir is extremely simple now that the new Builder API is here. Feel free to experiment around.

* picomatch must be installed manually by the user to support globbing.

🚄 Quickstart

Installation

You can install using npm:

1$ npm i fdir

or Yarn:

1$ yarn add fdir

Usage

1import { fdir } from "fdir";
2
3// create the builder
4const api = new fdir().withFullPaths().crawl("path/to/dir");
5
6// get all files in a directory synchronously
7const files = api.sync();
8
9// or asynchronously
10api.withPromise().then((files) => {
11  // do something with the result here.
12});

Documentation:

Documentation for all methods is available here.

📊 Benchmarks:

Please check the benchmark against the latest version here.

🙏Used by:

fdir is downloaded over 200k+ times a week by projects around the world. Here's a list of some notable projects using fdir in production:

Note: if you think your project should be here, feel free to open an issue. Notable is anything with a considerable amount of GitHub stars.

1. rollup/plugins
2. SuperchupuDev/tinyglobby
3. pulumi/pulumi
4. dotenvx/dotenvx
5. mdn/yari
6. streetwriters/notesnook
7. imba/imba
8. moroshko/react-scanner
9. netlify/build
10. yassinedoghri/astro-i18next
11. selfrefactor/rambda
12. whyboris/Video-Hub-App

🦮 LICENSE

Copyright © 2024 Abdullah Atta under MIT. Read full text here.