matcher

Simple wildcard matching

Useful when you want to accept loose string input and regexes/globs are too convoluted.

Install

1npm install matcher

Usage

1import {matcher, isMatch} from 'matcher';
2
3matcher(['foo', 'bar', 'moo'], ['*oo', '!foo']);
4//=> ['moo']
5
6matcher(['foo', 'bar', 'moo'], ['!*oo']);
7//=> ['bar']
8
9matcher('moo', ['']);
10//=> []
11
12matcher('moo', []);
13//=> []
14
15matcher([''], ['']);
16//=> ['']
17
18isMatch('unicorn', 'uni*');
19//=> true
20
21isMatch('unicorn', '*corn');
22//=> true
23
24isMatch('unicorn', 'un*rn');
25//=> true
26
27isMatch('rainbow', '!unicorn');
28//=> true
29
30isMatch('foo bar baz', 'foo b* b*');
31//=> true
32
33isMatch('unicorn', 'uni\\*');
34//=> false
35
36isMatch(['foo', 'bar'], 'f*');
37//=> true
38
39isMatch(['foo', 'bar'], ['a*', 'b*']);
40//=> true
41
42isMatch('unicorn', ['']);
43//=> false
44
45isMatch('unicorn', []);
46//=> false
47
48isMatch([], 'bar');
49//=> false
50
51isMatch([], []);
52//=> false
53
54isMatch('', '');
55//=> true

API

It matches even across newlines. For example, foo*r will match foo\nbar.

matcher(inputs, patterns, options?)

Accepts a string or an array of strings for both inputs and patterns.

Returns an array of inputs filtered based on the patterns.

isMatch(inputs, patterns, options?)

Accepts a string or an array of strings for both inputs and patterns.

Returns a boolean of whether any of given inputs matches all the patterns.

inputs

Type: string | string[]

The string or array of strings to match.

options

Type: object

caseSensitive

Type: boolean
Default: false

Treat uppercase and lowercase characters as being the same.

Ensure you use this correctly. For example, files and directories should be matched case-insensitively, while most often, object keys should be matched case-sensitively.

1import {isMatch} from 'matcher';
2
3isMatch('UNICORN', 'UNI*', {caseSensitive: true});
4//=> true
5
6isMatch('UNICORN', 'unicorn', {caseSensitive: true});
7//=> false
8
9isMatch('unicorn', ['tri*', 'UNI*'], {caseSensitive: true});
10//=> false

allPatterns

Type: boolean
Default: false

Require all negated patterns to not match and any normal patterns to match at least once. Otherwise, it will be a no-match condition.

1import {matcher} from 'matcher';
2
3// Find text strings containing both "edge" and "tiger" in arbitrary order, but not "stunt".
4const demo = (strings) => matcher(strings, ['*edge*', '*tiger*', '!*stunt*'], {allPatterns: true});
5
6demo(['Hey, tiger!', 'tiger has edge over hyenas', 'pushing a tiger over the edge is a stunt']);
7//=> ['tiger has edge over hyenas']

1import {matcher} from 'matcher';
2
3matcher(['foo', 'for', 'bar'], ['f*', 'b*', '!x*'], {allPatterns: true});
4//=> ['foo', 'for', 'bar']
5
6matcher(['foo', 'for', 'bar'], ['f*'], {allPatterns: true});
7//=> []

patterns

Type: string | string[]

Use * to match zero or more characters.

A leading ! negates the pattern.

An input string will be omitted, if it does not match any non-negated patterns present, or if it matches a negated pattern, or if no pattern is present.

Benchmark

1npm run bench

Related

• matcher-cli - CLI for this module
• multimatch - Extends minimatch.match() with support for multiple patterns

---