Upsilon-VsCode/Client/node_modules/multimatch/readme.md

1.7 KiB
Executable File
Raw Blame History

multimatch Build Status

Extends minimatch.match() with support for multiple patterns

Install


$ npm install --save multimatch

Usage

var multimatch = require('multimatch');

multimatch(['unicorn', 'cake', 'rainbows'], ['*', '!cake']);
//=> ['unicorn', 'rainbows']

See the tests for more usage examples and expected matches.

API

Same as minimatch.match() except for pattern also accepting an array.

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

See globby if you need to match against the filesystem instead of a list.

License

MIT © Sindre Sorhus, Jon Schlinkert