You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
87 lines
3.9 KiB
87 lines
3.9 KiB
anymatch [](https://travis-ci.org/micromatch/anymatch) [](https://coveralls.io/r/micromatch/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. |
|
|
|
__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 |
|
----- |
|
```sh |
|
npm 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](https://github.com/micromatch/picomatch#options) 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. |
|
|
|
```js |
|
const anymatch = require('anymatch'); |
|
|
|
const matchers = [ 'path/to/file.js', 'path/anyjs/**/*.js', /foo.js$/, string => string.includes('bar') && 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', {returnIndex: true}); // 2 |
|
anymatch(matchers, 'path/anyjs/foo.js', {returnIndex: true}); // 1 |
|
|
|
// any picomatc |
|
|
|
// 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 |
|
|
|
const matcher = anymatch(matchers); |
|
['foo.js', 'bar.js'].filter(matcher); // [ 'foo.js' ] |
|
anymatch master* ❯ |
|
|
|
``` |
|
|
|
#### 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. |
|
|
|
```js |
|
var matcher = anymatch(matchers); |
|
|
|
matcher('path/to/file.js'); // true |
|
matcher('path/anyjs/baz.js', true); // 1 |
|
|
|
['foo.js', 'bar.js'].filter(matcher); // ['foo.js'] |
|
``` |
|
|
|
Changelog |
|
---------- |
|
[See release notes page on GitHub](https://github.com/micromatch/anymatch/releases) |
|
|
|
- **v3.0:** Removed `startIndex` and `endIndex` arguments. Node 8.x-only. |
|
- **v2.0:** [micromatch](https://github.com/jonschlinkert/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](https://github.com/jonschlinkert/micromatch) |
|
for glob pattern matching. 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/micromatch/anymatch/master/LICENSE)
|
|
|