fast-glob (original) (raw)

fast-glob

It's a very fast and efficient glob library for Node.js.

This package provides methods for traversing the file system and returning pathnames that matched a defined set of a specified pattern according to the rules used by the Unix Bash shell with some simplifications, meanwhile results are returned in arbitrary order. Quick, simple, effective.

Table of Contents

Details

Highlights

Old and modern mode

This package works in two modes, depending on the environment in which it is used.

The modern mode is faster. Learn more about the internal mechanism.

Pattern syntax

⚠️ Always use forward-slashes in glob expressions (patterns and ignore option). Use backslashes for escaping characters.

There is more than one form of syntax: basic and advanced. Below is a brief overview of the supported features. Also pay attention to our FAQ.

📖 This package uses micromatch as a library for pattern matching.

Basic syntax

📖 A few additional words about the basic matching behavior.

Some examples:

Advanced syntax

📖 A few additional words about the advanced matching behavior.

Some examples:

Installation

API

Asynchronous

fg(patterns, [options]) fg.async(patterns, [options]) fg.glob(patterns, [options])

Returns a Promise with an array of matching entries.

const fg = require('fast-glob');

const entries = await fg(['.editorconfig', '**/index.js'], { dot: true });

// ['.editorconfig', 'services/index.js']

Synchronous

fg.sync(patterns, [options]) fg.globSync(patterns, [options])

Returns an array of matching entries.

const fg = require('fast-glob');

const entries = fg.sync(['.editorconfig', '**/index.js'], { dot: true });

// ['.editorconfig', 'services/index.js']

Stream

fg.stream(patterns, [options]) fg.globStream(patterns, [options])

Returns a ReadableStream when the data event will be emitted with matching entry.

const fg = require('fast-glob');

const stream = fg.stream(['.editorconfig', '**/index.js'], { dot: true });

for await (const entry of stream) { // .editorconfig // services/index.js }

patterns

Any correct pattern(s).

🔢 Pattern syntax

⚠️ This package does not respect the order of patterns. First, all the negative patterns are applied, and only then the positive patterns. If you want to get a certain order of records, use sorting or split calls.

[options]

See Options section.

Helpers

generateTasks(patterns, [options])

Returns the internal representation of patterns (Task is a combining patterns by base directory).

fg.generateTasks('*');

[{ base: '.', // Parent directory for all patterns inside this task dynamic: true, // Dynamic or static patterns are in this task patterns: [''], positive: [''], negative: [] }]

patterns

Any correct pattern(s).

[options]

See Options section.

isDynamicPattern(pattern, [options])

Returns true if the passed pattern is a dynamic pattern.

🔢 What is a static or dynamic pattern?

fg.isDynamicPattern('*'); // true fg.isDynamicPattern('abc'); // false

pattern

Any correct pattern.

[options]

See Options section.

escapePath(path)

Returns the path with escaped special characters depending on the platform.

fg.escapePath('!abc'); // \!abc fg.escapePath('[OpenSource] mrmlnc – fast-glob (Deluxe Edition) 2014') + '/.flac' // \[OpenSource\] mrmlnc – fast-glob \(Deluxe Edition\) 2014/.flac

fg.posix.escapePath('C:\Program Files (x86)\\'); // C:\\Program Files \(x86\)\\\ fg.win32.escapePath('C:\Program Files (x86)\\'); // Windows: C:\Program Files \(x86\)\\

convertPathToPattern(path)

Converts a path to a pattern depending on the platform, including special character escaping.

fg.convertPathToPattern('[OpenSource] mrmlnc – fast-glob (Deluxe Edition) 2014') + '/.flac'; // \[OpenSource\] mrmlnc – fast-glob \(Deluxe Edition\) 2014/.flac

fg.convertPathToPattern('C:/Program Files (x86)//'); // Posix: C:/Program Files \(x86\)/\\/\ // Windows: C:/Program Files \(x86\)/**/*

fg.convertPathToPattern('C:\Program Files (x86)\\'); // Posix: C:\\Program Files \(x86\)\\\ // Windows: C:/Program Files \(x86\)/**/*

fg.posix.convertPathToPattern('\\?\c:\Program Files (x86)') + '//*'; // Posix: \\\?\\c:\\Program Files \(x86\)//* (broken pattern) fg.win32.convertPathToPattern('\\?\c:\Program Files (x86)') + '//*'; // Windows: //?/c:/Program Files \(x86\)//*

Options

Common options

concurrency

Specifies the maximum number of concurrent requests from a reader to read directories.

📖 The higher the number, the higher the performance and load on the file system. If you want to read in quiet mode, set the value to a comfortable number or 1.

More details

In Node, there are two types of threads: Event Loop (code) and a Thread Pool (fs, dns, …). The thread pool size controlled by the UV_THREADPOOL_SIZE environment variable. Its default size is 4 (documentation). The pool is one for all tasks within a single Node process.

Any code can make 4 real concurrent accesses to the file system. The rest of the FS requests will wait in the queue.

📖 Each new instance of FG in the same Node process will use the same Thread pool.

But this package also has the concurrency option. This option allows you to control the number of concurrent accesses to the FS at the package level. By default, this package has a value equal to the number of cores available for the current Node process. This allows you to set a value smaller than the pool size (concurrency: 1) or, conversely, to prepare tasks for the pool queue more quickly (concurrency: Number.POSITIVE_INFINITY).

So, in fact, this package can only make 4 concurrent requests to the FS. You can increase this value by using an environment variable (UV_THREADPOOL_SIZE), but in practice this does not give a multiple advantage.

cwd

The current working directory in which to search.

deep

Specifies the maximum depth of a read directory relative to the start directory.

For example, you have the following tree:

dir/ └── one/ // 1 └── two/ // 2 └── file.js // 3

// With base directory fg.sync('dir/', { onlyFiles: false, deep: 1 }); // ['dir/one'] fg.sync('dir/', { onlyFiles: false, deep: 2 }); // ['dir/one', 'dir/one/two']

// With cwd option fg.sync('', { onlyFiles: false, cwd: 'dir', deep: 1 }); // ['one'] fg.sync('', { onlyFiles: false, cwd: 'dir', deep: 2 }); // ['one', 'one/two']

📖 If you specify a pattern with some base directory, this directory will not participate in the calculation of the depth of the found directories. Think of it as a cwd option.

Indicates whether to traverse descendants of symbolic link directories when expanding ** patterns.

📖 Note that this option does not affect the base directory of the pattern. For example, if ./a is a symlink to directory ./b and you specified ['./a**', './b/**'] patterns, then directory ./a will still be read.

📖 If the stats option is specified, the information about the symbolic link (fs.lstat) will be replaced with information about the entry (fs.stat) behind it.

fs

Custom implementation of methods for working with the file system. Supports objects with enumerable properties only.

export interface FileSystemAdapter { lstat?: typeof fs.lstat; stat?: typeof fs.stat; lstatSync?: typeof fs.lstatSync; statSync?: typeof fs.statSync; readdir?: typeof fs.readdir; readdirSync?: typeof fs.readdirSync; }

ignore

An array of glob patterns to exclude matches. This is an alternative way to use negative patterns.

dir/ ├── package-lock.json └── package.json

fg.sync(['.json', '!package-lock.json']); // ['package.json'] fg.sync('.json', { ignore: ['package-lock.json'] }); // ['package.json']

suppressErrors

By default this package suppress only ENOENT errors. Set to true to suppress any error.

📖 Can be useful when the directory has entries with a special level of access.

Throw an error when symbolic link is broken if true or safely return lstat call if false.

📖 This option has no effect on errors when reading the symbolic link directory.

Output control

absolute

Return the absolute path for entries.

fg.sync('.js', { absolute: false }); // ['index.js'] fg.sync('.js', { absolute: true }); // ['/home/user/index.js']

📖 This option is required if you want to use negative patterns with absolute path, for example, !${__dirname}/*.js.

markDirectories

Mark the directory path with the final slash.

fg.sync('', { onlyFiles: false, markDirectories: false }); // ['index.js', 'controllers'] fg.sync('', { onlyFiles: false, markDirectories: true }); // ['index.js', 'controllers/']

objectMode

Returns objects (instead of strings) describing entries.

fg.sync('', { objectMode: false }); // ['src/index.js'] fg.sync('', { objectMode: true }); // [{ name: 'index.js', path: 'src/index.js', dirent: <fs.Dirent> }]

The object has the following fields:

📖 An object is an internal representation of entry, so getting it does not affect performance.

onlyDirectories

Return only directories.

fg.sync('', { onlyDirectories: false }); // ['index.js', 'src'] fg.sync('', { onlyDirectories: true }); // ['src']

📖 If true, the onlyFiles option is automatically false.

onlyFiles

Return only files.

fg.sync('', { onlyFiles: false }); // ['index.js', 'src'] fg.sync('', { onlyFiles: true }); // ['index.js']

stats

Enables an object mode with an additional field:

fg.sync('', { stats: false }); // ['src/index.js'] fg.sync('', { stats: true }); // [{ name: 'index.js', path: 'src/index.js', dirent: <fs.Dirent>, stats: <fs.Stats> }]

📖 Returns fs.stat instead of fs.lstat for symbolic links when the followSymbolicLinks option is specified.

⚠️ Unlike object mode this mode requires additional calls to the file system. On average, this mode is slower at least twice. See old and modern mode for more details.

unique

Ensures that the returned entries are unique.

fg.sync(['.json', 'package.json'], { unique: false }); // ['package.json', 'package.json'] fg.sync(['.json', 'package.json'], { unique: true }); // ['package.json']

If true and similar entries are found, the result is the first found.

Matching control

braceExpansion

Enables Bash-like brace expansion.

🔢 Syntax description or more detailed description.

dir/ ├── abd ├── acd └── a{b,c}d

fg.sync('a{b,c}d', { braceExpansion: false }); // ['a{b,c}d'] fg.sync('a{b,c}d', { braceExpansion: true }); // ['abd', 'acd']

caseSensitiveMatch

Enables a case-sensitive mode for matching files.

dir/ ├── file.txt └── File.txt

fg.sync('file.txt', { caseSensitiveMatch: false }); // ['file.txt', 'File.txt'] fg.sync('file.txt', { caseSensitiveMatch: true }); // ['file.txt']

dot

Allow patterns to match entries that begin with a period (.).

📖 Note that an explicit dot in a portion of the pattern will always match dot files.

dir/ ├── .editorconfig └── package.json

fg.sync('', { dot: false }); // ['package.json'] fg.sync('', { dot: true }); // ['.editorconfig', 'package.json']

extglob

Enables Bash-like extglob functionality.

🔢 Syntax description.

dir/ ├── README.md └── package.json

fg.sync('.+(json|md)', { extglob: false }); // [] fg.sync('.+(json|md)', { extglob: true }); // ['README.md', 'package.json']

globstar

Enables recursively repeats a pattern containing **. If false, ** behaves exactly like *.

fg.sync('', { onlyFiles: false, globstar: false }); // ['a'] fg.sync('', { onlyFiles: false, globstar: true }); // ['a', 'a/b']

baseNameMatch

If set to true, then patterns without slashes will be matched against the basename of the path if it contains slashes.

dir/ └── one/ └── file.md

fg.sync('.md', { baseNameMatch: false }); // [] fg.sync('.md', { baseNameMatch: true }); // ['one/file.md']

FAQ

What is a static or dynamic pattern?

All patterns can be divided into two types:

A pattern is considered dynamic if it contains the following characters (… — any characters or their absence) or options:

How to write patterns on Windows?

Always use forward-slashes in glob expressions (patterns and ignore option). Use backslashes for escaping characters. With the cwd option use a convenient format.

Bad

[ 'directory\*', path.join(process.cwd(), '**') ]

Good

[ 'directory/*', fg.convertPathToPattern(process.cwd()) + '/**' ]

📖 Use the .convertPathToPattern package to convert Windows-style path to a Unix-style path.

Read more about matching with backslashes.

Why are parentheses match wrong?

dir/ └── (special-*file).txt

fg.sync(['(special-*file).txt']) // []

Refers to Bash. You need to escape special characters:

fg.sync(['\(special-*file\).txt']) // ['(special-*file).txt']

Read more about matching special characters as literals. Or use the .escapePath.

How to exclude directory from reading?

You can use a negative pattern like this: !**/node_modules or !**/node_modules/**. Also you can use ignore option. Just look at the example below.

first/ ├── file.md └── second/ └── file.txt

If you don't want to read the second directory, you must write the following pattern: !**/second or !**/second/**.

fg.sync(['/*.md', '!/second']); // ['first/file.md'] fg.sync(['/*.md'], { ignore: ['/second/**'] }); // ['first/file.md']

⚠️ When you write !**/second/**/* it means that the directory will be read, but all the entries will not be included in the results.

You have to understand that if you write the pattern to exclude directories, then the directory will not be read under any circumstances.

How to use UNC path?

You cannot use Uniform Naming Convention (UNC) paths as patterns (due to syntax) directly, but you can use them as cwd directory or use the fg.convertPathToPattern method.

// cwd fg.sync('', { cwd: '\\?\C:\Python27' / or //?/C:/Python27 / }); fg.sync('Python27/', { cwd: '\\?\C:\' /* or //?/C:/ */ });

// .convertPathToPattern fg.sync(fg.convertPathToPattern('\\?\c:\Python27') + '/*');

Compatible with node-glob?

node-glob fast-glob
cwd cwd
root –
dot dot
nomount –
mark markDirectories
nosort –
nounique unique
nobrace braceExpansion
noglobstar globstar
noext extglob
nocase caseSensitiveMatch
matchBase baseNameMatch
nodir onlyFiles
ignore ignore
follow followSymbolicLinks
realpath –
absolute absolute

Benchmarks

You can see results here for every commit into the main branch.

Changelog

See the Releases section of our GitHub project for changelog for each release version.

License

This software is released under the terms of the MIT license.