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.
- Fast. Probably the fastest.
- Supports multiple and negative patterns.
- Synchronous, Promise and Stream API.
- Object mode. Can return more than just strings.
- Error-tolerant.
⚠️ Always use forward-slashes in glob expressions (patterns andignoreoption). 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
micromatchas a library for pattern matching.
- An asterisk (
*) — matches everything except slashes (path separators), hidden files (names starting with.). - A double star or globstar (
**) — matches zero or more directories. - Question mark (
?) – matches any single character except slashes (path separators). - Sequence (
[seq]) — matches any character in sequence.
📖 A few additional words about the basic matching behavior.
Some examples:
src/**/*.js— matches all files in thesrcdirectory (any level of nesting) that have the.jsextension.src/*.??— matches all files in thesrcdirectory (only first level of nesting) that have a two-character extension.file-[01].js— matches files:file-0.js,file-1.js.
- Escapes characters (
\\) — matching special characters ($^*+?()[]) as literals. - POSIX character classes (
[[:digit:]]). - Extended globs (
?(pattern-list)). - Bash style brace expansions (
{}). - Regexp character classes (
[1-5]). - Regex groups (
(a|b)).
📖 A few additional words about the advanced matching behavior.
Some examples:
src/**/*.{css,scss}— matches all files in thesrcdirectory (any level of nesting) that have the.cssor.scssextension.file-[[:digit:]].js— matches files:file-0.js,file-1.js, …,file-9.js.file-{1..3}.js— matches files:file-1.js,file-2.js,file-3.js.file-(1|2)— matches files:file-1.js,file-2.js.
npm install fast-globfg.glob(patterns, [options])
fg.async(patterns, [options])Returns a Promise with an array of matching entries.
const fg = require('fast-glob');
const entries = await fg.glob(['.editorconfig', '**/index.js'], { dot: true });
// ['.editorconfig', 'services/index.js']fg.globSync(patterns, [options])Returns an array of matching entries.
const fg = require('fast-glob');
const entries = fg.globSync(['.editorconfig', '**/index.js'], { dot: true });
// ['.editorconfig', 'services/index.js']fg.globStream(patterns, [options])
fg.stream(patterns, [options])Returns a ReadableStream when the data event will be emitted with matching entry.
const fg = require('fast-glob');
const stream = fg.globStream(['.editorconfig', '**/index.js'], { dot: true });
for await (const entry of stream) {
// .editorconfig
// services/index.js
}- Required:
true - Type:
string | string[]
Any correct pattern(s).
⚠️ 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.
- Required:
false - Type:
Options
See Options section.
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: []
}]- Required:
true - Type:
string | string[]
Any correct pattern(s).
- Required:
false - Type:
Options
See Options section.
Returns true if the passed pattern is a dynamic pattern.
fg.isDynamicPattern('*'); // true
fg.isDynamicPattern('abc'); // false- Required:
true - Type:
string
Any correct pattern.
- Required:
false - Type:
Options
See Options section.
Returns the path with escaped special characters depending on the platform.
- Posix:
*?|(){}[];!at the beginning of line;@+!before the opening parenthesis;\\before non-special characters;
- Windows:
(){}[]!at the beginning of line;@+!before the opening parenthesis;- Characters like
*?|cannot be used in the path (windows_naming_conventions), so they will not be escaped;
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\\)\\**\\*Converts a path to a pattern depending on the platform, including special character escaping.
- Posix. Works similarly to the
fg.posix.escapePathmethod. - Windows. Works similarly to the
fg.win32.escapePathmethod, additionally converting backslashes to forward slashes in cases where they are not escape characters (!()+@{}[]).
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\\)/**/*- Type:
string - Default:
process.cwd()
The current working directory in which to search.
- Type:
number - Default:
Infinity
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.globSync('dir/**', { onlyFiles: false, deep: 1 }); // ['dir/one']
fg.globSync('dir/**', { onlyFiles: false, deep: 2 }); // ['dir/one', 'dir/one/two']
// With cwd option
fg.globSync('**', { onlyFiles: false, cwd: 'dir', deep: 1 }); // ['one']
fg.globSync('**', { 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
cwdoption.
- Type:
boolean - Default:
true
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
./ais a symlink to directory./band you specified['./a**', './b/**']patterns, then directory./awill still be read.
📖 If the
statsoption is specified, the information about the symbolic link (fs.lstat) will be replaced with information about the entry (fs.stat) behind it.
- Type:
FileSystemAdapter - Default:
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;
}- Type:
string[] - Default:
[]
An array of glob patterns to exclude matches. This is an alternative way to use negative patterns.
dir/
├── package-lock.json
└── package.jsonfg.globSync(['*.json', '!package-lock.json']); // ['package.json']
fg.globSync('*.json', { ignore: ['package-lock.json'] }); // ['package.json']- Type:
boolean - Default:
false
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.
- Type:
boolean - Default:
false
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.
- Type:
boolean - Default:
false
Return the absolute path for entries.
fg.globSync('*.js', { absolute: false }); // ['index.js']
fg.globSync('*.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.
- Type:
boolean - Default:
false
Mark the directory path with the final slash.
fg.globSync('*', { onlyFiles: false, markDirectories: false }); // ['index.js', 'controllers']
fg.globSync('*', { onlyFiles: false, markDirectories: true }); // ['index.js', 'controllers/']- Type:
boolean - Default:
false
Returns objects (instead of strings) describing entries.
fg.globSync('*', { objectMode: false }); // ['src/index.js']
fg.globSync('*', { objectMode: true }); // [{ name: 'index.js', path: 'src/index.js', dirent: <fs.Dirent> }]The object has the following fields:
- name (
string) — the last part of the path (basename) - path (
string) — full path relative to the pattern base directory - dirent (
fs.Dirent) — instance offs.Dirent
📖 An object is an internal representation of entry, so getting it does not affect performance.
- Type:
boolean - Default:
false
Return only directories.
fg.globSync('*', { onlyDirectories: false }); // ['index.js', 'src']
fg.globSync('*', { onlyDirectories: true }); // ['src']📖 If
true, theonlyFilesoption is automaticallyfalse.
- Type:
boolean - Default:
true
Return only files.
fg.globSync('*', { onlyFiles: false }); // ['index.js', 'src']
fg.globSync('*', { onlyFiles: true }); // ['index.js']- Type:
boolean - Default:
false
Enables an object mode with an additional field:
- stats (
fs.Stats) — instance offs.Stats
fg.globSync('*', { stats: false }); // ['src/index.js']
fg.globSync('*', { stats: true }); // [{ name: 'index.js', path: 'src/index.js', dirent: <fs.Dirent>, stats: <fs.Stats> }]📖 Returns
fs.statinstead offs.lstatfor symbolic links when thefollowSymbolicLinksoption is specified.
- Type:
boolean - Default:
true
Ensures that the returned entries are unique.
fg.globSync(['*.json', 'package.json'], { unique: false }); // ['package.json', 'package.json']
fg.globSync(['*.json', 'package.json'], { unique: true }); // ['package.json']If true and similar entries are found, the result is the first found.
- Type:
boolean - Default:
true
Enables Bash-like brace expansion.
🔢 Syntax description or more detailed description.
dir/
├── abd
├── acd
└── a{b,c}dfg.globSync('a{b,c}d', { braceExpansion: false }); // ['a{b,c}d']
fg.globSync('a{b,c}d', { braceExpansion: true }); // ['abd', 'acd']- Type:
boolean - Default:
true
Enables a case-sensitive mode for matching files.
dir/
├── file.txt
└── File.txtfg.globSync('file.txt', { caseSensitiveMatch: false }); // ['file.txt', 'File.txt']
fg.globSync('file.txt', { caseSensitiveMatch: true }); // ['file.txt']- Type:
boolean - Default:
false
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.jsonfg.globSync('*', { dot: false }); // ['package.json']
fg.globSync('*', { dot: true }); // ['.editorconfig', 'package.json']- Type:
boolean - Default:
true
Enables Bash-like extglob functionality.
dir/
├── README.md
└── package.jsonfg.globSync('*.+(json|md)', { extglob: false }); // []
fg.globSync('*.+(json|md)', { extglob: true }); // ['README.md', 'package.json']- Type:
boolean - Default:
true
Enables recursively repeats a pattern containing **. If false, ** behaves exactly like *.
dir/
└── a
└── bfg.globSync('**', { onlyFiles: false, globstar: false }); // ['a']
fg.globSync('**', { onlyFiles: false, globstar: true }); // ['a', 'a/b']- Type:
boolean - Default:
false
If set to true, then patterns without slashes will be matched against the basename of the path if it contains slashes.
dir/
└── one/
└── file.mdfg.globSync('*.md', { baseNameMatch: false }); // []
fg.globSync('*.md', { baseNameMatch: true }); // ['one/file.md']All patterns can be divided into two types:
- static. A pattern is considered static if it can be used to get an entry on the file system without using matching mechanisms. For example, the
file.jspattern is a static pattern because we can just verify that it exists on the file system. - dynamic. A pattern is considered dynamic if it cannot be used directly to find occurrences without using a matching mechanisms. For example, the
*pattern is a dynamic pattern because we cannot use this pattern directly.
A pattern is considered dynamic if it contains the following characters (… — any characters or their absence) or options:
- The
caseSensitiveMatchoption is disabled \\(the escape character)*,?,!(at the beginning of line)[…](…|…)@(…),!(…),*(…),?(…),+(…)(respects theextgloboption){…,…},{…..…}(respects thebraceExpansionoption)
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
.convertPathToPatternpackage to convert Windows-style path to a Unix-style path.
Read more about matching with backslashes.
dir/
└── (special-*file).txtfg.globSync(['(special-*file).txt']) // []Refers to Bash. You need to escape special characters:
fg.globSync(['\\(special-*file\\).txt']) // ['(special-*file).txt']Read more about matching special characters as literals. Or use the .escapePath.
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.txtIf you don't want to read the second directory, you must write the following pattern: !**/second or !**/second/**.
fg.globSync(['**/*.md', '!**/second']); // ['first/file.md']
fg.globSync(['**/*.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.
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.globSync('*', { cwd: '\\\\?\\C:\\Python27' /* or //?/C:/Python27 */ });
fg.globSync('Python27/*', { cwd: '\\\\?\\C:\\' /* or //?/C:/ */ });
// .convertPathToPattern
fg.globSync(fg.convertPathToPattern('\\\\?\\c:\\Python27') + '/*');| 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 |
You can see results here for every commit into the main branch.
- Product benchmark – comparison with the main competitors.
- Regress benchmark – regression between the current version and the version from the npm registry.
See the Releases section of our GitHub project for changelog for each release version.
This software is released under the terms of the MIT license.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent