anymatch

Javascript module to match a string against a regular expression, glob, string, or function that takes the string as an argument and returns a truthy or falsy value. The matcher can also be an array of any or all of these. Useful for allowing a very flexible user-defined config to define things like file paths.

Note: This module has Bash-parity, please be aware that Windows-style backslashes are not supported as separators. See https://github.com/micromatch/micromatch#backslashes for more information.

Usage

1npm install anymatch

anymatch(matchers, testString, [returnIndex], [options])

• matchers: (Array|String|RegExp|Function) String to be directly matched, string with glob patterns, regular expression test, function that takes the testString as an argument and returns a truthy value if it should be matched, or an array of any number and mix of these types.
• testString: (String|Array) The string to test against the matchers. If passed as an array, the first element of the array will be used as the testString for non-function matchers, while the entire array will be applied as the arguments for function matchers.
• options: (Object [optional]_) Any of the picomatch options.
  • returnIndex: (Boolean [optional]) If true, return the array index of the first matcher that that testString matched, or -1 if no match, instead of a boolean result.

1const anymatch = require('anymatch');
2
3const matchers = [ 'path/to/file.js', 'path/anyjs/**/*.js', /foo.js$/, string => string.includes('bar') && string.length > 10 ] ;
4
5anymatch(matchers, 'path/to/file.js'); // true
6anymatch(matchers, 'path/anyjs/baz.js'); // true
7anymatch(matchers, 'path/to/foo.js'); // true
8anymatch(matchers, 'path/to/bar.js'); // true
9anymatch(matchers, 'bar.js'); // false
10
11// returnIndex = true
12anymatch(matchers, 'foo.js', {returnIndex: true}); // 2
13anymatch(matchers, 'path/anyjs/foo.js', {returnIndex: true}); // 1
14
15// any picomatc
16
17// using globs to match directories and their children
18anymatch('node_modules', 'node_modules'); // true
19anymatch('node_modules', 'node_modules/somelib/index.js'); // false
20anymatch('node_modules/**', 'node_modules/somelib/index.js'); // true
21anymatch('node_modules/**', '/absolute/path/to/node_modules/somelib/index.js'); // false
22anymatch('**/node_modules/**', '/absolute/path/to/node_modules/somelib/index.js'); // true
23
24const matcher = anymatch(matchers);
25['foo.js', 'bar.js'].filter(matcher);  // [ 'foo.js' ]
26anymatch master* ❯
27

anymatch(matchers)

You can also pass in only your matcher(s) to get a curried function that has already been bound to the provided matching criteria. This can be used as an Array#filter callback.

1var matcher = anymatch(matchers);
2
3matcher('path/to/file.js'); // true
4matcher('path/anyjs/baz.js', true); // 1
5
6['foo.js', 'bar.js'].filter(matcher); // ['foo.js']

Changelog

See release notes page on GitHub

• v3.0: Removed startIndex and endIndex arguments. Node 8.x-only.
• v2.0: micromatch moves away from minimatch-parity and inline with Bash. This includes handling backslashes differently (see https://github.com/micromatch/micromatch#backslashes for more information).
• v1.2: anymatch uses micromatch for glob pattern matching. Issues with glob pattern matching should be reported directly to the micromatch issue tracker.

License

ISC