nanomatch
Advanced tools
Package description
Nanomatch is a fast and lightweight glob matcher for JavaScript. It is used to match file paths using glob patterns, which are simplified regular expressions. Nanomatch is designed to be smaller and faster than other globbing libraries, making it suitable for performance-critical applications.
Basic Glob Matching
Nanomatch can be used to match file paths against glob patterns. In this example, it matches all JavaScript files in the array.
const nanomatch = require('nanomatch');
const files = ['foo.js', 'bar.js', 'baz.js'];
const matched = nanomatch(files, '*.js');
console.log(matched); // ['foo.js', 'bar.js', 'baz.js']Negation Patterns
Nanomatch supports negation patterns, allowing you to exclude certain files from the match. In this example, it matches all JavaScript files except 'bar.js'.
const nanomatch = require('nanomatch');
const files = ['foo.js', 'bar.js', 'baz.js'];
const matched = nanomatch(files, ['*.js', '!bar.js']);
console.log(matched); // ['foo.js', 'baz.js']Advanced Glob Patterns
Nanomatch supports advanced glob patterns, including brace expansion and character classes. In this example, it matches all JavaScript and text files except those starting with 'foo'.
const nanomatch = require('nanomatch');
const files = ['foo.js', 'bar.js', 'baz.js', 'foo.txt'];
const matched = nanomatch(files, ['*.{js,txt}', '!foo.*']);
console.log(matched); // ['bar.js', 'baz.js']Minimatch is a popular glob matching library for JavaScript. It is widely used and has a rich feature set, but it is larger and slower compared to Nanomatch. Minimatch is suitable for applications where compatibility and feature richness are more important than performance.
Micromatch is another glob matching library that is similar to Nanomatch but offers more features and better performance than Minimatch. Micromatch is slightly larger than Nanomatch but provides a good balance between performance and functionality.
Glob is a comprehensive globbing library that is part of the Node.js ecosystem. It is feature-rich and highly compatible with various glob patterns, but it is also larger and slower compared to Nanomatch. Glob is suitable for applications that require extensive globbing capabilities.
Readme
Fast, minimal glob matcher for node.js. Complete Bash 4.3 wildcard support (no support for exglobs, brackets or braces)
(TOC generated by verb using markdown-toc)
Nanomatch is a fast and accurate glob matcher with full support for standard Bash glob features, including the following "metacharacters": *, **, ? and [...].
See the features section for more info about features.
How is this different from micromatch?
Nanomatch only provides wildcard matching, which represents only 1 of the 5 matching "types" offered by micromatch. The others are listed in the features section.
Nanomatch will also provide the wildcard matching functionality to micromatch, starting with v3.0.0.
var nanomatch = require('nanomatch');
// the main export is a function that takes an array of strings to match
// and one or more patterns to use for matching
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'], '*'));
//=> ['a']
console.log(nm(['a', 'b/b', 'c/c/c'], '*/*'));
//=> ['b/b']
console.log(nm(['a', 'b/b', 'c/c/c'], '**'));
//=> ['a', 'b/b', 'c/c/c']
Additional detail provided in the API documentation.
The main function takes a list of strings and one or more glob patterns to use for matching.
Example
var nanomatch = require('nanomatch');
console.log(nanomatch(['a.js', 'a.txt'], ['*.js']));
//=> [ 'a.js' ]
Params
list {Array}patterns {String|Array}: Glob patternsoptions {Object}returns {Array}: Returns an array of matchesSimilar to the main function, but pattern must be a string.
Example
var nanomatch = require('nanomatch');
console.log(nanomatch.match(['a.a', 'a.aa', 'a.b', 'a.c'], '*.a'));
//=> ['a.a', 'a.aa']
Params
list {Array}: Array of strings to matchpattern {String}: Glob patternoptions {Object}returns {Array}: Returns an array of matchesCreates a matcher function from the given glob pattern and options. The returned function takes a string to match as its only argument.
Example
var nanomatch = require('nanomatch');
var isMatch = nanomatch.matcher('*.!(*a)');
console.log(isMatch('a.a'));
//=> false
console.log(isMatch('a.b'));
//=> true
Params
pattern {String}: Glob patternoptions {String}returns {Function}: Returns a matcher function.Returns true if the specified string matches the given glob pattern.
Example
var nanomatch = require('nanomatch');
console.log(nanomatch.isMatch('a.a', '*.a'));
//=> true
console.log(nanomatch.isMatch('a.b', '*.a'));
//=> false
Params
string {String}: String to matchpattern {String}: Glob patternoptions {String}returns {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 nanomatch = require('nanomatch');
console.log(nanomatch.not(['a.a', 'b.b', 'c.c'], '*.a'));
//=> ['b.b', 'c.c']
Params
list {Array}: Array of strings to match.pattern {String}: One or more glob patterns.options {Object}returns {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 nanomatch = require('nanomatch');
console.log(nanomatch.any('a.a', ['b.*', '*.a']));
//=> true
console.log(nanomatch.any('a.a', 'b.*'));
//=> false
Params
str {String}: The string to test.patterns {String|Array}: Glob patterns to use.options {Object}: Options to pass to the matcher() function.returns {Boolean}: Returns true if any patterns match strReturns true if the given string contains the given pattern. Similar to .isMatch but the pattern can match any part of the string.
Example
var nanomatch = require('nanomatch');
console.log(nanomatch.contains('aa/bb/cc', '*b'));
//=> true
console.log(nanomatch.contains('aa/bb/cc', '*d'));
//=> false
Params
str {String}: The string to match.pattern {String}: Glob pattern to use for matching.options {Object}returns {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 nanomatch = require('nanomatch');
var obj = { aa: 'a', ab: 'b', ac: 'c' };
console.log(nanomatch.matchKeys(obj, '*b'));
//=> { ab: 'b' }
Params
object {Object}patterns {Array|String}: One or more glob patterns.returns {Object}: Returns an object with only keys that match the given patterns.Create a regular expression from the given glob pattern.
Example
var nanomatch = require('nanomatch');
console.log(nanomatch.makeRe('*.js'));
//=> /^(?:(\.[\\\/])?(?!\.)(?=.)[^\/]*?\.js)$/
Params
pattern {String}: The pattern to convert to regex.options {Object}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 nanomatch = require('nanomatch');
console.log(nanomatch.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 }
Params
pattern {String}: Glob patternoptions {Object}returns {Object}: Returns an object with the parsed AST, compiled string and optional source map.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 when it's not the only thing in a path segment, per Bash specifications)
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:
{a,b,c})@(a|!(c|d)))[[:alpha:][:digit:]])If you need any of these features consider using micromatch instead.
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
--- | --- | --- | ---
micromatch | 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.
Install dev dependencies:
npm i -d && npm benchmark
Benchmarking: (4 of 4)
· globstar-basic
· negation-basic
· not-glob-basic
· star-basic
# benchmark/fixtures/match/globstar-basic.js (182 bytes)
minimatch x 35,521 ops/sec ±0.99% (82 runs sampled)
multimatch x 29,662 ops/sec ±1.90% (82 runs sampled)
nanomatch x 719,866 ops/sec ±1.53% (84 runs sampled)
fastest is nanomatch
# benchmark/fixtures/match/negation-basic.js (132 bytes)
minimatch x 65,810 ops/sec ±1.11% (85 runs sampled)
multimatch x 24,267 ops/sec ±1.40% (85 runs sampled)
nanomatch x 698,260 ops/sec ±1.42% (84 runs sampled)
fastest is nanomatch
# benchmark/fixtures/match/not-glob-basic.js (93 bytes)
minimatch x 91,445 ops/sec ±1.69% (83 runs sampled)
multimatch x 62,945 ops/sec ±1.20% (84 runs sampled)
nanomatch x 3,077,100 ops/sec ±1.45% (84 runs sampled)
fastest is nanomatch
# benchmark/fixtures/match/star-basic.js (93 bytes)
minimatch x 62,144 ops/sec ±1.67% (85 runs sampled)
multimatch x 46,133 ops/sec ±1.66% (83 runs sampled)
nanomatch x 1,039,345 ops/sec ±1.23% (86 runs sampled)
fastest is nanomatch
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.First release.
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.
Install dev dependencies:
$ npm install -d && npm test
Jon Schlinkert
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb-generate-readme, v0.1.31, on October 08, 2016.
FAQs
Unknown package
We found that nanomatch demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 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.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.