Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.
Table of Contents
- Install
- Quickstart
- Why use micromatch?
- Switching to micromatch
- API
- Options
- options.basename
- options.bash
- options.cache
- options.dot
- options.failglob
- options.ignore
- options.matchBase
- options.nobrace
- options.nocase
- options.nodupes
- options.noext
- options.nonegate
- options.noglobstar
- options.nonull
- options.nullglob
- options.snapdragon
- options.sourcemap
- options.unescape
- options.unixify
- Extended globbing
- Notes
- Contributing
- Benchmarks
- About
Install with npm:
$ npm install --save micromatch
var mm = require('micromatch');
mm(list, patterns[, options]);
The main export takes a list of strings and one or more glob patterns:
console.log(mm(['foo', 'bar', 'qux'], ['f*', 'b*']));
//=> ['foo', 'bar']
Use .isMatch() to get true/false:
console.log(mm.isMatch('foo', 'f*'));
//=> true
Switching from minimatch and multimatch is easy!
micromatch is a drop-in replacement for minimatch and multimatch
- Supports all of the same matching features as minimatch and multimatch
- Micromatch uses snapdragon for parsing and compiling globs, which provides granular control over the entire conversion process in a way that is easy to understand, reason about, and maintain.
- More consistently accurate matching than minimatch, with more than 36,000 test assertions to prove it.
- More complete support for the Bash 4.3 specification than minimatch and multimatch. In fact, micromatch passes all of the spec tests from bash, including some that bash still fails.
- Faster matching, from a combination of optimized glob patterns, faster algorithms, and regex caching.
- Micromatch is safer, and is not subject to DoS with brace patterns, like minimatch and multimatch.
- More reliable windows support than minimatch and multimatch.
- 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!
There is one notable difference between micromatch and minimatch in regards to how backslashes are handled. See the notes about backslashes for more information.
Use mm.isMatch() instead of minimatch()
:
mm.isMatch('foo', 'b*');
//=> false
Use mm.match() instead of minimatch.match()
:
mm.match(['foo', 'bar'], 'b*');
//=> 'bar'
Same signature:
mm(['foo', 'bar', 'baz'], ['f*', '*z']);
//=> ['foo', 'baz']
The main function takes a list of strings and one or more glob patterns to use for matching.
Params
list
{Array}: A list of strings to matchpatterns
{String|Array}: One or more glob patterns to use for matching.options
{Object}: See available options for changing how matches are performedreturns
{Array}: Returns an array of matches
Example
var mm = require('micromatch');
mm(list, patterns[, options]);
console.log(mm(['a.js', 'a.txt'], ['*.js']));
//=> [ 'a.js' ]
Similar to the main function, but pattern
must be a string.
Params
list
{Array}: Array of strings to matchpattern
{String}: Glob pattern to use for matching.options
{Object}: See available options for changing how matches are performedreturns
{Array}: Returns an array of matches
Example
var mm = require('micromatch');
mm.match(list, pattern[, options]);
console.log(mm.match(['a.a', 'a.aa', 'a.b', 'a.c'], '*.a'));
//=> ['a.a', 'a.aa']
Returns true if the specified string
matches the given glob pattern
.
Params
string
{String}: String to matchpattern
{String}: Glob pattern to use for matching.options
{Object}: See available options for changing how matches are performedreturns
{Boolean}: Returns true if the string matches the glob pattern.
Example
var mm = require('micromatch');
mm.isMatch(string, pattern[, options]);
console.log(mm.isMatch('a.a', '*.a'));
//=> true
console.log(mm.isMatch('a.b', '*.a'));
//=> false
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 performedreturns
{Boolean}: Returns true if any patterns matchstr
Example
var 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
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 performedreturns
{Boolean}: Returns true if any patterns matchstr
Example
var 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
Returns true if any of the given glob 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 performedreturns
{Boolean}: Returns true if any patterns matchstr
Example
var mm = require('micromatch');
mm.any(string, patterns[, options]);
console.log(mm.any('a.a', ['b.*', '*.a']));
//=> true
console.log(mm.any('a.a', 'b.*'));
//=> false
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 performedreturns
{Boolean}: Returns true if any patterns matchstr
Example
var 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
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 performedreturns
{Array}: Returns an array of strings that do not match the given patterns.
Example
var mm = require('micromatch');
mm.not(list, patterns[, options]);
console.log(mm.not(['a.a', 'b.b', 'c.c'], '*.a'));
//=> ['b.b', 'c.c']
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 performedreturns
{Boolean}: Returns true if the patter matches any part ofstr
.
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
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 performedreturns
{Object}: Returns an object with only keys that match the given patterns.
Example
var mm = require('micromatch');
mm.matchKeys(object, patterns[, options]);
var obj = { aa: 'a', ab: 'b', ac: 'c' };
console.log(mm.matchKeys(obj, '*b'));
//=> { ab: 'b' }
Returns a memoized 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 patternoptions
{Object}: See available options for changing how matches are performed.returns
{Function}: Returns a matcher function.
Example
var mm = require('micromatch');
mm.matcher(pattern[, options]);
var isMatch = mm.matcher('*.!(*a)');
console.log(isMatch('a.a'));
//=> false
console.log(isMatch('a.b'));
//=> true
Create a regular expression from the given glob pattern
.
Params
pattern
{String}: A glob pattern to convert to regex.options
{Object}: See available options for changing how matches are performed.returns
{RegExp}: Returns a regex created from the given pattern.
Example
var mm = require('micromatch');
mm.makeRe(pattern[, options]);
console.log(mm.makeRe('*.js'));
//=> /^(?:(\.[\\\/])?(?!\.)(?=.)[^\/]*?\.js)$/
Expand the given brace pattern
.
Params
pattern
{String}: String with brace pattern to expand.options
{Object}: Any options to change how expansion is performed. See the braces library for all available options.returns
{Array}
Example
var mm = require('micromatch');
console.log(mm.braces('foo/{a,b}/bar'));
//=> ['foo/(a|b)/bar']
console.log(mm.braces('foo/{a,b}/bar', {expand: true}));
//=> ['foo/(a|b)/bar']
Parses the given glob pattern
and returns an array of abstract syntax trees (ASTs), with the compiled output
and optional source map
on each AST.
Params
pattern
{String}: Glob pattern to parse and compile.options
{Object}: Any options to change how parsing and compiling is performed.returns
{Object}: Returns an object with the parsed AST, compiled string and optional source map.
Example
var mm = require('micromatch');
mm.create(pattern[, options]);
console.log(mm.create('abc/*.js'));
// [{ options: { source: 'string', sourcemap: true },
// state: {},
// compilers:
// { ... },
// output: '(\\.[\\\\\\/])?abc\\/(?!\\.)(?=.)[^\\/]*?\\.js',
// ast:
// { type: 'root',
// errors: [],
// nodes:
// [ ... ],
// dot: false,
// input: 'abc/*.js' },
// parsingErrors: [],
// map:
// { version: 3,
// sources: [ 'string' ],
// names: [],
// mappings: 'AAAA,GAAG,EAAC,kBAAC,EAAC,EAAE',
// sourcesContent: [ 'abc/*.js' ] },
// position: { line: 1, column: 28 },
// content: {},
// files: {},
// idx: 6 }]
Parse the given str
with the given options
.
Params
str
{String}options
{Object}returns
{Object}: Returns an AST
Example
var mm = require('micromatch');
mm.parse(pattern[, options]);
var ast = mm.parse('a/{b,c}/d');
console.log(ast);
// { type: 'root',
// errors: [],
// input: 'a/{b,c}/d',
// nodes:
// [ { type: 'bos', val: '' },
// { type: 'text', val: 'a/' },
// { type: 'brace',
// nodes:
// [ { type: 'brace.open', val: '{' },
// { type: 'text', val: 'b,c' },
// { type: 'brace.close', val: '}' } ] },
// { type: 'text', val: '/d' },
// { type: 'eos', val: '' } ] }
Compile the given ast
or string with the given options
.
Params
ast
{Object|String}options
{Object}returns
{Object}: Returns an object that has anoutput
property with the compiled string.
Example
var mm = require('micromatch');
mm.compile(ast[, options]);
var ast = mm.parse('a/{b,c}/d');
console.log(mm.compile(ast));
// { options: { source: 'string' },
// state: {},
// compilers:
// { eos: [Function],
// noop: [Function],
// bos: [Function],
// brace: [Function],
// 'brace.open': [Function],
// text: [Function],
// 'brace.close': [Function] },
// output: [ 'a/(b|c)/d' ],
// ast:
// { ... },
// parsingErrors: [] }
Clear the regex cache.
Example
mm.clearCache();
- basename
- bash
- cache
- dot
- failglob
- ignore
- matchBase
- nobrace
- nocase
- nodupes
- noext
- noglobstar
- nonull
- nullglob
- snapdragon
- sourcemap
- unescape
- unixify
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
mm(['a/b.js', 'a/c.md'], '*.js');
//=> []
mm(['a/b.js', 'a/c.md'], '*.js', {matchBase: true});
//=> ['a/b.js']
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 an other star.
Type: Boolean
Default: true
Example
var files = ['abc', 'ajz'];
console.log(mm(files, '[a-c]*'));
//=> ['abc', 'ajz']
console.log(mm(files, '[a-c]*', {bash: false}));
Disable regex and function memoization.
Type: Boolean
Default: undefined
Match dotfiles. Same behavior as minimatch option dot
.
Type: Boolean
Default: false
Similar to the --failglob
behavior in Bash, throws an error when no matches are found.
Type: Boolean
Default: undefined
String or array of glob patterns to match files to ignore.
Type: String|Array
Default: undefined
Alias for options.basename.
Disable expansion of brace patterns. Same behavior as minimatch option nobrace
.
Type: Boolean
Default: undefined
See braces for more information about extended brace expansion.
Use a case-insensitive regex for matching files. Same behavior as minimatch.
Type: Boolean
Default: undefined
Remove duplicate elements from the result array.
Type: Boolean
Default: undefined
Example
Example of using the unescape
and nodupes
options together:
mm.match(['a/b/c', 'a/b/c'], 'a/b/c');
//=> ['a/b/c', 'a/b/c']
mm.match(['a/b/c', 'a/b/c'], 'a/b/c', {nodupes: true});
//=> ['abc']
Disable extglob support, so that extglobs are regarded as literal characters.
Type: Boolean
Default: undefined
Examples
mm(['a/z', 'a/b', 'a/!(z)'], 'a/!(z)');
//=> ['a/b', 'a/!(z)']
mm(['a/z', 'a/b', 'a/!(z)'], 'a/!(z)', {noext: true});
//=> ['a/!(z)'] (matches only as literal characters)
Disallow negation (!
) patterns, and treat leading !
as a literal character to match.
Type: Boolean
Default: undefined
Disable matching with globstars (**
).
Type: Boolean
Default: undefined
mm(['a/b', 'a/b/c', 'a/b/c/d'], 'a/**');
//=> ['a/b', 'a/b/c', 'a/b/c/d']
mm(['a/b', 'a/b/c', 'a/b/c/d'], 'a/**', {noglobstar: true});
//=> ['a/b']
Alias for 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
Pass your own instance of snapdragon, to customize parsers or compilers.
Type: Object
Default: undefined
Generate a source map by enabling the sourcemap
option with the .parse
, .compile
, or .create
methods.
(Note that sourcemaps are currently not enabled for brace patterns)
Examples
var mm = require('micromatch');
var pattern = '*(*(of*(a)x)z)';
var res = mm.create('abc/*.js', {sourcemap: true});
console.log(res.map);
// { version: 3,
// sources: [ 'string' ],
// names: [],
// mappings: 'AAAA,GAAG,EAAC,iBAAC,EAAC,EAAE',
// sourcesContent: [ 'abc/*.js' ] }
var ast = mm.parse('abc/**/*.js');
var res = mm.compile(ast, {sourcemap: true});
console.log(res.map);
// { version: 3,
// sources: [ 'string' ],
// names: [],
// mappings: 'AAAA,GAAG,EAAC,2BAAE,EAAC,iBAAC,EAAC,EAAE',
// sourcesContent: [ 'abc/**/*.js' ] }
var ast = mm.parse(pattern);
var res = mm.compile(ast, {sourcemap: true});
console.log(res.map);
// { version: 3,
// sources: [ 'string' ],
// names: [],
// mappings: 'AAAA,CAAE,CAAE,EAAE,CAAE,CAAC,EAAC,CAAC,EAAC,CAAC,EAAC',
// sourcesContent: [ '*(*(of*(a)x)z)' ] }
Remove backslashes from returned matches.
Type: Boolean
Default: undefined
Example
In this example we want to match a literal *
:
mm.match(['abc', 'a\\*c'], 'a\\*c');
//=> ['a\\*c']
mm.match(['abc', 'a\\*c'], 'a\\*c', {unescape: true});
//=> ['a*c']
Convert path separators on returned files to posix/unix-style forward slashes.
Type: Boolean
Default: true
on windows, false
everywhere else
Example
mm.match(['a\\b\\c'], 'a/**');
//=> ['a/b/c']
mm.match(['a\\b\\c'], {unixify: false});
//=> ['a\\b\\c']
Micromatch also supports extended globbing features.
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.
Powered by extglob. Visit that library for the full range of options or to report extglob related issues.
Brace patterns can be used to match specific ranges or sets of characters. For example, the pattern */{1..3}/*
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.
Given the list: ['a.js', 'b.js', 'c.js', 'd.js', 'E.js']
:
[ac].js
: matches botha
andc
, returning['a.js', 'c.js']
[b-d].js
: matches fromb
tod
, returning['b.js', 'c.js', 'd.js']
[b-d].js
: matches fromb
tod
, returning['b.js', 'c.js', 'd.js']
a/[A-Z].js
: matches and uppercase letter, returning['a/E.md']
Learn about regex character classes.
Given ['a.js', 'b.js', 'c.js', 'd.js', 'E.js']
:
(a|c).js
: would match eithera
orc
, returning['a.js', 'c.js']
(b|d).js
: would match eitherb
ord
, returning['b.js', 'd.js']
(b|[A-Z]).js
: would match eitherb
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 brackets are intended to be more user-friendly than regex character classes. This of course is in the eye of the beholder.
Example
mm.isMatch('a1', '[[:alpha:][:digit:]]');
//=> true
mm.isMatch('a1', '[[:alpha:][:alpha:]]');
//=> false
See expand-brackets for more information about bracket expressions.
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.
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. This is consistent with bash behavior.
- 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.
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).
Install dev dependencies:
npm i -d && npm run benchmark
As of June 02, 2017 (longer bars are better):
# braces-globstar-large-list
micromatch ██████████████████████████████████████████████████ (595 ops/sec)
minimatch █ (13.95 ops/sec)
multimatch █ (14.09 ops/sec)
# braces-multiple
micromatch ██████████████████████████████████████████████████ (48,362 ops/sec)
minimatch (2.18 ops/sec)
multimatch (2.15 ops/sec)
# braces-range
micromatch ██████████████████████████████████████████████████ (187,481 ops/sec)
minimatch ███ (12,366 ops/sec)
multimatch ███ (11,841 ops/sec)
# braces-set
micromatch ██████████████████████████████████████████████████ (24,344 ops/sec)
minimatch ████ (2,255 ops/sec)
multimatch ████ (2,199 ops/sec)
# globstar-large-list
micromatch ██████████████████████████████████████████████████ (561 ops/sec)
minimatch ██ (25.43 ops/sec)
multimatch ██ (25.27 ops/sec)
# globstar-long-list
micromatch ██████████████████████████████████████████████████ (3,257 ops/sec)
minimatch ███████ (485 ops/sec)
multimatch ███████ (485 ops/sec)
# globstar-short-list
micromatch ██████████████████████████████████████████████████ (359,991 ops/sec)
minimatch ██████ (44,763 ops/sec)
multimatch █████ (39,977 ops/sec)
# no-glob
micromatch ██████████████████████████████████████████████████ (443,740 ops/sec)
minimatch ████ (44,152 ops/sec)
multimatch ████ (41,077 ops/sec)
# star-basename
micromatch ██████████████████████████████████████████████████ (10,286 ops/sec)
minimatch ██████████████ (3,059 ops/sec)
multimatch ███████████████ (3,129 ops/sec)
# star
micromatch ██████████████████████████████████████████████████ (9,756 ops/sec)
minimatch ███████████████ (2,978 ops/sec)
multimatch ███████████████ (2,970 ops/sec)
- 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
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.
Commits | Contributor |
---|---|
423 | jonschlinkert |
12 | es128 |
3 | paulmillr |
2 | TrySound |
2 | doowb |
2 | MartinKolarik |
2 | tunnckoCore |
1 | amilajack |
1 | DianeLooney |
1 | UltCombo |
1 | tomByrer |
(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
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
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on June 02, 2017.