5.0.0 • Published 4 years ago

matcher v5.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

matcher

Simple wildcard matching

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

Install

npm install matcher

Usage

import {matcher, isMatch} from 'matcher';

matcher(['foo', 'bar', 'moo'], ['*oo', '!foo']);
//=> ['moo']

matcher(['foo', 'bar', 'moo'], ['!*oo']);
//=> ['bar']

matcher('moo', ['']);
//=> []

matcher('moo', []);
//=> []

matcher([''], ['']);
//=> ['']

isMatch('unicorn', 'uni*');
//=> true

isMatch('unicorn', '*corn');
//=> true

isMatch('unicorn', 'un*rn');
//=> true

isMatch('rainbow', '!unicorn');
//=> true

isMatch('foo bar baz', 'foo b* b*');
//=> true

isMatch('unicorn', 'uni\\*');
//=> false

isMatch(['foo', 'bar'], 'f*');
//=> true

isMatch(['foo', 'bar'], ['a*', 'b*']);
//=> true

isMatch('unicorn', ['']);
//=> false

isMatch('unicorn', []);
//=> false

isMatch([], 'bar');
//=> false

isMatch([], []);
//=> false

isMatch('', '');
//=> 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.

import {isMatch} from 'matcher';

isMatch('UNICORN', 'UNI*', {caseSensitive: true});
//=> true

isMatch('UNICORN', 'unicorn', {caseSensitive: true});
//=> false

isMatch('unicorn', ['tri*', 'UNI*'], {caseSensitive: true});
//=> 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.

import {matcher} from 'matcher';

// Find text strings containing both "edge" and "tiger" in arbitrary order, but not "stunt".
const demo = (strings) => matcher(strings, ['*edge*', '*tiger*', '!*stunt*'], {allPatterns: true});

demo(['Hey, tiger!', 'tiger has edge over hyenas', 'pushing a tiger over the edge is a stunt']);
//=> ['tiger has edge over hyenas']
import {matcher} from 'matcher';

matcher(['foo', 'for', 'bar'], ['f*', 'b*', '!x*'], {allPatterns: true});
//=> ['foo', 'for', 'bar']

matcher(['foo', 'for', 'bar'], ['f*'], {allPatterns: true});
//=> []

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

npm run bench

Related

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

archetype-librarygfrppurascents-scriptsgrph@solvencino/arcarcane-mountbroken-link-checker-timeoutone-index@infinitebrahmanuniverse/nolb-matcvideopass-ctms@everything-registry/sub-chunk-2137taskparserteabotwithhold-message-avaxl-diffxml-urlsteleframestaart-managerswagapivue-compmentvue-dev-clone@cybermega/flutter-resource-manager-rs@persistr/js@persistr/storejigsaw-netjson-variablesjsbrain-prisma-nestjs-graphqlk-fastify-gatewaykoa-domainrouterhotel2hotelhttp-cache-middlewarehtml-urlsinsales-uploaderlicenseguardlockfile-conflictslerna-watchermark-dommatcher-cliload-goblinlect@wctools/build-polymer@umac-js/utils@types/matcher@turf-rs/turf@trychen/global-agent@topzero/ava@tinymce/moxiedoc@thooto/role-acl@toktokhan-fe/cli-plugin-gen-sitemap-next-page@toktokhan-fe/github@toktokhan-dev/cli-plugin-gen-sitemap-next-page@toktokhan-dev/github@vkumov/role-acl@volcengine/starling-cli-client@xixo/xixo@yotie/micron@ziobrowskyy/avaaem-bulkadd-assets-to-json-webpack-pluginbabel-plugin-jsx-wrapperbabel-plugin-realarawesome-react-starsast-get-values-by-keyarray-pull-all-with-globarray-includes-with-globast-comparearvm-bestdeveloper@cloudquery/plugin-sdk-javascript@clearmetrics/disposable-email@clearmetrics/text@aboviq/kollektor@24hr/redirect-matcher@adaptive-web/adaptive-ui@eggjs/security@codiac.io/codiac-ops-common@credify/crypto-key-composer@collectium/core@akryum/hoteltaskninjaspringcm-node-sdktundra-fetchtwine-libtwine-library@c4605/babel-plugin-jsx-wrapper@chi_eee/another-test-packageyarn-upgrade-fuzzyyyl-copy-webpack-pluginxn--mxaacvuex-loadingunusual-editorupdate-boilerplate-cli@gallolabs/remote-ee@kyrisu/access-control@linzjs/step-ag-grid@my-wufan/hello-napi@morlay/ava@push.rocks/smartmatch@push.rocks/smartswagger@pushrocks/smartmatch
5.0.0

4 years ago

4.0.0

5 years ago

3.0.0

5 years ago

2.1.0

6 years ago

2.0.0

7 years ago

1.1.1

7 years ago

1.1.0

8 years ago

1.0.0

8 years ago

0.1.2

10 years ago

0.1.1

10 years ago

0.1.0

10 years ago

0.0.1

13 years ago