micromatch
Advanced tools
Package description
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); // trueExpanding 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.
Changelog
[1.0.0] - 2016-12-12
Stable release.
Readme
Glob matching for javascript/node.js. A faster and more stable alternative to minimatch (bencharks show micromatch is 10-40x faster on avg).
Supports
All the mainstream glob features you're used to using in your gulp and Grunt tasks:
foo/bar-{1..5}.md, one/{two,three}/four.md)**/*, a/b/*.js, etc)OR (foo/bar/(abc|xyz).js)foo/bar/baz-[1-5].js)You can combine these features to achieve whatever matching patterns you need.
Does not support
npm i micromatch --save
Works exactly the same as minimatch.
var micromatch = require('micromatch');
micromatch(['a.js', 'b.md', 'c.txt'], '*.{js,txt}');
//=> ['a.js', 'c.txt']
Negation patterns:
micromatch(['a.js', 'b.md', 'c.txt'], '!*.{js,txt}');
//=> ['b.md']
micromatch(['a.md', 'b.js', 'c.txt', 'd.json'], ['*.*', '!*.{js,txt}']);
//=> ['a.md', 'd.json']
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.
Square brackets
Given ['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.
Parentheses
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.
Brace Expansion
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:
a{1..3}b/*.js expands to: ['a1b/*.js', 'a2b/*.js', 'a3b/*.js']Learn about brace expansion, or 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.
Generate a regular expression for matching file paths based on the given pattern:
micromatch.makeRe('a/?/c.md');
//=> /^a\/.\/c\.md$/
Run the benchmarks
node benchmark/
Install dev dependencies
npm i -d && mocha
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!
Jon Schlinkert
Copyright (c) 2014 Jon Schlinkert
Released under the MIT license
This file was generated by verb on December 28, 2014.
FAQs
Glob matching for javascript/node.js. A replacement and faster alternative to minimatch and multimatch.
We found that micromatch demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 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
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.