Security News
Highlights from the 2024 Rails Community Survey
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
micromatch
Advanced tools
Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just use `micromatch.isMatch()` instead of `minimatch()`, or use `micromatch()` instead of `multimatch()`.
The micromatch npm package is a fast, minimal glob utility for node.js and JavaScript. It is used to parse, match, and expand glob patterns against strings to filter, validate, or manipulate file paths, names, and other string lists.
Matching glob patterns
Match an array of strings to a glob pattern. In this example, it filters the list to include only files ending with '.js'.
const micromatch = require('micromatch');
const result = micromatch(['foo.js', 'bar.js'], '*.js');
console.log(result); // ['foo.js', 'bar.js']
Negating glob patterns
Use negation patterns to exclude matches. This example matches all '.js' files but excludes 'foo.js'.
const micromatch = require('micromatch');
const result = micromatch(['foo.js', 'bar.js', 'baz.txt'], ['*.js', '!foo.js']);
console.log(result); // ['bar.js']
Testing a filepath
Test a single filepath against a glob pattern to see if it matches. In this case, 'foobar.js' is a match for '*.js'.
const micromatch = require('micromatch');
const isMatch = micromatch.isMatch('foobar.js', '*.js');
console.log(isMatch); // true
Expanding braces
Expand braces in glob patterns to match multiple patterns. This example matches 'foo.js' and 'foo1.js' with a single pattern.
const micromatch = require('micromatch');
const result = micromatch(['foo.js', 'foo1.js'], 'foo{,1}.js');
console.log(result); // ['foo.js', 'foo1.js']
Minimatch is a minimal matching utility that works with glob patterns. It is the matcher used internally by npm (at least at the time of writing), but it is slower and less feature-rich compared to micromatch.
Globby is a wrapper for fast-glob and supports multiple patterns. It provides a higher-level API for matching against file paths and is built on top of micromatch, offering additional features like file system operations.
Fast-glob is a fast implementation of glob functionality with a focus on performance. It provides a similar API to micromatch but includes additional features like returning file stats along with matched paths.
Node-glob is an older glob implementation for Node.js. It is callback-based and not as performant or modern as micromatch, but it has been widely used in the Node.js ecosystem.
Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just use
micromatch.isMatch()
instead ofminimatch()
, or usemicromatch()
instead ofmultimatch()
.
Install with npm
$ npm i micromatch --save
(Table of contents generated by verb)
Micromatch is 10-55x faster than minimatch, resulting from a combination of caching, tokenization, parsing, runtime compilation and regex optimization strategies.
['foo/*.js', '!bar.js']
Mainstream glob features:
foo/bar-{1..5}.md
, one/{two,three}/four.md
)**/*
, a/b/*.js
, or ['foo/*.js', '!bar.js']
Extended globbing features:
OR
(foo/bar/(abc|xyz).js
)foo/bar/baz-[1-5].js
)**/[[:alpha:][:digit:]]/
)**/+(x|y)
, !(a|b)
, etc)You can combine these to create whatever matching patterns you need.
var mm = require('micromatch');
mm(array, patterns);
Examples
mm(['a.js', 'b.md', 'c.txt'], '*.{js,txt}');
//=> ['a.js', 'c.txt']
Multiple patterns
Multiple patterns can also be passed:
mm(['a.md', 'b.js', 'c.txt', 'd.json'], ['*.md', '*.txt']);
//=> ['a.md', 'c.txt']
Negation patterns:
Behavior;
mm(['a.js', 'b.md', 'c.txt'], '!*.{js,txt}');
//=> ['b.md']
mm(['a.md', 'b.js', 'c.txt', 'd.json'], ['*.*', '!*.{js,txt}']);
//=> ['a.md', 'd.json']
Use
micromatch.isMatch()
instead ofminimatch()
Minimatch
The main minimatch()
function returns true/false for a single file path and pattern:
var minimatch = require('minimatch');
minimatch('foo.js', '*.js');
//=> 'true'
Micromatch
With micromatch, .isMatch()
to get the same result:
var mm = require('micromatch');
mm.isMatch('foo.js', '*.js');
//=> 'true'
This implementation difference is necessary since the main micromatch()
method supports matching on multiple globs, with behavior similar to multimatch.
var mm = require('micromatch');
mm.isMatch(filepath, globPattern);
Returns true if a file path matches the given glob pattern.
Example
mm.isMatch('.verb.md', '*.md');
//=> false
mm.isMatch('.verb.md', '*.md', {dot: true});
//=> true
Returns true if any part of a file path matches the given glob pattern. Think of this is "has path" versus "is path".
Example
.isMatch()
would return false for both of the following:
mm.contains('a/b/c', 'a/b');
//=> true
mm.contains('a/b/c', 'a/*');
//=> true
Returns a function for matching using the supplied pattern. e.g. create your own "matcher". The advantage of this method is that the pattern can be compiled outside of a loop.
Pattern
Can be any of the following:
glob/string
regex
function
Example
var isMatch = mm.matcher('*.md');
var files = [];
['a.md', 'b.txt', 'c.md'].forEach(function(fp) {
if (isMatch(fp)) {
files.push(fp);
}
});
Returns a function that can be passed to Array#filter()
.
Params
patterns
{String|Array}:Examples
Single glob:
var fn = mm.filter('*.md');
['a.js', 'b.txt', 'c.md'].filter(fn);
//=> ['c.md']
var fn = mm.filter('[a-c]');
['a', 'b', 'c', 'd', 'e'].filter(fn);
//=> ['a', 'b', 'c']
Array of glob patterns:
var arr = [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15];
var fn = mm.filter(['{1..10}', '![7-9]', '!{3..4}']);
arr.filter(fn);
//=> [1, 2, 5, 6, 10]
(Internally this function generates the matching function by using the matcher method. You can use the matcher method directly to create your own filter function)
Returns true if a file path matches any of the given patterns.
mm.any(filepath, patterns, options);
Params
{String}
: The file path to test.{String|Array}
: One or more glob patterns{Object}
: options to pass to the .matcher()
method.Example
mm.any('abc', ['!*z']);
//=> true
mm.any('abc', ['a*', 'z*']);
//=> true
mm.any('abc', 'a*');
//=> true
mm.any('abc', ['z*']);
//=> false
Returns an object with a regex-compatible string and tokens.
mm.expand('*.js');
// when `track` is enabled (for debugging), the `history` array is used
// to record each mutation to the glob pattern as it's converted to regex
{ options: { track: false, dot: undefined, makeRe: true, negated: false },
pattern: '(.*\\/|^)bar\\/(?:(?!(?:^|\\/)\\.).)*?',
history: [],
tokens:
{ path:
{ whole: '**/bar/**',
dirname: '**/bar/',
filename: '**',
basename: '**',
extname: '',
ext: '' },
is:
{ glob: true,
negated: false,
globstar: true,
dotfile: false,
dotdir: false },
match: {},
original: '**/bar/**',
pattern: '**/bar/**',
base: '' } }
Create a regular expression for matching file paths based on the given pattern:
mm.makeRe('*.js');
//=> /^(?:(?!\.)(?=.)[^/]*?\.js)$/
Normalize slashes in file paths and glob patterns to forward slashes.
Type: {Boolean}
Default: undefined
on non-windows, true
on windows.
Match dotfiles. Same behavior as minimatch.
Type: {Boolean}
Default: false
Unescape slashes in glob patterns. Use cautiously, especially on windows.
Type: {Boolean}
Default: undefined
Example
mm.isMatch('abc', '\\a\\b\\c', {unescape: true});
//=> true
Remove duplicate elements from the result array.
Type: {Boolean}
Default: undefined
Example
Example of using the unescape
and nodupes
options together:
mm.match(['abc', '\\a\\b\\c'], '\\a\\b\\c', {unescape: true});
//=> ['abc', 'abc']
mm.match(['abc', '\\a\\b\\c'], '\\a\\b\\c', {unescape: true, nodupes: true});
//=> ['abc']
Allow glob patterns without slashes to match a file path based on its basename. . Same behavior as minimatch.
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']
Don't expand braces in glob patterns. Same behavior as minimatch nobrace
.
Type: {Boolean}
Default: undefined
See braces for more information about extended brace expansion.
Don't expand POSIX bracket expressions.
Type: {Boolean}
Default: undefined
See expand-brackets for more information about extended bracket expressions.
Don't expand extended globs.
Type: {Boolean}
Default: undefined
See extglob for more information about extended globs.
Use a case-insensitive regex for matching files. Same behavior as minimatch.
Type: {Boolean}
Default: false
If true
, when no matches are found the actual (array-ified) glob pattern is returned instead of an empty array. Same behavior as minimatch.
Type: {Boolean}
Default: false
Cache the platform (e.g. win32
) to prevent this from being looked up for every filepath.
Type: {Boolean}
Default: true
Micromatch also supports the following.
Extended globbing, as described by the bash man page:
pattern | regex equivalent | description |
---|---|---|
?(pattern-list) | `(... | ...)?` |
*(pattern-list) | `(... | ...)*` |
+(pattern-list) | `(... | ...)+` |
@(pattern-list) | `(... | ...)` * |
!(pattern-list) | N/A | Matches anything except one of the given patterns |
* @
isn't a RegEx character.
Powered by extglob. Visit that library for the full range of options or to report extglob related issues.
See extglob for more information about extended globs.
In simple cases, brace expansion appears to work the same way as the logical OR
operator. For example, (a|b)
will achieve the same result as {a,b}
.
Here are some powerful features unique to brace expansion (versus character classes):
a{1..3}b/*.js
expands to: ['a1b/*.js', 'a2b/*.js', 'a3b/*.js']
a{c,{d,e}}b/*.js
expands to: ['acb/*.js', 'adb/*.js', 'aeb/*.js']
Visit braces to ask questions and create an issue related to brace-expansion, or to see the full range of features and options related to brace expansion.
With the exception of brace expansion ({a,b}
, {1..5}
, etc), most of the special characters convert directly to regex, so you can expect them to follow the same rules and produce the same results as regex.
For example, 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']
[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.
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, parenthese can be nested, so patterns like ((a|b)|c)/b
will work. But it might be easier to achieve your goal using brace expansion.
Example
mm.isMatch('a1', '[[:alpha:][:digit:]]');
//=> true
See expand-brackets for more information about extended bracket expressions.
Whenever possible parsing behavior for patterns is based on globbing specifications in Bash 4.3. Patterns that aren't described by Bash follow wildmatch spec (used by git).
Run the benchmarks:
node benchmark
As of July 24, 2015:
#1: basename-braces
micromatch x 28,335 ops/sec ±0.49% (96 runs sampled)
minimatch x 3,496 ops/sec ±0.76% (98 runs sampled)
#2: basename
micromatch x 28,602 ops/sec ±0.46% (96 runs sampled)
minimatch x 4,389 ops/sec ±0.38% (98 runs sampled)
#3: braces-no-glob
micromatch x 405,445 ops/sec ±0.64% (91 runs sampled)
minimatch x 31,078 ops/sec ±0.45% (95 runs sampled)
#4: braces
micromatch x 81,977 ops/sec ±0.36% (99 runs sampled)
minimatch x 2,986 ops/sec ±0.41% (100 runs sampled)
#5: immediate
micromatch x 20,753 ops/sec ±0.36% (101 runs sampled)
minimatch x 4,233 ops/sec ±0.34% (100 runs sampled)
#6: large
micromatch x 755 ops/sec ±0.53% (97 runs sampled)
minimatch x 17.06 ops/sec ±0.25% (46 runs sampled)
#7: long
micromatch x 7,009 ops/sec ±0.33% (100 runs sampled)
minimatch x 592 ops/sec ±0.39% (96 runs sampled)
#8: mid
micromatch x 60,071 ops/sec ±0.48% (97 runs sampled)
minimatch x 1,853 ops/sec ±0.72% (99 runs sampled)
#9: multi-patterns
micromatch x 24,308 ops/sec ±0.67% (98 runs sampled)
minimatch x 2,169 ops/sec ±0.62% (96 runs sampled)
#10: no-glob
micromatch x 552,116 ops/sec ±0.35% (96 runs sampled)
minimatch x 55,957 ops/sec ±0.32% (94 runs sampled)
#11: range
micromatch x 321,030 ops/sec ±0.62% (95 runs sampled)
minimatch x 14,247 ops/sec ±0.59% (100 runs sampled)
#12: shallow
micromatch x 253,455 ops/sec ±0.52% (99 runs sampled)
minimatch x 21,169 ops/sec ±0.54% (97 runs sampled)
#13: short
micromatch x 661,874 ops/sec ±0.42% (96 runs sampled)
minimatch x 60,228 ops/sec ±0.45% (97 runs sampled)
Install dev dependencies:
$ npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue
Please be sure to run the benchmarks before/after any code changes to judge the impact before you do a PR. thanks!
true
if the given string looks like a… moreJon Schlinkert
Copyright © 2014-2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb-cli on July 24, 2015.
FAQs
Glob matching for javascript/node.js. A replacement and faster alternative to minimatch and multimatch.
The npm package micromatch receives a total of 54,298,870 weekly downloads. As such, micromatch popularity was classified as popular.
We found that micromatch demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.