micromatch / glob-fs

file globbing for node.js. speedy and powerful alternative to node-glob. This library is experimental and does not work on windows!

micromatch

Glob matching for javascript/node.js. A replacement and faster alternative to minimatch and multimatch.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Table of Contents

Details

• Install

• Sponsors
  • Gold Sponsors
  • Quickstart
  • Why use micromatch?
    • Matching features
  • Switching to micromatch
    • From minimatch
    • From multimatch
  • API
  • Options
  • Options Examples
    • options.basename
    • options.bash
    • options.expandRange
    • options.format
    • options.ignore
    • options.matchBase
    • options.noextglob
    • options.nonegate
    • options.noglobstar
    • options.nonull
    • options.nullglob
    • options.onIgnore
    • options.onMatch
    • options.onResult
    • options.posixSlashes
    • options.unescape
  • Extended globbing
    • Extglobs
    • Braces
    • Regex character classes
    • Regex groups
    • POSIX bracket expressions
  • Notes
    • Bash 4.3 parity
    • Backslashes
  • Benchmarks
    • Running benchmarks
    • Latest results
  • Contributing
  • About

Install

Install with npm (requires Node.js >=8.6):

$ npm install --save micromatch

Sponsors

Become a Sponsor to add your logo to this README, or any of my other projects

Quickstart

const micromatch = require('micromatch');
// micromatch(list, patterns[, options]);

The main export takes a list of strings and one or more glob patterns:

console.log(micromatch(['foo', 'bar', 'baz', 'qux'], ['f*', 'b*'])) //=> ['foo', 'bar', 'baz']
console.log(micromatch(['foo', 'bar', 'baz', 'qux'], ['*', '!b*'])) //=> ['foo', 'qux']

Use .isMatch() to for boolean matching:

console.log(micromatch.isMatch('foo', 'f*')) //=> true
console.log(micromatch.isMatch('foo', ['b*', 'f*'])) //=> true

Switching from minimatch and multimatch is easy!

Why use micromatch?

micromatch is a replacement for minimatch and multimatch

• Supports all of the same matching features as minimatch and multimatch
• More complete support for the Bash 4.3 specification than minimatch and multimatch. Micromatch passes all of the spec tests from bash, including some that bash still fails.
• Fast & Performant - Loads in about 5ms and performs fast matches.
• Glob matching - Using wildcards (* and ?), globstars (**) for nested directories
• Advanced globbing - Supports extglobs, braces, and POSIX brackets, and support for escaping special characters with \ or quotes.
• Accurate - Covers more scenarios than minimatch
• Well tested - More than 5,000 test assertions
• Windows support - More reliable windows support than minimatch and multimatch.
• Safe{#braces-is-safe} - Micromatch is not subject to DoS with brace patterns like minimatch and multimatch.

Matching features

• Support for multiple glob patterns (no need for wrappers like multimatch)
• Wildcards (**, *.js)
• Negation ('!a/*.js', '*!(b).js')
• extglobs (+(x|y), !(a|b))
• POSIX character classes ([[:alpha:][:digit:]])
• brace expansion (foo/{1..5}.md, bar/{a,b,c}.js)
• regex character classes (foo-[1-5].js)
• regex logical "or" (foo/(abc|xyz).js)

You can mix and match these features to create whatever patterns you need!

Switching to micromatch

(There is one notable difference between micromatch and minimatch in regards to how backslashes are handled. See the notes about backslashes for more information.)

From minimatch

Use micromatch.isMatch() instead of minimatch():

console.log(micromatch.isMatch('foo', 'b*')); //=> false

Use micromatch.match() instead of minimatch.match():

console.log(micromatch.match(['foo', 'bar'], 'b*')); //=> 'bar'

From multimatch

Same signature:

console.log(micromatch(['foo', 'bar', 'baz'], ['f*', '*z'])); //=> ['foo', 'baz']

API

Params

• list {String|Array}: List of strings to match.
• patterns {String|Array}: One or more glob patterns to use for matching.
• options {Object}: See available options
• returns {Array}: Returns an array of matches

Example

const mm = require('micromatch');
// mm(list, patterns[, options]);

console.log(mm(['a.js', 'a.txt'], ['*.js']));
//=> [ 'a.js' ]

.matcher

Returns a matcher function from the given glob pattern and options. The returned function takes a string to match as its only argument and returns true if the string is a match.

Params

• pattern {String}: Glob pattern
• options {Object}
• returns {Function}: Returns a matcher function.

Example

const mm = require('micromatch');
// mm.matcher(pattern[, options]);

const isMatch = mm.matcher('*.!(*a)');
console.log(isMatch('a.a')); //=> false
console.log(isMatch('a.b')); //=> true

.isMatch

Returns true if any of the given glob patterns match the specified string.

Params

• str {String}: The string to test.
• patterns {String|Array}: One or more glob patterns to use for matching.
• [options] {Object}: See available options.
• returns {Boolean}: Returns true if any patterns match str

Example

const mm = require('micromatch');
// mm.isMatch(string, patterns[, options]);

console.log(mm.isMatch('a.a', ['b.*', '*.a'])); //=> true
console.log(mm.isMatch('a.a', 'b.*')); //=> false

.not

Returns a list of strings that do not match any of the given patterns.

Params

• list {Array}: Array of strings to match.
• patterns {String|Array}: One or more glob pattern to use for matching.
• options {Object}: See available options for changing how matches are performed
• returns {Array}: Returns an array of strings that do not match the given patterns.

Example

const mm = require('micromatch');
// mm.not(list, patterns[, options]);

console.log(mm.not(['a.a', 'b.b', 'c.c'], '*.a'));
//=> ['b.b', 'c.c']

.contains

Returns true if the given string contains the given pattern. Similar to .isMatch but the pattern can match any part of the string.

Params

• str {String}: The string to match.
• patterns {String|Array}: Glob pattern to use for matching.
• options {Object}: See available options for changing how matches are performed
• returns {Boolean}: Returns true if any of the patterns matches any part of str.

Example

var mm = require('micromatch');
// mm.contains(string, pattern[, options]);

console.log(mm.contains('aa/bb/cc', '*b'));
//=> true
console.log(mm.contains('aa/bb/cc', '*d'));
//=> false

.matchKeys

Filter the keys of the given object with the given glob pattern and options. Does not attempt to match nested keys. If you need this feature, use glob-object instead.

Params

• object {Object}: The object with keys to filter.
• patterns {String|Array}: One or more glob patterns to use for matching.
• options {Object}: See available options for changing how matches are performed
• returns {Object}: Returns an object with only keys that match the given patterns.

Example

const mm = require('micromatch');
// mm.matchKeys(object, patterns[, options]);

const obj = { aa: 'a', ab: 'b', ac: 'c' };
console.log(mm.matchKeys(obj, '*b'));
//=> { ab: 'b' }

.some

Returns true if some of the strings in the given list match any of the given glob patterns.

Params

• list {String|Array}: The string or array of strings to test. Returns as soon as the first match is found.
• patterns {String|Array}: One or more glob patterns to use for matching.
• options {Object}: See available options for changing how matches are performed
• returns {Boolean}: Returns true if any patterns matches any of the strings in list

Example

const mm = require('micromatch');
// mm.some(list, patterns[, options]);

console.log(mm.some(['foo.js', 'bar.js'], ['*.js', '!foo.js']));
// true
console.log(mm.some(['foo.js'], ['*.js', '!foo.js']));
// false

.every

Returns true if every string in the given list matches any of the given glob patterns.

Params

• list {String|Array}: The string or array of strings to test.
• patterns {String|Array}: One or more glob patterns to use for matching.
• options {Object}: See available options for changing how matches are performed
• returns {Boolean}: Returns true if all patterns matches all of the strings in list

Example

const mm = require('micromatch');
// mm.every(list, patterns[, options]);

console.log(mm.every('foo.js', ['foo.js']));
// true
console.log(mm.every(['foo.js', 'bar.js'], ['*.js']));
// true
console.log(mm.every(['foo.js', 'bar.js'], ['*.js', '!foo.js']));
// false
console.log(mm.every(['foo.js'], ['*.js', '!foo.js']));
// false

.all

Returns true if all of the given patterns match the specified string.

Params

• str {String|Array}: The string to test.
• patterns {String|Array}: One or more glob patterns to use for matching.
• options {Object}: See available options for changing how matches are performed
• returns {Boolean}: Returns true if any patterns match str

Example

const mm = require('micromatch');
// mm.all(string, patterns[, options]);

console.log(mm.all('foo.js', ['foo.js']));
// true

console.log(mm.all('foo.js', ['*.js', '!foo.js']));
// false

console.log(mm.all('foo.js', ['*.js', 'foo.js']));
// true

console.log(mm.all('foo.js', ['*.js', 'f*', '*o*', '*o.js']));
// true

.capture

Returns an array of matches captured by pattern in string, or null` if the pattern did not match.

Params

• glob {String}: Glob pattern to use for matching.
• input {String}: String to match
• options {Object}: See available options for changing how matches are performed
• returns {Array|null}: Returns an array of captures if the input matches the glob pattern, otherwise null.

Example

const mm = require('micromatch');
// mm.capture(pattern, string[, options]);

console.log(mm.capture('test/*.js', 'test/foo.js'));
//=> ['foo']
console.log(mm.capture('test/*.js', 'foo/bar.css'));
//=> null

.makeRe

Create a regular expression from the given glob pattern.

Params

• pattern {String}: A glob pattern to convert to regex.
• options {Object}
• returns {RegExp}: Returns a regex created from the given pattern.

Example

const mm = require('micromatch');
// mm.makeRe(pattern[, options]);

console.log(mm.makeRe('*.js'));
//=> /^(?:(\.[\\\/])?(?!\.)(?=.)[^\/]*?\.js)$/

.scan

Scan a glob pattern to separate the pattern into segments. Used by the split method.

Params

• pattern {String}
• options {Object}
• returns {Object}: Returns an object with

Example

const mm = require('micromatch');
const state = mm.scan(pattern[, options]);

.parse

Parse a glob pattern to create the source string for a regular expression.

Params

• glob {String}
• options {Object}
• returns {Object}: Returns an object with useful properties and output to be used as regex source string.

Example

const mm = require('micromatch');
const state = mm.parse(pattern[, options]);

.braces

Process the given brace pattern.

Params

• pattern {String}: String with brace pattern to process.
• options {Object}: Any options to change how expansion is performed. See the braces library for all available options.
• returns {Array}

Example

const { braces } = require('micromatch');
console.log(braces('foo/{a,b,c}/bar'));
//=> [ 'foo/(a|b|c)/bar' ]

console.log(braces('foo/{a,b,c}/bar', { expand: true }));
//=> [ 'foo/a/bar', 'foo/b/bar', 'foo/c/bar' ]

Options

Option	Type	Default value	Description
basename	boolean	false	If set, then patterns without slashes will be matched against the basename of the path if it contains slashes. For example, a?b would match the path /xyz/123/acb, but not /xyz/acb/123.
bash	boolean	false	Follow bash matching rules more strictly - disallows backslashes as escape characters, and treats single stars as globstars (**).
capture	boolean	undefined	Return regex matches in supporting methods.
contains	boolean	undefined	Allows glob to match any part of the given string(s).
cwd	string	process.cwd()	Current working directory. Used by picomatch.split()
debug	boolean	undefined	Debug regular expressions when an error is thrown.
dot	boolean	false	Match dotfiles. Otherwise dotfiles are ignored unless a . is explicitly defined in the pattern.
expandRange	function	undefined	Custom function for expanding ranges in brace patterns, such as {a..z}. The function receives the range values as two arguments, and it must return a string to be used in the generated regex. It's recommended that returned strings be wrapped in parentheses. This option is overridden by the expandBrace option.
failglob	boolean	false	Similar to the failglob behavior in Bash, throws an error when no matches are found. Based on the bash option of the same name.
fastpaths	boolean	true	To speed up processing, full parsing is skipped for a handful common glob patterns. Disable this behavior by setting this option to false.
flags	boolean	undefined	Regex flags to use in the generated regex. If defined, the nocase option will be overridden.
format	function	undefined	Custom function for formatting the returned string. This is useful for removing leading slashes, converting Windows paths to Posix paths, etc.
ignore	array|string	undefined	One or more glob patterns for excluding strings that should not be matched from the result.
keepQuotes	boolean	false	Retain quotes in the generated regex, since quotes may also be used as an alternative to backslashes.
literalBrackets	boolean	undefined	When true, brackets in the glob pattern will be escaped so that only literal brackets will be matched.
lookbehinds	boolean	true	Support regex positive and negative lookbehinds. Note that you must be using Node 8.1.10 or higher to enable regex lookbehinds.
matchBase	boolean	false	Alias for basename
maxLength	boolean	65536	Limit the max length of the input string. An error is thrown if the input string is longer than this value.
nobrace	boolean	false	Disable brace matching, so that {a,b} and {1..3} would be treated as literal characters.
nobracket	boolean	undefined	Disable matching with regex brackets.
nocase	boolean	false	Perform case-insensitive matching. Equivalent to the regex i flag. Note that this option is ignored when the flags option is defined.
nodupes	boolean	true	Deprecated, use nounique instead. This option will be removed in a future major release. By default duplicates are removed. Disable uniquification by setting this option to false.
noext	boolean	false	Alias for noextglob
noextglob	boolean	false	Disable support for matching with extglobs (like +(a|b))
noglobstar	boolean	false	Disable support for matching nested directories with globstars (**)
nonegate	boolean	false	Disable support for negating with leading !
noquantifiers	boolean	false	Disable support for regex quantifiers (like a{1,2}) and treat them as brace patterns to be expanded.
onIgnore	function	undefined	Function to be called on ignored items.
onMatch	function	undefined	Function to be called on matched items.
onResult	function	undefined	Function to be called on all items, regardless of whether or not they are matched or ignored.
posix	boolean	false	Support POSIX character classes ("posix brackets").
posixSlashes	boolean	undefined	Convert all slashes in file paths to forward slashes. This does not convert slashes in the glob pattern itself
prepend	string	undefined	String to prepend to the generated regex used for matching.
regex	boolean	false	Use regular expression rules for + (instead of matching literal +), and for stars that follow closing parentheses or brackets (as in )* and ]*).
strictBrackets	boolean	undefined	Throw an error if brackets, braces, or parens are imbalanced.
strictSlashes	boolean	undefined	When true, picomatch won't match trailing slashes with single stars.
unescape	boolean	undefined	Remove preceding backslashes from escaped glob characters before creating the regular expression to perform matches.
unixify	boolean	undefined	Alias for posixSlashes, for backwards compatitibility.

Options Examples

options.basename

Allow glob patterns without slashes to match a file path based on its basename. Same behavior as minimatch option matchBase.

Type: Boolean

Default: false

Example

micromatch(['a/b.js', 'a/c.md'], '*.js');
//=> []

micromatch(['a/b.js', 'a/c.md'], '*.js', { basename: true });
//=> ['a/b.js']

options.bash

Enabled by default, this option enforces bash-like behavior with stars immediately following a bracket expression. Bash bracket expressions are similar to regex character classes, but unlike regex, a star following a bracket expression does not repeat the bracketed characters. Instead, the star is treated the same as any other star.

Type: Boolean

Default: true

Example

const files = ['abc', 'ajz'];
console.log(micromatch(files, '[a-c]*'));
//=> ['abc', 'ajz']

console.log(micromatch(files, '[a-c]*', { bash: false }));

options.expandRange

Type: function

Default: undefined

Custom function for expanding ranges in brace patterns. The fill-range library is ideal for this purpose, or you can use custom code to do whatever you need.

Example

The following example shows how to create a glob that matches a numeric folder name between 01 and 25, with leading zeros.

const fill = require('fill-range');
const regex = micromatch.makeRe('foo/{01..25}/bar', {
  expandRange(a, b) {
    return `(${fill(a, b, { toRegex: true })})`;
  }
});

console.log(regex)
//=> /^(?:foo\/((?:0[1-9]|1[0-9]|2[0-5]))\/bar)$/

console.log(regex.test('foo/00/bar')) // false
console.log(regex.test('foo/01/bar')) // true
console.log(regex.test('foo/10/bar')) // true
console.log(regex.test('foo/22/bar')) // true
console.log(regex.test('foo/25/bar')) // true
console.log(regex.test('foo/26/bar')) // false

options.format

Type: function

Default: undefined

Custom function for formatting strings before they're matched.

Example

// strip leading './' from strings
const format = str => str.replace(/^\.\//, '');
const isMatch = picomatch('foo/*.js', { format });
console.log(isMatch('./foo/bar.js')) //=> true

options.ignore

String or array of glob patterns to match files to ignore.

Type: String|Array

Default: undefined

const isMatch = micromatch.matcher('*', { ignore: 'f*' });
console.log(isMatch('foo')) //=> false
console.log(isMatch('bar')) //=> true
console.log(isMatch('baz')) //=> true

options.matchBase

Alias for options.basename.

options.noextglob

Disable extglob support, so that extglobs are regarded as literal characters.

Type: Boolean

Default: undefined

Examples

console.log(micromatch(['a/z', 'a/b', 'a/!(z)'], 'a/!(z)'));
//=> ['a/b', 'a/!(z)']

console.log(micromatch(['a/z', 'a/b', 'a/!(z)'], 'a/!(z)', { noextglob: true }));
//=> ['a/!(z)'] (matches only as literal characters)

options.nonegate

Disallow negation (!) patterns, and treat leading ! as a literal character to match.

Type: Boolean

Default: undefined

options.noglobstar

Disable matching with globstars (**).

Type: Boolean

Default: undefined

micromatch(['a/b', 'a/b/c', 'a/b/c/d'], 'a/**');
//=> ['a/b', 'a/b/c', 'a/b/c/d']

micromatch(['a/b', 'a/b/c', 'a/b/c/d'], 'a/**', {noglobstar: true});
//=> ['a/b']

options.nonull

Alias for options.nullglob.

options.nullglob

If true, when no matches are found the actual (arrayified) glob pattern is returned instead of an empty array. Same behavior as minimatch option nonull.

Type: Boolean

Default: undefined

options.onIgnore

const onIgnore = ({ glob, regex, input, output }) => {
  console.log({ glob, regex, input, output });
  // { glob: '*', regex: /^(?:(?!\.)(?=.)[^\/]*?\/?)$/, input: 'foo', output: 'foo' }
};

const isMatch = micromatch.matcher('*', { onIgnore, ignore: 'f*' });
isMatch('foo');
isMatch('bar');
isMatch('baz');

options.onMatch

const onMatch = ({ glob, regex, input, output }) => {
  console.log({ input, output });
  // { input: 'some\\path', output: 'some/path' }
  // { input: 'some\\path', output: 'some/path' }
  // { input: 'some\\path', output: 'some/path' }
};

const isMatch = micromatch.matcher('**', { onMatch, posixSlashes: true });
isMatch('some\\path');
isMatch('some\\path');
isMatch('some\\path');

options.onResult

const onResult = ({ glob, regex, input, output }) => {
  console.log({ glob, regex, input, output });
};

const isMatch = micromatch('*', { onResult, ignore: 'f*' });
isMatch('foo');
isMatch('bar');
isMatch('baz');

options.posixSlashes

Convert path separators on returned files to posix/unix-style forward slashes. Aliased as unixify for backwards compatibility.

Type: Boolean

Default: true on windows, false everywhere else.

Example

console.log(micromatch.match(['a\\b\\c'], 'a/**'));
//=> ['a/b/c']

console.log(micromatch.match(['a\\b\\c'], { posixSlashes: false }));
//=> ['a\\b\\c']

options.unescape

Remove backslashes from escaped glob characters before creating the regular expression to perform matches.

Type: Boolean

Default: undefined

Example

In this example we want to match a literal *:

console.log(micromatch.match(['abc', 'a\\*c'], 'a\\*c'));
//=> ['a\\*c']

console.log(micromatch.match(['abc', 'a\\*c'], 'a\\*c', { unescape: true }));
//=> ['a*c']

Extended globbing

Micromatch supports the following extended globbing features.

Extglobs

Extended globbing, as described by the bash man page:

pattern	regex equivalent	description
?(pattern)	(pattern)?	Matches zero or one occurrence of the given patterns
*(pattern)	(pattern)*	Matches zero or more occurrences of the given patterns
+(pattern)	(pattern)+	Matches one or more occurrences of the given patterns
@(pattern)	(pattern) *	Matches one of the given patterns
!(pattern)	N/A (equivalent regex is much more complicated)	Matches anything except one of the given patterns

^* Note that @ isn't a regex character.

Braces

Brace patterns can be used to match specific ranges or sets of characters.

Example

The pattern {f,b}*/{1..3}/{b,q}* would match any of following strings:

foo/1/bar
foo/2/bar
foo/3/bar
baz/1/qux
baz/2/qux
baz/3/qux

Visit braces to see the full range of features and options related to brace expansion, or to create brace matching or expansion related issues.

Regex character classes

Given the list: ['a.js', 'b.js', 'c.js', 'd.js', 'E.js']:

• [ac].js: matches both a and c, returning ['a.js', 'c.js']
• [b-d].js: matches from b to d, returning ['b.js', 'c.js', 'd.js']
• a/[A-Z].js: matches and uppercase letter, returning ['a/E.md']

Learn about regex character classes.

Regex groups

Given ['a.js', 'b.js', 'c.js', 'd.js', 'E.js']:

• (a|c).js: would match either a or c, returning ['a.js', 'c.js']
• (b|d).js: would match either b or d, returning ['b.js', 'd.js']
• (b|[A-Z]).js: would match either b or an uppercase letter, returning ['b.js', 'E.js']

As with regex, parens can be nested, so patterns like ((a|b)|c)/b will work. Although brace expansion might be friendlier to use, depending on preference.

POSIX bracket expressions

POSIX brackets are intended to be more user-friendly than regex character classes. This of course is in the eye of the beholder.

Example

console.log(micromatch.isMatch('a1', '[[:alpha:][:digit:]]')) //=> true
console.log(micromatch.isMatch('a1', '[[:alpha:][:alpha:]]')) //=> false

---

Notes

Bash 4.3 parity

Whenever possible matching behavior is based on behavior Bash 4.3, which is mostly consistent with minimatch.

However, it's suprising how many edge cases and rabbit holes there are with glob matching, and since there is no real glob specification, and micromatch is more accurate than both Bash and minimatch, there are cases where best-guesses were made for behavior. In a few cases where Bash had no answers, we used wildmatch (used by git) as a fallback.

Backslashes

There is an important, notable difference between minimatch and micromatch in regards to how backslashes are handled in glob patterns.

• Micromatch exclusively and explicitly reserves backslashes for escaping characters in a glob pattern, even on windows, which is consistent with bash behavior. More importantly, unescaping globs can result in unsafe regular expressions.
• Minimatch converts all backslashes to forward slashes, which means you can't use backslashes to escape any characters in your glob patterns.

We made this decision for micromatch for a couple of reasons:

• Consistency with bash conventions.
• Glob patterns are not filepaths. They are a type of regular language that is converted to a JavaScript regular expression. Thus, when forward slashes are defined in a glob pattern, the resulting regular expression will match windows or POSIX path separators just fine.

A note about joining paths to globs

Note that when you pass something like path.join('foo', '*') to micromatch, you are creating a filepath and expecting it to still work as a glob pattern. This causes problems on windows, since the path.sep is \\.

In other words, since \\ is reserved as an escape character in globs, on windows path.join('foo', '*') would result in foo\\*, which tells micromatch to match * as a literal character. This is the same behavior as bash.

To solve this, you might be inspired to do something like 'foo\\*'.replace(/\\/g, '/'), but this causes another, potentially much more serious, problem.

Benchmarks

Running benchmarks

Install dependencies for running benchmarks:

$ cd bench && npm install

Run the benchmarks:

$ npm run bench

Latest results

As of July 12, 2023 (longer bars are better):

# .makeRe star
  micromatch x 2,232,802 ops/sec ±2.34% (89 runs sampled))
  minimatch x 781,018 ops/sec ±6.74% (92 runs sampled))

# .makeRe star; dot=true
  micromatch x 1,863,453 ops/sec ±0.74% (93 runs sampled)
  minimatch x 723,105 ops/sec ±0.75% (93 runs sampled)

# .makeRe globstar
  micromatch x 1,624,179 ops/sec ±2.22% (91 runs sampled)
  minimatch x 1,117,230 ops/sec ±2.78% (86 runs sampled))

# .makeRe globstars
  micromatch x 1,658,642 ops/sec ±0.86% (92 runs sampled)
  minimatch x 741,224 ops/sec ±1.24% (89 runs sampled))

# .makeRe with leading star
  micromatch x 1,525,014 ops/sec ±1.63% (90 runs sampled)
  minimatch x 561,074 ops/sec ±3.07% (89 runs sampled)

# .makeRe - braces
  micromatch x 172,478 ops/sec ±2.37% (78 runs sampled)
  minimatch x 96,087 ops/sec ±2.34% (88 runs sampled)))

# .makeRe braces - range (expanded)
  micromatch x 26,973 ops/sec ±0.84% (89 runs sampled)
  minimatch x 3,023 ops/sec ±0.99% (90 runs sampled))

# .makeRe braces - range (compiled)
  micromatch x 152,892 ops/sec ±1.67% (83 runs sampled)
  minimatch x 992 ops/sec ±3.50% (89 runs sampled)d))

# .makeRe braces - nested ranges (expanded)
  micromatch x 15,816 ops/sec ±13.05% (80 runs sampled)
  minimatch x 2,953 ops/sec ±1.64% (91 runs sampled)

# .makeRe braces - nested ranges (compiled)
  micromatch x 110,881 ops/sec ±1.85% (82 runs sampled)
  minimatch x 1,008 ops/sec ±1.51% (91 runs sampled)

# .makeRe braces - set (compiled)
  micromatch x 134,930 ops/sec ±3.54% (63 runs sampled))
  minimatch x 43,242 ops/sec ±0.60% (93 runs sampled)

# .makeRe braces - nested sets (compiled)
  micromatch x 94,455 ops/sec ±1.74% (69 runs sampled))
  minimatch x 27,720 ops/sec ±1.84% (93 runs sampled))

Contributing

All contributions are welcome! Please read the contributing guide to get started.

Bug reports

Please create an issue if you encounter a bug or matching behavior that doesn't seem correct. If you find a matching-related issue, please:

• research existing issues first (open and closed)
• visit the GNU Bash documentation to see how Bash deals with the pattern
• visit the minimatch documentation to cross-check expected behavior in node.js
• if all else fails, since there is no real specification for globs we will probably need to discuss expected behavior and decide how to resolve it. which means any detail you can provide to help with this discussion would be greatly appreciated.

Platform issues

It's important to us that micromatch work consistently on all platforms. If you encounter any platform-specific matching or path related issues, please let us know (pull requests are also greatly appreciated).

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• braces: Bash-like brace expansion, implemented in JavaScript. Safer than other brace expansion libs, with complete support… more | homepage
• expand-brackets: Expand POSIX bracket expressions (character classes) in glob patterns. | homepage
• extglob: Extended glob support for JavaScript. Adds (almost) the expressive power of regular expressions to glob… more | homepage
• fill-range: Fill in a range of numbers or letters, optionally passing an increment or step to… more | homepage
• nanomatch: Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash… more | homepage

Contributors

Commits	Contributor
515	jonschlinkert
12	es128
9	danez
8	doowb
6	paulmillr
5	mrmlnc
3	DrPizza
2	TrySound
2	mceIdo
2	Glazy
2	MartinKolarik
2	antonyk
2	Tvrqvoise
1	amilajack
1	Cslove
1	devongovett
1	DianeLooney
1	UltCombo
1	frangio
1	joyceerhl
1	juszczykjakub
1	muescha
1	sebdeckers
1	tomByrer
1	fidian
1	curbengh
1	simlu
1	wtgtybhertgeghgtwtg
1	yvele

Author

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

Copyright © 2023, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.8.0, on July 12, 2023.

glob-fs's Issues

readdirSync is not a function

error: /Users/craigcosmo/Desktop/electron skeleton/webpack.config.babel.js:49
var files = _globFs2.default.readdirSync('*.js');
^

TypeError: _globFs2.default.readdirSync is not a function

Reproduce

import fs from 'fs'
import glob from 'glob-fs'
let files = glob.readdirSync('*.js');

console.log(files)

wishlist

Wishlist

Some user features that would be nice to have in a node.js file globbing lib:

• define patterns as a string or array
• allow ignore patterns to be passed on the options
• ignore node_modules by default. IMO it makes more sense for a user to explicitly define node_modules to include it.

API

• streams
• async
• sync

Code

• how much flexibility to we want to provide for negation patterns?
• is it important to allow users to un-negate previously negated patterns? If not, things become simpler, but I don't think we'll need to compromise on speed either way

README should be clear that this requires git to be on the PATH

It would be really great if the README made it clear that this package requires git to be on the path as well as carrying the "experimental" and "doesn't work on Windows" warnings which are shown on github. This would help make sure that devs who discover the package on www.npmjs.org are aware of these limitations before they spend time trying to try out the package.

Thanks.

lacking in glob pattern recognition

I have used glob-fs in my program for a faster glob experience. The full pattern recognition was not available. I ran many attempts with patterns similar to *!(.js) and every result included .js. This is unfortunate as this looks like a promising library.

dot files are not ignored

package: "glob-fs": "^0.1.6"

dot files (.git .gitignore ...) are included in my array results.

`readdirPromise` does not respect `file.exclude`

I'm using the Promise-based API which doesn't seem to respect the file.exclude property. The excluded files are still returned.

It does work with the other readdir methods

first pass

@doowb / @tunnckoCore

I just pushed up a first pass at this. there is still a lot of work to be done but I think the basic conventions are a good start. I'd love feedback on the following:

• multiple pattern support. suggestions for approach - obviously there are a few existing solutions that do this: globby, micromatch, multimatch etc. but I wanted to see if you guys had any ideas for how we could make it more dynamic. I decided to use a file object in glob-fs, since it really simplifies options handling, etc. I'm thinking that we might be able to implement some interesting ignore/unignore features that leverage this. maybe even something like the stash in jade/css/stylus.
• iterators: what can we do to make iterators smarter without making them more complicated? e.g. iterators should be able to passively include, passively exclude, actively include and actively exclude files based on configuration options, pattern matching, etc.

any other thoughts would be great!

npm audit give high status vulnerability

running npm audit with latest glob-fs gives:

High Prototype Pollution
Package set-value
Patched in >=2.0.1 <3.0.0 || >=3.0.1

Would you be updating package.json to use latest set-value (currently it is ^0.2.0).

Glob pattern is not filtering files as expected

Hi.
I was expecting glob to recursively list all files and (internally) reject all that don't match provided pattern. However, given following actions taken:

git clone https://github.com/ama-team/voxengine-sdk.git
cd voxengine-sdk
git checkout f2a0af
npm i glob-fs -D # installed version: 0.1.7
cat <<EOF > index.js   
var glob = require('glob-fs')
glob().readdirPromise('test/**/*.spec.js')
  .then(console.log.bind(console));
EOF
node index.js

I have following output:

[
  '/tmp/voxengine-sdk/test/mocha.opts', // unexpected
  '/tmp/voxengine-sdk/test/spec/http/_common.spec.js',
  '/tmp/voxengine-sdk/test/spec/http/basic.spec.js',
  '/tmp/voxengine-sdk/test/spec/http/rest.spec.js',
  '/tmp/voxengine-sdk/test/spec/logger/_common.spec.js',
  '/tmp/voxengine-sdk/test/spec/logger/slf4j.spec.js',
  '/tmp/voxengine-sdk/test/support/mocha-multi-reporters.json', // unexpected
  '/tmp/voxengine-sdk/test/support/setup.js' // unexpected
]

Looks like it's either me misinterpreting how this package is designed to work (and all of the above is valid output) or a bug

readdirSync is returning files from wrong path

given

``` debug(processing files at path ${process.cwd()} );

let fileProcessor = new FileProcessor(this._config);
fileProcessor.rootPath = process.cwd();
let files = glob.readdirSync(this._config.globPattern);
files.forEach( (file) => {```

where the process.cwd() is /Users/georgecook/Documents/h7ci/hope/opensource/navSpike/build/.roku-deploy-staging

and a globPattern of **/*.brs

I find the returned files have a path of .roku-deploy-staging/components/Framework/Core/BaseAggregateView.brs - this is wrong! that folder doesn't even exist - it's as if readdirSync is running the glob against build instead of build.roku-deploy-staging

I'll have to stop using this package if I can't get around this, as it's breaking my tools.

TypeError: Cannot read property 'realpath' of undefined

I get the below when using readdirPromise:
/Users/scott/Dropbox/Docs/Scripts/mail-restore-js/node_modules/glob-fs/lib/symlinks.js:38
self.realpath(file, cb);
^

TypeError: Cannot read property 'realpath' of undefined
    at /Users/scott/Dropbox/Docs/Scripts/mail-restore-js/node_modules/glob-fs/lib/symlinks.js:38:15
    at LOOP (fs.js:1609:14)
    at _combinedTickCallback (node.js:376:9)
    at process._tickCallback (node.js:407:11)

Full absolute path

Why does the module prepend it's own path to the passed path in readdirSync?

Surely this is an oversight?

npm ERR! Does not contain a package.json file

Facing issue on package installation.

npm ERR! code ENOLOCAL
npm ERR! Could not install from "node_modules/glob-fs/micromatch@github:jonschlinkert/micromatch#5017fd78202e04c684cc31d3c2fb1f469ea222ff" as it does not contain a package.json file.

Getting this Error on npm install
pacakge.json contains
"glob-fs": "^0.1.7",

node - 8.10.0
npm - 6.14.9

Please help with this issue.
@jonschlinkert

Problem using brace matcher

I hope this is just me not understanding glob syntax. I seem to be able to read test and src separately, but not together, joined in braces.

> var glob = require('glob-fs')();
undefined

> glob.readdirStream('../foopath/test/**').on('data', function(file) { console.log(file.path); }), null;
null
> /Users/steveluscher/.../foopath/test/testOneFile.js
/Users/steveluscher/.../foopath/test/testTwoFile.js

> glob.readdirStream('../foopath/src/**').on('data', function(file) { console.log(file.path); }), null;
null
> /Users/steveluscher/.../foopath/src/srcOneFile.js
/Users/steveluscher/.../foopath/src/srcTwoFile.js

> glob.readdirStream('{../foopath/src,../foopath/test}/**').on('data', function(file) { console.log(file.path); }), null;
null

Note that the same glob pattern used with ls lists all four files:

ls -al {../foopath/src,../foopath/test}/**

Multiple calls to readdirSync adds to the returned array

If I call globFs.readdirSync(path, {cwd: '/'}) multiple times I get a different array each time. The file list is being added to the last response each time.

Note I'm using the cwd param because I'm passing in absolute paths.

How does one scan a different folder?

All the examples show scanning the default folder. The docs vaguely indicate that I can modify glob.options.cwd, but it doesn't seem to do the trick. Specifying an absolute folder like /users/Kristian/** doesn't work either. Am I supposed to run process.chdir() to scan a specific folder?

cannot install with npm v5: No matching version found for [email protected]

$ node -v
v4.8.3
$ npm -v
5.0.1
$ npm i -g glob-fs
npm ERR! code ETARGET
npm ERR! notarget No matching version found for [email protected]
npm ERR! notarget In most cases you or one of your dependencies are requesting
npm ERR! notarget a package version that doesn't exist.
npm ERR! notarget 
npm ERR! notarget It was specified as a dependency of 'glob-fs'
npm ERR! notarget 

npm ERR! A complete log of this run can be found in:
npm ERR!     /home/user/.npm/_logs/2017-06-02T20_41_06_057Z-debug.log

Node.js was installed via nvm, and I upgraded npm to v5.

middlewares to be async

Im working on tunnckoCore/benz, which i think is awesome.
Because lies on top of great libs - async-done, now-and-later and co. Allows you to pass async, callback, generator functions, passing context through them; returning and yielding promises, thunks streams; handles errors and completion of all of them.

You can look at the tests for now. Also want to mention that it is almost like bach, but bach dont have options and flexibility that i need and want. You cant pass context to all of the functions with it. With benz you can pass context and can pass result of one middleware to next if you want. Support running on parallel and on series. Just look the tests, please :)

I will try to implement also to accept sync functions. It is little bit more work cuz promises and streams looks like sync functions, so it is lil' bit tricky to determine which is stream, which is sync, which is promise. But I believe it is possible.

You can try benz now (v0.2.0) here in glob-fs instead of custom calling middlewares - its ready, just need more tests and docs that I will add today.

With the title i mean like this

var glob = require('glob-fs')()

glob.use(function notemp(file, next) {
  if (/temp/.test(file.path)) {
    file.exclude = true
  }
  next(null, file)
})

or to be possible through option like async: true?

Replace micromatch github dependency

Could you please replace the micromatch github- by a npm-dependency?
This leads to trouble by firewall restrictions or deployments through inhouse npm caches. Thx!

async iterator example?

The TODO section of the readme says that async iterator support is done, but I don't see any examples in the readme...is it possible to for await with the current API?

middleware ideas

Anyone is free to create these. Middleware should be extremely specific. this keeps them very fast, more composable, and more likely to be interesting to more users

Please add a link to your middleware in the readme if you create one!

• glob-fs-tilde: expand a leading tilde to an absolute file path (using expand-tilde)
• glob-fs-bower-ignore: ignore files or directories specified in bower.json
• glob-fs-ignore-tests: ignore test files/fixtures automatically.

Any more ideas?

readdirAsync doesn't filter

When I try this

require('glob-fs')().readdirPromise('**/*.yaml').then((_)=>console.log(_))

I see just just all files in dir

I suppose that error is somewhere here:

    readdirPromise: function(pattern, options) {
      this.emit('read');
      this.setPattern(pattern, options);
      var res = this.iteratorPromise(this.pattern.base);  
      this.emit('end', this.files);
      return res;
    }

because it's strange to me that end is emitted before promise is resolved.

but change from this:

      this.emit('end', this.files);

to this:

      res.then(() => this.emit('end', this.files));

didn't help

Did I used this method properly? Or am I missing somethig? Or is there some error?

TypeError: Cannot read property 'split' of undefined

When trying to run the sync example from the website, I get the following error:

    return fp.split('\\').join('/');
             ^

TypeError: Cannot read property 'split' of undefined

For reference, here is the code:

var glob = require('glob-fs')({ gitignore: true });

var files = glob.readdirSync('**/*.js');
console.log(files);

My hunch is it involves line 74 of glob-fs/lib/pattern.js: this.base = path.join(this.cwd, this.parent);. Running the debugger, the path.join returns a nonsense path (the c:/ drive is in both this.cwd and this.parent and path.join just smashes them together).

Even if I fix the issue of this.pattern.re vs this.pattern.regex, I still get the same 'fp is undefined' error.

this.pattern.re vs: this.pattern.regex

When trying to use glob-fs 0.1.6 just right out of the box I had to do the following modification in index.js, to get it running:

    // if middleware are registered, use the glob, otherwise regex
    var glob = this.fns.length
      ? this.pattern.glob
      //: this.pattern.re; //<-- error
      : this.pattern.regex; //<-- fix

micromatch dependancy pulls from github not npm

The dependency for: "micromatch": "jonschlinkert/micromatch#2.2.0", pulls from github repo instead of npm. This breaks on firewalled networks that do not have access to public github. Can this be changed to pull from npm instead?

readdir case-insensitive wildcard

I work in Windows.

How would I go about looking for files like, for example, both:
*.txt and *.TXT

glob.readdir returns either the one or the other, but not both.

For example I have 2 files:
file1.txt
file2.TXT

Now, I want to find all files with extension txt (Upper and Lower case). How would I do that without calling 2 functions (*.txt and *.TXT) ?