aboutsummaryrefslogtreecommitdiff
path: root/node_modules/multimatch/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-05-28 00:38:50 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-05-28 00:40:43 +0200
commit7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027 (patch)
tree6de9a1aebd150a23b7f8c273ec657a5d0a18fe3e /node_modules/multimatch/readme.md
parent963b7a41feb29cc4be090a2446bdfe0c1f1bcd81 (diff)
add linting (and some initial fixes)
Diffstat (limited to 'node_modules/multimatch/readme.md')
-rw-r--r--node_modules/multimatch/readme.md62
1 files changed, 62 insertions, 0 deletions
diff --git a/node_modules/multimatch/readme.md b/node_modules/multimatch/readme.md
new file mode 100644
index 000000000..f10fa5dd7
--- /dev/null
+++ b/node_modules/multimatch/readme.md
@@ -0,0 +1,62 @@
+# multimatch [![Build Status](https://travis-ci.org/sindresorhus/multimatch.svg?branch=master)](https://travis-ci.org/sindresorhus/multimatch)
+
+> Extends [`minimatch.match()`](https://github.com/isaacs/minimatch#minimatchmatchlist-pattern-options) with support for multiple patterns
+
+
+## Install
+
+```sh
+
+$ npm install --save multimatch
+```
+
+
+## Usage
+
+```js
+var multimatch = require('multimatch');
+
+multimatch(['unicorn', 'cake', 'rainbows'], ['*', '!cake']);
+//=> ['unicorn', 'rainbows']
+```
+
+See the [tests](https://github.com/sindresorhus/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 an array.
+
+```js
+var results = multimatch(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)