| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798 |
- anymatch [](https://travis-ci.org/es128/anymatch) [](https://coveralls.io/r/es128/anymatch?branch=master)
- ======
- 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.
- [](https://nodei.co/npm/anymatch/)
- [](https://nodei.co/npm-dl/anymatch/)
- Usage
- -----
- ```sh
- npm install anymatch --save
- ```
- #### anymatch (matchers, testString, [returnIndex], [startIndex], [endIndex])
- * __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.
- * __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.
- * __startIndex, endIndex__: (_Integer [optional]_) Can be used to define a
- subset out of the array of provided matchers to test against. Can be useful
- with bound matcher functions (see below). When used with `returnIndex = true`
- preserves original indexing. Behaves the same as `Array.prototype.slice` (i.e.
- includes array members up to, but not including endIndex).
- ```js
- var anymatch = require('anymatch');
- var matchers = [
- 'path/to/file.js',
- 'path/anyjs/**/*.js',
- /foo\.js$/,
- function (string) {
- return string.indexOf('bar') !== -1 && string.length > 10
- }
- ];
- anymatch(matchers, 'path/to/file.js'); // true
- anymatch(matchers, 'path/anyjs/baz.js'); // true
- anymatch(matchers, 'path/to/foo.js'); // true
- anymatch(matchers, 'path/to/bar.js'); // true
- anymatch(matchers, 'bar.js'); // false
- // returnIndex = true
- anymatch(matchers, 'foo.js', true); // 2
- anymatch(matchers, 'path/anyjs/foo.js', true); // 1
- // skip matchers
- anymatch(matchers, 'path/to/file.js', false, 1); // false
- anymatch(matchers, 'path/anyjs/foo.js', true, 2, 3); // 2
- anymatch(matchers, 'path/to/bar.js', true, 0, 3); // -1
- // using globs to match directories and their children
- anymatch('node_modules', 'node_modules'); // true
- anymatch('node_modules', 'node_modules/somelib/index.js'); // false
- anymatch('node_modules/**', 'node_modules/somelib/index.js'); // true
- anymatch('node_modules/**', '/absolute/path/to/node_modules/somelib/index.js'); // false
- anymatch('**/node_modules/**', '/absolute/path/to/node_modules/somelib/index.js'); // true
- ```
- #### 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.prototype.filter` callback.
- ```js
- var matcher = anymatch(matchers);
- matcher('path/to/file.js'); // true
- matcher('path/anyjs/baz.js', true); // 1
- matcher('path/anyjs/baz.js', true, 2); // -1
- ['foo.js', 'bar.js'].filter(matcher); // ['foo.js']
- ```
- Change Log
- ----------
- [See release notes page on GitHub](https://github.com/es128/anymatch/releases)
- NOTE: As of v1.2.0, anymatch uses [micromatch](https://github.com/jonschlinkert/micromatch)
- for glob pattern matching. The glob matching behavior should be functionally
- equivalent to the commonly used [minimatch](https://github.com/isaacs/minimatch)
- library (aside from some fixed bugs and greater performance), so a major
- version bump wasn't merited. Issues with glob pattern matching should be
- reported directly to the [micromatch issue tracker](https://github.com/jonschlinkert/micromatch/issues).
- License
- -------
- [ISC](https://raw.github.com/es128/anymatch/master/LICENSE)
|
