work.suroh.tk/node_modules/maximatch/readme.md

72 lines
2.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# maximatch [![Build Status](https://travis-ci.org/timkendrick/maximatch.svg?branch=master)](https://travis-ci.org/timkendrick/maximatch)
> Extends [`multimatch()`](https://github.com/sindresorhus/multimatch) with support for filter functions and regular expressions
## Install
```sh
$ npm install --save maximatch
```
## Usage
```js
var maximatch = require('maximatch');
maximatch(['unicorn', 'cake', 'rainbows'], ['*', '!cake']);
//=> ['unicorn', 'rainbows']
maximatch(['unicorn', 'cake', 'rainbows'], function(path) { return path.length > 4; });
//=> ['unicorn', 'rainbows']
maximatch(['unicorn', 'cake', 'rainbows'], /^[^k]+$/);
//=> ['unicorn', 'rainbows']
maximatch(['unicorn', 'cake', 'rainbows'], [function(path) { return path.charAt(0) === 'u'; }, /w/]);
//=> ['unicorn', 'rainbows']
```
See the [tests](https://github.com/timkendrick/multimatch/blob/master/test.js) for more usage examples and expected matches.
## API
Same as [`minimatch.match()`](https://github.com/isaacs/minimatch#minimatchmatchlist-pattern-options) except for `pattern` also accepting a filter function, a regular expression, or an array that can contain globs, filter functions and regular expressions.
```js
var results = maximatch(paths, patterns);
```
The return value is an array of matching paths.
## How multiple patterns work
Positive patterns (e.g. `foo` or `*`) add to the results, while negative patterns (e.g. `!foo`) subtract from the results.
Therefore a lone negation (e.g. `['!foo']`) will never match anything use `['*', '!foo']` instead.
## Globbing patterns
Just a quick overview.
- `*` matches any number of characters, but not `/`
- `?` matches a single character, but not `/`
- `**` matches any number of characters, including `/`, as long as it's the only thing in a path part
- `{}` allows for a comma-separated list of "or" expressions
- `!` at the beginning of a pattern will negate the match
## Related
See [globby](https://github.com/sindresorhus/globby) if you need to match against the filesystem instead of a list.
## License
MIT © [Sindre Sorhus](http://sindresorhus.com), [Jon Schlinkert](https://github.com/jonschlinkert), [Tim Kendrick](https://github.com/timkendrick)