Blazing fast and accurate glob matcher written in JavaScript.
No dependencies and full support for standard and extended Bash glob features, including braces, extglobs, POSIX brackets, and regular expressions.

• Lightweight - No dependencies
• Minimal - Tiny API surface. Main export is a function that takes a glob pattern and returns a matcher function.
• Fast - Loads in about 2ms (that's several times faster than a single frame of a HD movie at 60fps)
• Performant - Optional precompiling to speed up repeat matching (like when watching files)
• Accurate matching - Using wildcards (* and ?), globstars (**) for nested directories, advanced globbing with extglobs, braces, and POSIX brackets, and support for escaping special characters with \ or quotes.
• Well tested - Thousands of unit tests

See the feature comparison to other libraries.

Install with npm:

$ npm install --save picomatch

The main export is a function that takes a glob pattern and an options object and returns a function for matching strings.

const pm = require('picomatch');
const isMatch = pm('*.js');

console.log(isMatch('abcd')); //=> false
console.log(isMatch('a.js')); //=> true
console.log(isMatch('a.md')); //=> false
console.log(isMatch('a/b.js')); //=> false

• Basic globbing (Wildcard matching)
• Advanced globbing (extglobs, posix brackets, brace matching)

Picomatch's matching features and expected results in unit tests are based on Bash's unit tests and the Bash 4.3 specification, with the following exceptions:

• Bash will match foo/bar/baz with *. Picomatch only matches nested directories with **.
• Bash greedily matches with negated extglobs. For example, Bash 4.3 says that !(foo)* should match foo and foobar, since the trailing * bracktracks to match the preceding pattern. This is very memory-inefficient, and IMHO, also incorrect. Picomatch would return false for both foo and foobar.

• extglobs (todo)
• POSIX brackets
• brace expansion (todo)
• regular expressions (todo)

POSIX classes are disabled by default. Enable this feature by setting the posix option to true.

Enable POSIX bracket support

console.log(pm.makeRe('[[:word:]]+', { posix: true }));
//=> /^(?:(?=.)[A-Za-z0-9_]+\/?)$/

Supported POSIX classes

The following named POSIX bracket expressions are supported:

• [:alnum:] - Alphanumeric characters, equ [a-zA-Z0-9]
• [:alpha:] - Alphabetical characters, equivalent to [a-zA-Z].
• [:ascii:] - ASCII characters, equivalent to [\\x00-\\x7F].
• [:blank:] - Space and tab characters, equivalent to [ \\t].
• [:cntrl:] - Control characters, equivalent to [\\x00-\\x1F\\x7F].
• [:digit:] - Numerical digits, equivalent to [0-9].
• [:graph:] - Graph characters, equivalent to [\\x21-\\x7E].
• [:lower:] - Lowercase letters, equivalent to [a-z].
• [:print:] - Print characters, equivalent to [\\x20-\\x7E ].
• [:punct:] - Punctuation and symbols, equivalent to [\\-!"#$%&\'()\\*+,./:;<=>?@[\\]^_{|}~]`.
• [:space:] - Extended space characters, equivalent to [ \\t\\r\\n\\v\\f].
• [:upper:] - Uppercase letters, equivalent to [A-Z].
• [:word:] - Word characters (letters, numbers and underscores), equivalent to [A-Za-z0-9_].
• [:xdigit:] - Hexadecimal digits, equivalent to [A-Fa-f0-9].

See the Bash Reference Manual for more information.

If you wish to match the following special characters in a filepath, and you want to use these characters in your glob pattern, they must be escaped with backslashes or quotes:

Special Characters

Some characters that are used for matching in regular expressions are also regarded as valid file path characters on some platforms.

To match any of the following characters as literals: `$^*+?()[]

Examples:

console.log(pm.makeRe('foo/bar \\(1\\)'));
console.log(pm.makeRe('foo/bar \\(1\\)'));

Comparison to other libraries.

The following table shows which features are supported by minimatch, micromatch, picomatch, nanomatch, extglob, braces, and expand-brackets.

minimatch: 4.230ms
picomatch: 2.123ms

Time it takes to return the first match, including require() time:

console.log(require('minimatch').makeRe('**/*').test('foo/bar/baz/qux.js'));
// 9.275ms
console.log(require('picomatch').makeRe('**/*').test('foo/bar/baz/qux.js'));
// 7.429ms

$ npm install && npm test

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

Copyright © 2018, Jon Schlinkert. Released under the MIT License.