nanomatch
![Windows Build Status](https://img.shields.io/appveyor/ci/jonschlinkert/nanomatch.svg?style=flat&label=AppVeyor)
Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash 4.3 wildcard support only (no support for exglobs, posix brackets or braces)
Table of Contents
(TOC generated by verb using markdown-toc)
What is nanomatch?
Nanomatch is a fast and accurate glob matcher with full support for standard Bash glob features, including the following "metacharacters": *
, **
, ?
and [...]
.
Learn more
- Features: info about supported patterns, and a glob matching reference
- API documentation: available options and methods
- Unit tests: there is no better way to learn a code library than spending time the unit tests. Nanomatch has 36,000 of them - go become a glob matching ninja!
How is this different from micromatch?
Micromatch supports 4 additional bash "expansion" types beyond the wildcard matching provided by nanomatch. (micromatch v3.0.0 will begin using the nanomatch parser and compiler for glob matching)
Getting started
var nanomatch = require('nanomatch');
nanomatch(list, patterns[, options]);
Params
list
{String|Array}: One or more strings to match against. This is often a list of files.patterns
{String|Array}: One or more glob paterns to use for matching.options
{Object}: Visit the API to learn about available options.
Example
var nm = require('nanomatch');
console.log(nm(['a', 'b/b', 'c/c/c'], '*'));
console.log(nm(['a', 'b/b', 'c/c/c'], '*/*'));
console.log(nm(['a', 'b/b', 'c/c/c'], '**'));
Additional detail provided in the API documentation.
API
The main function takes a list of strings and one or more glob patterns to use for matching.
Example
var nm = require('nanomatch');
nm(list, patterns[, options]);
console.log(nm(['a.js', 'a.txt'], ['*.js']));
Params
list
{Array}: A list of strings to matchpatterns
{String|Array}: One or more glob patterns to use for matching.options
{Object}: Any options to change how matches are performedreturns
{Array}: Returns an array of matches
Similar to the main function, but pattern
must be a string.
Example
var nm = require('nanomatch');
nm.match(list, pattern[, options]);
console.log(nm.match(['a.a', 'a.aa', 'a.b', 'a.c'], '*.a'));
Params
list
{Array}: Array of strings to matchpattern
{String}: Glob pattern to use for matching.options
{Object}: Any options to change how matches are performedreturns
{Array}: Returns an array of matches
Returns true if the specified string
matches the given glob pattern
.
Example
var nm = require('nanomatch');
nm.isMatch(string, pattern[, options]);
console.log(nm.isMatch('a.a', '*.a'));
console.log(nm.isMatch('a.b', '*.a'));
Params
string
{String}: String to matchpattern
{String}: Glob pattern to use for matching.options
{Object}: Any options to change how matches are performedreturns
{Boolean}: Returns true if the string matches the glob pattern.
Returns a list of strings that DO NOT MATCH any of the given patterns
.
Example
var nm = require('nanomatch');
nm.not(list, patterns[, options]);
console.log(nm.not(['a.a', 'b.b', 'c.c'], '*.a'));
Params
list
{Array}: Array of strings to match.patterns
{String|Array}: One or more glob pattern to use for matching.options
{Object}: Any options to change how matches are performedreturns
{Array}: Returns an array of strings that do not match the given patterns.
Returns true if the given string
matches any of the given glob patterns
.
Example
var nm = require('nanomatch');
nm.any(string, patterns[, options]);
console.log(nm.any('a.a', ['b.*', '*.a']));
console.log(nm.any('a.a', 'b.*'));
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}: Any options to change how matches are performedreturns
{Boolean}: Returns true if any patterns match str
Returns true if the given string
contains the given pattern. Similar to .isMatch but the pattern can match any part of the string.
Example
var nm = require('nanomatch');
nm.contains(string, pattern[, options]);
console.log(nm.contains('aa/bb/cc', '*b'));
console.log(nm.contains('aa/bb/cc', '*d'));
Params
str
{String}: The string to match.pattern
{String}: Glob pattern to use for matching.options
{Object}: Any options to change how matches are performedreturns
{Boolean}: Returns true if the patter matches any part of str
.
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.
Example
var nm = require('nanomatch');
nm.matchKeys(object, patterns[, options]);
var obj = { aa: 'a', ab: 'b', ac: 'c' };
console.log(nm.matchKeys(obj, '*b'));
Params
object
{Object}: The object with keys to filter.patterns
{String|Array}: One or more glob patterns to use for matching.options
{Object}: Any options to change how matches are performedreturns
{Object}: Returns an object with only keys that match the given patterns.
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.
Example
var nm = require('nanomatch');
nm.matcher(pattern[, options]);
var isMatch = nm.matcher('*.!(*a)');
console.log(isMatch('a.a'));
console.log(isMatch('a.b'));
Params
pattern
{String}: Glob patternoptions
{Object}: Any options to change how matches are performed.returns
{Function}: Returns a matcher function.
Create a regular expression from the given glob pattern
.
Example
var nm = require('nanomatch');
nm.makeRe(pattern[, options]);
console.log(nm.makeRe('*.js'));
Params
pattern
{String}: A glob pattern to convert to regex.options
{Object}: Any options to change how matches are performed.returns
{RegExp}: Returns a regex created from the given pattern.
Parses the given glob pattern
and returns an object with the compiled output
and optional source map
.
Example
var nm = require('nanomatch');
nm.create(pattern[, options]);
console.log(nm.create('abc/*.js'));
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.
Parse the given str
with the given options
.
Example
var nm = require('nanomatch');
nm.parse(pattern[, options]);
var ast = nm.parse('a/{b,c}/d');
console.log(ast);
Params
str
{String}options
{Object}returns
{Object}: Returns an AST
Compile the given ast
or string with the given options
.
Example
var nm = require('nanomatch');
nm.compile(ast[, options]);
var ast = nm.parse('a/{b,c}/d');
console.log(nm.compile(ast));
Params
ast
{Object|String}options
{Object}returns
{Object}: Returns an object that has an output
property with the compiled string.
Clear the regex cache.
Example
nm.clearCache();
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
nm(['a/b.js', 'a/c.md'], '*.js');
nm(['a/b.js', 'a/c.md'], '*.js', {matchBase: true});
options.cache
Disable regex and function memoization.
Type: Boolean
Default: undefined
options.dot
Match dotfiles. Same behavior as minimatch option dot
.
Type: Boolean
Default: false
options.failglob
Similar to the --failglob
behavior in Bash, throws an error when no matches are found.
Type: Boolean
Default: undefined
options.ignore
String or array of glob patterns to match files to ignore.
Type: String|Array
Default: undefined
options.matchBase
Alias for options.basename.
options.nocase
Use a case-insensitive regex for matching files. Same behavior as minimatch.
Type: Boolean
Default: undefined
options.nodupes
Remove duplicate elements from the result array.
Type: Boolean
Default: undefined
Example
Example of using the unescape
and nodupes
options together:
nm.match(['a/b/c', 'a/b/c'], 'a/b/c');
nm.match(['a/b/c', 'a/b/c'], 'a/b/c', {nodupes: true});
options.nonegate
Disallow negation (!
) patterns, and treat leading !
as a literal character to match.
Type: Boolean
Default: undefined
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.snapdragon
Pass your own instance of snapdragon to customize parsers or compilers.
Type: Object
Default: undefined
options.unescape
Remove backslashes from returned matches.
Type: Boolean
Default: undefined
Example
In this example we want to match a literal *
:
nm.match(['abc', 'a\\*c'], 'a\\*c');
nm.match(['abc', 'a\\*c'], 'a\\*c', {unescape: true});
options.unixify
Convert path separators on returned files to posix/unix-style forward slashes.
Type: Boolean
Default: true
Example
nm.match(['a\\b\\c'], 'a/**');
nm.match(['a\\b\\c'], {unixify: false});
Features
Nanomatch has full support for standard Bash glob features, including the following "metacharacters": *
, **
, ?
and [...]
.
Here are some examples of how they work:
Pattern | Description |
---|
* | Matches any string except for / , leading . , or /. inside a path |
** | Matches any string including / , but not a leading . or /. inside a path. More than two stars (e.g. *** is treated the same as one star, and ** loses its special meaning |
foo* | Matches any string beginning with foo |
*bar* | Matches any string containing bar (beginning, middle or end) |
*.min.js | Matches any string ending with .min.js |
[abc]*.js | Matches any string beginning with a , b , or c and ending with .js |
abc? | Matches abcd or abcz but not abcde |
The exceptions noted for *
apply to all patterns that contain a *
.
Not supported
The following extended-globbing features are not supported:
If you need any of these features consider using micromatch instead.
Bash expansion libs
Nanomatch is part of a suite of libraries aimed at bringing the power and expressiveness of Bash's matching and expansion capabilities to JavaScript, and - as you can see by the benchmarks - without sacrificing speed.
| Related library | Matching Type | Example | Description |
| --- | --- | --- | --- | --- | --- |
| nanomatch
(you are here) | Wildcards | *
| Filename expansion, also referred to as globbing and pathname expansion, allows the use of wildcards for matching. |
| expand-tilde | Tildes | ~
| Tilde expansion converts the leading tilde in a file path to the user home directory. |
| braces | Braces | {a,b,c}
| Brace expansion |
| expand-brackets | Brackets | [[:alpha:]]
| POSIX character classes (also referred to as POSIX brackets, or POSIX character classes) |
| extglob | Parens | !(a | b)
| Extglobs |
| micromatch | All | all | Micromatch is built on top of the other libraries. |
There are many resources available on the web if you want to dive deeper into how these features work in Bash.
Benchmarks
Running benchmarks
Install dev dependencies:
npm i -d && node benchmark
Latest results
Benchmarking: (6 of 6)
· globstar-basic
· large-list-globstar
· long-list-globstar
· negation-basic
· not-glob-basic
· star-basic
minimatch x 31,046 ops/sec ±0.56% (87 runs sampled)
multimatch x 27,787 ops/sec ±1.02% (88 runs sampled)
nanomatch x 453,686 ops/sec ±1.11% (89 runs sampled)
fastest is nanomatch
minimatch x 25.23 ops/sec ±0.46% (44 runs sampled)
multimatch x 25.20 ops/sec ±0.97% (43 runs sampled)
nanomatch x 735 ops/sec ±0.66% (89 runs sampled)
fastest is nanomatch
minimatch x 258 ops/sec ±0.87% (83 runs sampled)
multimatch x 264 ops/sec ±0.90% (82 runs sampled)
nanomatch x 1,858 ops/sec ±0.56% (89 runs sampled)
fastest is nanomatch
minimatch x 74,240 ops/sec ±1.22% (88 runs sampled)
multimatch x 25,360 ops/sec ±1.18% (89 runs sampled)
nanomatch x 545,835 ops/sec ±1.12% (88 runs sampled)
fastest is nanomatch
minimatch x 92,753 ops/sec ±1.59% (86 runs sampled)
multimatch x 50,125 ops/sec ±1.43% (87 runs sampled)
nanomatch x 1,195,648 ops/sec ±1.18% (87 runs sampled)
fastest is nanomatch
minimatch x 70,746 ops/sec ±1.51% (86 runs sampled)
multimatch x 54,317 ops/sec ±1.45% (89 runs sampled)
nanomatch x 602,748 ops/sec ±1.17% (86 runs sampled)
fastest is nanomatch
History
key
Changelog entries are classified using the following labels (from keep-a-changelog):
added
: for new featureschanged
: for changes in existing functionalitydeprecated
: for once-stable features removed in upcoming releasesremoved
: for deprecated features removed in this releasefixed
: for any bug fixesbumped
: updated dependencies, only minor or higher will be listed.
[0.1.0] - 2016-10-08
First release.
About
Related projects
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for avice on opening issues, pull requests, and coding standards.
Running tests
Install dev dependencies:
$ npm install -d && npm test
Author
Jon Schlinkert
License
Copyright © 2016, Jon Schlinkert.
Released under the MIT license.
This file was generated by verb-generate-readme, v0.2.0, on December 12, 2016.