micromatch 3.1.9 → 4.0.2

package/README.md

@@ -1,6 +1,6 @@
-# micromatch [![NPM version](https://img.shields.io/npm/v/micromatch.svg?style=flat)](https://www.npmjs.com/package/micromatch) [![NPM monthly downloads](https://img.shields.io/npm/dm/micromatch.svg?style=flat)](https://npmjs.org/package/micromatch) [![NPM total downloads](https://img.shields.io/npm/dt/micromatch.svg?style=flat)](https://npmjs.org/package/micromatch) [![Linux Build Status](https://img.shields.io/travis/micromatch/micromatch.svg?style=flat&label=Travis)](https://travis-ci.org/micromatch/micromatch) [![Windows Build Status](https://img.shields.io/appveyor/ci/micromatch/micromatch.svg?style=flat&label=AppVeyor)](https://ci.appveyor.com/project/micromatch/micromatch)
+# micromatch [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W8YFZ425KND68) [![NPM version](https://img.shields.io/npm/v/micromatch.svg?style=flat)](https://www.npmjs.com/package/micromatch) [![NPM monthly downloads](https://img.shields.io/npm/dm/micromatch.svg?style=flat)](https://npmjs.org/package/micromatch) [![NPM total downloads](https://img.shields.io/npm/dt/micromatch.svg?style=flat)](https://npmjs.org/package/micromatch) [![Linux Build Status](https://img.shields.io/travis/micromatch/micromatch.svg?style=flat&label=Travis)](https://travis-ci.org/micromatch/micromatch)
 
-> Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.
+> Glob matching for javascript/node.js. A replacement and faster alternative to minimatch and multimatch.
 
 Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
 
@@ -18,38 +18,36 @@ Please consider following this project's author, [Jon Schlinkert](https://github
   * [From multimatch](#from-multimatch)
 - [API](#api)
 - [Options](#options)
+- [Options Examples](#options-examples)
   * [options.basename](#optionsbasename)
   * [options.bash](#optionsbash)
-  * [options.cache](#optionscache)
-  * [options.dot](#optionsdot)
-  * [options.failglob](#optionsfailglob)
+  * [options.expandRange](#optionsexpandrange)
+  * [options.format](#optionsformat)
   * [options.ignore](#optionsignore)
   * [options.matchBase](#optionsmatchbase)
-  * [options.nobrace](#optionsnobrace)
-  * [options.nocase](#optionsnocase)
-  * [options.nodupes](#optionsnodupes)
-  * [options.noext](#optionsnoext)
+  * [options.noextglob](#optionsnoextglob)
   * [options.nonegate](#optionsnonegate)
   * [options.noglobstar](#optionsnoglobstar)
   * [options.nonull](#optionsnonull)
   * [options.nullglob](#optionsnullglob)
-  * [options.snapdragon](#optionssnapdragon)
-  * [options.sourcemap](#optionssourcemap)
+  * [options.onIgnore](#optionsonignore)
+  * [options.onMatch](#optionsonmatch)
+  * [options.onResult](#optionsonresult)
+  * [options.posixSlashes](#optionsposixslashes)
   * [options.unescape](#optionsunescape)
-  * [options.unixify](#optionsunixify)
 - [Extended globbing](#extended-globbing)
-  * [extglobs](#extglobs)
-  * [braces](#braces)
-  * [regex character classes](#regex-character-classes)
-  * [regex groups](#regex-groups)
+  * [Extglobs](#extglobs)
+  * [Braces](#braces)
+  * [Regex character classes](#regex-character-classes)
+  * [Regex groups](#regex-groups)
   * [POSIX bracket expressions](#posix-bracket-expressions)
 - [Notes](#notes)
   * [Bash 4.3 parity](#bash-43-parity)
   * [Backslashes](#backslashes)
-- [Contributing](#contributing)
 - [Benchmarks](#benchmarks)
   * [Running benchmarks](#running-benchmarks)
   * [Latest results](#latest-results)
+- [Contributing](#contributing)
 - [About](#about)
 
 </details>
@@ -65,45 +63,49 @@ $ npm install --save micromatch
 ## Quickstart
 
 ```js
-var mm = require('micromatch');
-mm(list, patterns[, options]);
+const micromatch = require('micromatch');
+// micromatch(list, patterns[, options]);
 ```
 
 The [main export](#micromatch) takes a list of strings and one or more glob patterns:
 
 ```js
-console.log(mm(['foo', 'bar', 'qux'], ['f*', 'b*'])); 
-//=> ['foo', 'bar']
+console.log(micromatch(['foo', 'bar', 'baz', 'qux'], ['f*', 'b*'])) //=> ['foo', 'bar', 'baz']
+console.log(micromatch(['foo', 'bar', 'baz', 'qux'], ['*', '!b*'])) //=> ['foo', 'qux']
 ```
 
-Use [.isMatch()](#ismatch) to get true/false:
+Use [.isMatch()](#ismatch) to for boolean matching:
 
 ```js
-console.log(mm.isMatch('foo', 'f*'));  
-//=> true
+console.log(micromatch.isMatch('foo', 'f*')) //=> true
+console.log(micromatch.isMatch('foo', ['b*', 'f*'])) //=> true
 ```
 
 [Switching](#switching-to-micromatch) from minimatch and multimatch is easy!
 
+<br>
+
 ## Why use micromatch?
 
-> micromatch is a [drop-in replacement](#switching-to-micromatch) for minimatch and multimatch
+> micromatch is a [replacement](#switching-to-micromatch) for minimatch and multimatch
 
 * Supports all of the same matching features as [minimatch](https://github.com/isaacs/minimatch) and [multimatch](https://github.com/sindresorhus/multimatch)
-* Micromatch uses [snapdragon](https://github.com/jonschlinkert/snapdragon) for parsing and compiling globs, which provides granular control over the entire conversion process in a way that is easy to understand, reason about, and maintain.
-* More consistently accurate matching [than minimatch](https://github.com/yarnpkg/yarn/pull/3339), with more than 36,000 [test assertions](./test) to prove it.
-* More complete support for the Bash 4.3 specification than minimatch and multimatch. In fact, micromatch passes _all of the spec tests_ from bash, including some that bash still fails.
-* [Faster matching](#benchmarks), from a combination of optimized glob patterns, faster algorithms, and regex caching.
-* [Micromatch is safer](https://github.com/micromatch/braces#braces-is-safe), and is not subject to DoS with brace patterns, like minimatch and multimatch.
-* More reliable windows support than minimatch and multimatch.
+* More complete support for the Bash 4.3 specification than minimatch and multimatch. Micromatch passes _all of the spec tests_ from bash, including some that bash still fails.
+* **Fast & Performant** - Loads in about 5ms and performs [fast matches](#benchmarks).
+* **Glob matching** - Using wildcards (`*` and `?`), globstars (`**`) for nested directories
+* **[Advanced globbing](#advanced-globbing)** - Supports [extglobs](#extglobs), [braces](#braces), and [POSIX brackets](#posix-bracket-expressions), and support for escaping special characters with `\` or quotes.
+* **Accurate** - Covers more scenarios [than minimatch](https://github.com/yarnpkg/yarn/pull/3339)
+* **Well tested** - More than 5,000 [test assertions](./test)
+* **Windows support** - More reliable windows support than minimatch and multimatch.
+* **[Safe](https://github.com/micromatch/braces#braces-is-safe)** - Micromatch is not subject to DoS with brace patterns like minimatch and multimatch.
 
 ### Matching features
 
 * Support for multiple glob patterns (no need for wrappers like multimatch)
 * Wildcards (`**`, `*.js`)
 * Negation (`'!a/*.js'`, `'*!(b).js']`)
-* [extglobs](https://github.com/micromatch/extglob) (`+(x|y)`, `!(a|b)`)
-* [POSIX character classes](https://github.com/micromatch/expand-brackets) (`[[:alpha:][:digit:]]`)
+* [extglobs](#extglobs) (`+(x|y)`, `!(a|b)`)
+* [POSIX character classes](#posix-bracket-expressions) (`[[:alpha:][:digit:]]`)
 * [brace expansion](https://github.com/micromatch/braces) (`foo/{1..5}.md`, `bar/{a,b,c}.js`)
 * regex character classes (`foo-[1-5].js`)
 * regex logical "or" (`foo/(abc|xyz).js`)
@@ -112,22 +114,20 @@ You can mix and match these features to create whatever patterns you need!
 
 ## Switching to micromatch
 
-There is one notable difference between micromatch and minimatch in regards to how backslashes are handled. See [the notes about backslashes](#backslashes) for more information.
+_(There is one notable difference between micromatch and minimatch in regards to how backslashes are handled. See [the notes about backslashes](#backslashes) for more information.)_
 
 ### From minimatch
 
-Use [mm.isMatch()](#ismatch) instead of `minimatch()`:
+Use [micromatch.isMatch()](#ismatch) instead of `minimatch()`:
 
 ```js
-mm.isMatch('foo', 'b*');
-//=> false
+console.log(micromatch.isMatch('foo', 'b*')); //=> false
 ```
 
-Use [mm.match()](#match) instead of `minimatch.match()`:
+Use [micromatch.match()](#match) instead of `minimatch.match()`:
 
 ```js
-mm.match(['foo', 'bar'], 'b*');
-//=> 'bar'
+console.log(micromatch.match(['foo', 'bar'], 'b*')); //=> 'bar'
 ```
 
 ### From multimatch
@@ -135,157 +135,143 @@ mm.match(['foo', 'bar'], 'b*');
 Same signature:
 
 ```js
-mm(['foo', 'bar', 'baz'], ['f*', '*z']);
-//=> ['foo', 'baz']
+console.log(micromatch(['foo', 'bar', 'baz'], ['f*', '*z'])); //=> ['foo', 'baz']
 ```
 
 ## API
 
-### [micromatch](index.js#L41)
-
-The main function takes a list of strings and one or more glob patterns to use for matching.
-
 **Params**
 
-* `list` **{Array}**: A list of strings to match
-* `patterns` **{String|Array}**: One or more glob patterns to use for matching.
-* `options` **{Object}**: See available [options](#options) for changing how matches are performed
+* **{String|Array<string>}**: list List of strings to match.
+* **{String|Array<string>}**: patterns One or more glob patterns to use for matching.
+* **{Object}**: options See available [options](#options)
 * `returns` **{Array}**: Returns an array of matches
 
 **Example**
 
 ```js
-var mm = require('micromatch');
-mm(list, patterns[, options]);
+const mm = require('micromatch');
+// mm(list, patterns[, options]);
 
 console.log(mm(['a.js', 'a.txt'], ['*.js']));
 //=> [ 'a.js' ]
 ```
 
-### [.match](index.js#L93)
+### [.matcher](index.js#L98)
 
-Similar to the main function, but `pattern` must be a string.
+Returns a matcher function from the given glob `pattern` and `options`. The returned function takes a string to match as its only argument and returns true if the string is a match.
 
 **Params**
 
-* `list` **{Array}**: Array of strings to match
-* `pattern` **{String}**: Glob pattern to use for matching.
-* `options` **{Object}**: See available [options](#options) for changing how matches are performed
-* `returns` **{Array}**: Returns an array of matches
+* `pattern` **{String}**: Glob pattern
+* `options` **{Object}**
+* `returns` **{Function}**: Returns a matcher function.
 
 **Example**
 
 ```js
-var mm = require('micromatch');
-mm.match(list, pattern[, options]);
+const mm = require('micromatch');
+// mm.matcher(pattern[, options]);
 
-console.log(mm.match(['a.a', 'a.aa', 'a.b', 'a.c'], '*.a'));
-//=> ['a.a', 'a.aa']
+const isMatch = mm.matcher('*.!(*a)');
+console.log(isMatch('a.a')); //=> false
+console.log(isMatch('a.b')); //=> true
 ```
 
-### [.isMatch](index.js#L154)
+### [.isMatch](index.js#L117)
 
-Returns true if the specified `string` matches the given glob `pattern`.
+Returns true if **any** of the given glob `patterns` match the specified `string`.
 
 **Params**
 
-* `string` **{String}**: String to match
-* `pattern` **{String}**: Glob pattern to use for matching.
-* `options` **{Object}**: See available [options](#options) for changing how matches are performed
-* `returns` **{Boolean}**: Returns true if the string matches the glob pattern.
+* **{String}**: str The string to test.
+* **{String|Array}**: patterns One or more glob patterns to use for matching.
+* **{Object}**: See available [options](#options).
+* `returns` **{Boolean}**: Returns true if any patterns match `str`
 
 **Example**
 
 ```js
-var mm = require('micromatch');
-mm.isMatch(string, pattern[, options]);
+const mm = require('micromatch');
+// mm.isMatch(string, patterns[, options]);
 
-console.log(mm.isMatch('a.a', '*.a'));
-//=> true
-console.log(mm.isMatch('a.b', '*.a'));
-//=> false
+console.log(mm.isMatch('a.a', ['b.*', '*.a'])); //=> true
+console.log(mm.isMatch('a.a', 'b.*')); //=> false
 ```
 
-### [.some](index.js#L192)
+### [.not](index.js#L136)
 
-Returns true if some of the strings in the given `list` match any of the given glob `patterns`.
+Returns a list of strings that _**do not match any**_ of the given `patterns`.
 
 **Params**
 
-* `list` **{String|Array}**: The string or array of strings to test. Returns as soon as the first match is found.
-* `patterns` **{String|Array}**: One or more glob patterns to use for matching.
+* `list` **{Array}**: Array of strings to match.
+* `patterns` **{String|Array}**: One or more glob pattern to use for matching.
 * `options` **{Object}**: See available [options](#options) for changing how matches are performed
-* `returns` **{Boolean}**: Returns true if any patterns match `str`
+* `returns` **{Array}**: Returns an array of strings that **do not match** the given patterns.
 
 **Example**
 
 ```js
-var mm = require('micromatch');
-mm.some(list, patterns[, options]);
+const mm = require('micromatch');
+// mm.not(list, patterns[, options]);
 
-console.log(mm.some(['foo.js', 'bar.js'], ['*.js', '!foo.js']));
-// true
-console.log(mm.some(['foo.js'], ['*.js', '!foo.js']));
-// false
+console.log(mm.not(['a.a', 'b.b', 'c.c'], '*.a'));
+//=> ['b.b', 'c.c']
 ```
 
-### [.every](index.js#L228)
+### [.contains](index.js#L176)
 
-Returns true if every string in the given `list` matches any of the given glob `patterns`.
+Returns true if the given `string` contains the given pattern. Similar to [.isMatch](#isMatch) but the pattern can match any part of the string.
 
 **Params**
 
-* `list` **{String|Array}**: The string or array of strings to test.
-* `patterns` **{String|Array}**: One or more glob patterns to use for matching.
+* `str` **{String}**: The string to match.
+* `patterns` **{String|Array}**: Glob pattern to use for matching.
 * `options` **{Object}**: See available [options](#options) for changing how matches are performed
-* `returns` **{Boolean}**: Returns true if any patterns match `str`
+* `returns` **{Boolean}**: Returns true if the patter matches any part of `str`.
 
 **Example**
 
 ```js
 var mm = require('micromatch');
-mm.every(list, patterns[, options]);
+// mm.contains(string, pattern[, options]);
 
-console.log(mm.every('foo.js', ['foo.js']));
-// true
-console.log(mm.every(['foo.js', 'bar.js'], ['*.js']));
-// true
-console.log(mm.every(['foo.js', 'bar.js'], ['*.js', '!foo.js']));
-// false
-console.log(mm.every(['foo.js'], ['*.js', '!foo.js']));
-// false
+console.log(mm.contains('aa/bb/cc', '*b'));
+//=> true
+console.log(mm.contains('aa/bb/cc', '*d'));
+//=> false
 ```
 
-### [.any](index.js#L260)
+### [.matchKeys](index.js#L218)
 
-Returns true if **any** of the given glob `patterns` match the specified `string`.
+Filter the keys of the given object with the given `glob` pattern and `options`. Does not attempt to match nested keys. If you need this feature, use [glob-object](https://github.com/jonschlinkert/glob-object) instead.
 
 **Params**
 
-* `str` **{String|Array}**: The string to test.
+* `object` **{Object}**: The object with keys to filter.
 * `patterns` **{String|Array}**: One or more glob patterns to use for matching.
 * `options` **{Object}**: See available [options](#options) for changing how matches are performed
-* `returns` **{Boolean}**: Returns true if any patterns match `str`
+* `returns` **{Object}**: Returns an object with only keys that match the given patterns.
 
 **Example**
 
 ```js
-var mm = require('micromatch');
-mm.any(string, patterns[, options]);
+const mm = require('micromatch');
+// mm.matchKeys(object, patterns[, options]);
 
-console.log(mm.any('a.a', ['b.*', '*.a']));
-//=> true
-console.log(mm.any('a.a', 'b.*'));
-//=> false
+const obj = { aa: 'a', ab: 'b', ac: 'c' };
+console.log(mm.matchKeys(obj, '*b'));
+//=> { ab: 'b' }
 ```
 
-### [.all](index.js#L308)
+### [.some](index.js#L247)
 
-Returns true if **all** of the given `patterns` match the specified string.
+Returns true if some of the strings in the given `list` match any of the given glob `patterns`.
 
 **Params**
 
-* `str` **{String|Array}**: The string to test.
+* `list` **{String|Array}**: The string or array of strings to test. Returns as soon as the first match is found.
 * `patterns` **{String|Array}**: One or more glob patterns to use for matching.
 * `options` **{Object}**: See available [options](#options) for changing how matches are performed
 * `returns` **{Boolean}**: Returns true if any patterns match `str`
@@ -293,127 +279,88 @@ Returns true if **all** of the given `patterns` match the specified string.
 **Example**
 
 ```js
-var mm = require('micromatch');
-mm.all(string, patterns[, options]);
+const mm = require('micromatch');
+// mm.some(list, patterns[, options]);
 
-console.log(mm.all('foo.js', ['foo.js']));
+console.log(mm.some(['foo.js', 'bar.js'], ['*.js', '!foo.js']));
 // true
-
-console.log(mm.all('foo.js', ['*.js', '!foo.js']));
+console.log(mm.some(['foo.js'], ['*.js', '!foo.js']));
 // false
-
-console.log(mm.all('foo.js', ['*.js', 'foo.js']));
-// true
-
-console.log(mm.all('foo.js', ['*.js', 'f*', '*o*', '*o.js']));
-// true
 ```
 
-### [.not](index.js#L340)
-
-Returns a list of strings that _**do not match any**_ of the given `patterns`.
-
-**Params**
+### [.every](index.js#L283)
 
-* `list` **{Array}**: Array of strings to match.
-* `patterns` **{String|Array}**: One or more glob pattern to use for matching.
-* `options` **{Object}**: See available [options](#options) for changing how matches are performed
-* `returns` **{Array}**: Returns an array of strings that **do not match** the given patterns.
-
-**Example**
-
-```js
-var mm = require('micromatch');
-mm.not(list, patterns[, options]);
-
-console.log(mm.not(['a.a', 'b.b', 'c.c'], '*.a'));
-//=> ['b.b', 'c.c']
-```
-
-### [.contains](index.js#L376)
-
-Returns true if the given `string` contains the given pattern. Similar to [.isMatch](#isMatch) but the pattern can match any part of the string.
+Returns true if every string in the given `list` matches any of the given glob `patterns`.
 
 **Params**
 
-* `str` **{String}**: The string to match.
-* `patterns` **{String|Array}**: Glob pattern to use for matching.
+* `list` **{String|Array}**: The string or array of strings to test.
+* `patterns` **{String|Array}**: One or more glob patterns to use for matching.
 * `options` **{Object}**: See available [options](#options) for changing how matches are performed
-* `returns` **{Boolean}**: Returns true if the patter matches any part of `str`.
+* `returns` **{Boolean}**: Returns true if any patterns match `str`
 
 **Example**
 
 ```js
-var mm = require('micromatch');
-mm.contains(string, pattern[, options]);
+const mm = require('micromatch');
+// mm.every(list, patterns[, options]);
 
-console.log(mm.contains('aa/bb/cc', '*b'));
-//=> true
-console.log(mm.contains('aa/bb/cc', '*d'));
-//=> false
+console.log(mm.every('foo.js', ['foo.js']));
+// true
+console.log(mm.every(['foo.js', 'bar.js'], ['*.js']));
+// true
+console.log(mm.every(['foo.js', 'bar.js'], ['*.js', '!foo.js']));
+// false
+console.log(mm.every(['foo.js'], ['*.js', '!foo.js']));
+// false
 ```
 
-### [.matchKeys](index.js#L432)
+### [.all](index.js#L322)
 
-Filter the keys of the given object with the given `glob` pattern and `options`. Does not attempt to match nested keys. If you need this feature, use [glob-object](https://github.com/jonschlinkert/glob-object) instead.
+Returns true if **all** of the given `patterns` match the specified string.
 
 **Params**
 
-* `object` **{Object}**: The object with keys to filter.
+* `str` **{String|Array}**: The string to test.
 * `patterns` **{String|Array}**: One or more glob patterns to use for matching.
 * `options` **{Object}**: See available [options](#options) for changing how matches are performed
-* `returns` **{Object}**: Returns an object with only keys that match the given patterns.
+* `returns` **{Boolean}**: Returns true if any patterns match `str`
 
 **Example**
 
 ```js
-var mm = require('micromatch');
-mm.matchKeys(object, patterns[, options]);
-
-var obj = { aa: 'a', ab: 'b', ac: 'c' };
-console.log(mm.matchKeys(obj, '*b'));
-//=> { ab: 'b' }
-```
-
-### [.matcher](index.js#L461)
-
-Returns a memoized matcher function from the given glob `pattern` and `options`. The returned function takes a string to match as its only argument and returns true if the string is a match.
-
-**Params**
+const mm = require('micromatch');
+// mm.all(string, patterns[, options]);
 
-* `pattern` **{String}**: Glob pattern
-* `options` **{Object}**: See available [options](#options) for changing how matches are performed.
-* `returns` **{Function}**: Returns a matcher function.
+console.log(mm.all('foo.js', ['foo.js']));
+// true
 
-**Example**
+console.log(mm.all('foo.js', ['*.js', '!foo.js']));
+// false
 
-```js
-var mm = require('micromatch');
-mm.matcher(pattern[, options]);
+console.log(mm.all('foo.js', ['*.js', 'foo.js']));
+// true
 
-var isMatch = mm.matcher('*.!(*a)');
-console.log(isMatch('a.a'));
-//=> false
-console.log(isMatch('a.b'));
-//=> true
+console.log(mm.all('foo.js', ['*.js', 'f*', '*o*', '*o.js']));
+// true
 ```
 
-### [.capture](index.js#L536)
+### [.capture](index.js#L349)
 
 Returns an array of matches captured by `pattern` in `string, or`null` if the pattern did not match.
 
 **Params**
 
-* `pattern` **{String}**: Glob pattern to use for matching.
-* `string` **{String}**: String to match
+* `glob` **{String}**: Glob pattern to use for matching.
+* `input` **{String}**: String to match
 * `options` **{Object}**: See available [options](#options) for changing how matches are performed
-* `returns` **{Boolean}**: Returns an array of captures if the string matches the glob pattern, otherwise `null`.
+* `returns` **{Boolean}**: Returns an array of captures if the input matches the glob pattern, otherwise `null`.
 
 **Example**
 
 ```js
-var mm = require('micromatch');
-mm.capture(pattern, string[, options]);
+const mm = require('micromatch');
+// mm.capture(pattern, string[, options]);
 
 console.log(mm.capture('test/*.js', 'test/foo.js'));
 //=> ['foo']
@@ -421,186 +368,125 @@ console.log(mm.capture('test/*.js', 'foo/bar.css'));
 //=> null
 ```
 
-### [.makeRe](index.js#L571)
+### [.makeRe](index.js#L375)
 
 Create a regular expression from the given glob `pattern`.
 
 **Params**
 
 * `pattern` **{String}**: A glob pattern to convert to regex.
-* `options` **{Object}**: See available [options](#options) for changing how matches are performed.
+* `options` **{Object}**
 * `returns` **{RegExp}**: Returns a regex created from the given pattern.
 
 **Example**
 
 ```js
-var mm = require('micromatch');
-mm.makeRe(pattern[, options]);
+const mm = require('micromatch');
+// mm.makeRe(pattern[, options]);
 
 console.log(mm.makeRe('*.js'));
 //=> /^(?:(\.[\\\/])?(?!\.)(?=.)[^\/]*?\.js)$/
 ```
 
-### [.braces](index.js#L618)
+### [.scan](index.js#L391)
 
-Expand the given brace `pattern`.
+Scan a glob pattern to separate the pattern into segments. Used by the [split](#split) method.
 
 **Params**
 
-* `pattern` **{String}**: String with brace pattern to expand.
-* `options` **{Object}**: Any [options](#options) to change how expansion is performed. See the [braces](https://github.com/micromatch/braces) library for all available options.
-* `returns` **{Array}**
-
-**Example**
-
-```js
-var mm = require('micromatch');
-console.log(mm.braces('foo/{a,b}/bar'));
-//=> ['foo/(a|b)/bar']
-
-console.log(mm.braces('foo/{a,b}/bar', {expand: true}));
-//=> ['foo/(a|b)/bar']
-```
-
-### [.create](index.js#L685)
-
-Parses the given glob `pattern` and returns an array of abstract syntax trees (ASTs), with the compiled `output` and optional source `map` on each AST.
-
-**Params**
-
-* `pattern` **{String}**: Glob pattern to parse and compile.
-* `options` **{Object}**: Any [options](#options) to change how parsing and compiling is performed.
-* `returns` **{Object}**: Returns an object with the parsed AST, compiled string and optional source map.
+* `pattern` **{String}**
+* `options` **{Object}**
+* `returns` **{Object}**: Returns an object with
 
 **Example**
 
 ```js
-var mm = require('micromatch');
-mm.create(pattern[, options]);
-
-console.log(mm.create('abc/*.js'));
-// [{ options: { source: 'string', sourcemap: true },
-//   state: {},
-//   compilers:
-//    { ... },
-//   output: '(\\.[\\\\\\/])?abc\\/(?!\\.)(?=.)[^\\/]*?\\.js',
-//   ast:
-//    { type: 'root',
-//      errors: [],
-//      nodes:
-//       [ ... ],
-//      dot: false,
-//      input: 'abc/*.js' },
-//   parsingErrors: [],
-//   map:
-//    { version: 3,
-//      sources: [ 'string' ],
-//      names: [],
-//      mappings: 'AAAA,GAAG,EAAC,kBAAC,EAAC,EAAE',
-//      sourcesContent: [ 'abc/*.js' ] },
-//   position: { line: 1, column: 28 },
-//   content: {},
-//   files: {},
-//   idx: 6 }]
+const mm = require('micromatch');
+const state = mm.scan(pattern[, options]);
 ```
 
-### [.parse](index.js#L732)
+### [.parse](index.js#L407)
 
-Parse the given `str` with the given `options`.
+Parse a glob pattern to create the source string for a regular expression.
 
 **Params**
 
-* `str` **{String}**
+* `glob` **{String}**
 * `options` **{Object}**
-* `returns` **{Object}**: Returns an AST
+* `returns` **{Object}**: Returns an object with useful properties and output to be used as regex source string.
 
 **Example**
 
 ```js
-var mm = require('micromatch');
-mm.parse(pattern[, options]);
-
-var ast = mm.parse('a/{b,c}/d');
-console.log(ast);
-// { type: 'root',
-//   errors: [],
-//   input: 'a/{b,c}/d',
-//   nodes:
-//    [ { type: 'bos', val: '' },
-//      { type: 'text', val: 'a/' },
-//      { type: 'brace',
-//        nodes:
-//         [ { type: 'brace.open', val: '{' },
-//           { type: 'text', val: 'b,c' },
-//           { type: 'brace.close', val: '}' } ] },
-//      { type: 'text', val: '/d' },
-//      { type: 'eos', val: '' } ] }
+const mm = require('micromatch');
+const state = mm(pattern[, options]);
 ```
 
-### [.compile](index.js#L780)
+### [.braces](index.js#L434)
 
-Compile the given `ast` or string with the given `options`.
+Process the given brace `pattern`.
 
 **Params**
 
-* `ast` **{Object|String}**
-* `options` **{Object}**
-* `returns` **{Object}**: Returns an object that has an `output` property with the compiled string.
+* `pattern` **{String}**: String with brace pattern to process.
+* `options` **{Object}**: Any [options](#options) to change how expansion is performed. See the [braces](https://github.com/micromatch/braces) library for all available options.
+* `returns` **{Array}**
 
 **Example**
 
 ```js
-var mm = require('micromatch');
-mm.compile(ast[, options]);
-
-var ast = mm.parse('a/{b,c}/d');
-console.log(mm.compile(ast));
-// { options: { source: 'string' },
-//   state: {},
-//   compilers:
-//    { eos: [Function],
-//      noop: [Function],
-//      bos: [Function],
-//      brace: [Function],
-//      'brace.open': [Function],
-//      text: [Function],
-//      'brace.close': [Function] },
-//   output: [ 'a/(b|c)/d' ],
-//   ast:
-//    { ... },
-//   parsingErrors: [] }
-```
-
-### [.clearCache](index.js#L801)
+const { braces } = require('micromatch');
+console.log(braces('foo/{a,b,c}/bar'));
+//=> [ 'foo/(a|b|c)/bar' ]
 
-Clear the regex cache.
-
-**Example**
-
-```js
-mm.clearCache();
+console.log(braces('foo/{a,b,c}/bar', { expand: true }));
+//=> [ 'foo/a/bar', 'foo/b/bar', 'foo/c/bar' ]
 ```
 
 ## Options
 
-* [basename](#optionsbasename)
-* [bash](#optionsbash)
-* [cache](#optionscache)
-* [dot](#optionsdot)
-* [failglob](#optionsfailglob)
-* [ignore](#optionsignore)
-* [matchBase](#optionsmatchBase)
-* [nobrace](#optionsnobrace)
-* [nocase](#optionsnocase)
-* [nodupes](#optionsnodupes)
-* [noext](#optionsnoext)
-* [noglobstar](#optionsnoglobstar)
-* [nonull](#optionsnonull)
-* [nullglob](#optionsnullglob)
-* [snapdragon](#optionssnapdragon)
-* [sourcemap](#optionssourcemap)
-* [unescape](#optionsunescape)
-* [unixify](#optionsunixify)
+| **Option** | **Type** | **Default value** | **Description** |
+| --- | --- | --- | --- |
+| `basename`            | `boolean`      | `false`     | If set, then patterns without slashes will be matched against the basename of the path if it contains slashes.  For example, `a?b` would match the path `/xyz/123/acb`, but not `/xyz/acb/123`. |
+| `bash`                | `boolean`      | `false`     | Follow bash matching rules more strictly - disallows backslashes as escape characters, and treats single stars as globstars (`**`). |
+| `capture`             | `boolean`      | `undefined` | Return regex matches in supporting methods. |
+| `contains`            | `boolean`      | `undefined` | Allows glob to match any part of the given string(s). |
+| `cwd`                 | `string`       | `process.cwd()` | Current working directory. Used by `picomatch.split()` |
+| `debug`               | `boolean`      | `undefined` | Debug regular expressions when an error is thrown. |
+| `dot`                 | `boolean`      | `false`     | Match dotfiles. Otherwise dotfiles are ignored unless a `.` is explicitly defined in the pattern. |
+| `expandRange`         | `function`     | `undefined` | Custom function for expanding ranges in brace patterns, such as `{a..z}`. The function receives the range values as two arguments, and it must return a string to be used in the generated regex. It's recommended that returned strings be wrapped in parentheses. This option is overridden by the `expandBrace` option. |
+| `failglob`            | `boolean`      | `false`     | Similar to the `failglob` behavior in Bash, throws an error when no matches are found. Based on the bash option of the same name. |
+| `fastpaths`           | `boolean`      | `true`      | To speed up processing, full parsing is skipped for a handful common glob patterns. Disable this behavior by setting this option to `false`. |
+| `flags`               | `boolean`      | `undefined` | Regex flags to use in the generated regex. If defined, the `nocase` option will be overridden. |
+| [format](#optionsformat) | `function` | `undefined` | Custom function for formatting the returned string. This is useful for removing leading slashes, converting Windows paths to Posix paths, etc. |
+| `ignore`              | `array\|string` | `undefined` | One or more glob patterns for excluding strings that should not be matched from the result. |
+| `keepQuotes`          | `boolean`      | `false`     | Retain quotes in the generated regex, since quotes may also be used as an alternative to backslashes.  |
+| `literalBrackets`     | `boolean`      | `undefined` | When `true`, brackets in the glob pattern will be escaped so that only literal brackets will be matched. |
+| `lookbehinds`         | `boolean`      | `true`      | Support regex positive and negative lookbehinds. Note that you must be using Node 8.1.10 or higher to enable regex lookbehinds. |
+| `matchBase`           | `boolean`      | `false`     | Alias for `basename` |
+| `maxLength`           | `boolean`      | `65536`     | Limit the max length of the input string. An error is thrown if the input string is longer than this value. |
+| `nobrace`             | `boolean`      | `false`     | Disable brace matching, so that `{a,b}` and `{1..3}` would be treated as literal characters. |
+| `nobracket`           | `boolean`      | `undefined` | Disable matching with regex brackets. |
+| `nocase`              | `boolean`      | `false`     | Perform case-insensitive matching. Equivalent to the regex `i` flag. Note that this option is ignored when the `flags` option is defined. |
+| `nodupes`             | `boolean`      | `true`      | Deprecated, use `nounique` instead. This option will be removed in a future major release. By default duplicates are removed. Disable uniquification by setting this option to false. |
+| `noext`               | `boolean`      | `false`     | Alias for `noextglob` |
+| `noextglob`           | `boolean`      | `false`     | Disable support for matching with [extglobs](#extglobs) (like `+(a\|b)`) |
+| `noglobstar`          | `boolean`      | `false`     | Disable support for matching nested directories with globstars (`**`) |
+| `nonegate`            | `boolean`      | `false`     | Disable support for negating with leading `!` |
+| `noquantifiers`       | `boolean`      | `false`     | Disable support for regex quantifiers (like `a{1,2}`) and treat them as brace patterns to be expanded. |
+| [onIgnore](#optionsonIgnore) | `function` | `undefined` | Function to be called on ignored items. |
+| [onMatch](#optionsonMatch) | `function` | `undefined` | Function to be called on matched items. |
+| [onResult](#optionsonResult) | `function` | `undefined` | Function to be called on all items, regardless of whether or not they are matched or ignored. |
+| `posix`               | `boolean`      | `false`     | Support [POSIX character classes](#posix-bracket-expressions) ("posix brackets"). |
+| `posixSlashes`        | `boolean`      | `undefined` | Convert all slashes in file paths to forward slashes. This does not convert slashes in the glob pattern itself |
+| `prepend`             | `boolean`      | `undefined` | String to prepend to the generated regex used for matching. |
+| `regex`               | `boolean`      | `false`     | Use regular expression rules for `+` (instead of matching literal `+`), and for stars that follow closing parentheses or brackets (as in `)*` and `]*`). |
+| `strictBrackets`      | `boolean`      | `undefined` | Throw an error if brackets, braces, or parens are imbalanced. |
+| `strictSlashes`       | `boolean`      | `undefined` | When true, picomatch won't match trailing slashes with single stars. |
+| `unescape`            | `boolean`      | `undefined` | Remove preceding backslashes from escaped glob characters before creating the regular expression to perform matches. |
+| `unixify`             | `boolean`      | `undefined` | Alias for `posixSlashes`, for backwards compatitibility. |
+
+## Options Examples
 
 ### options.basename
 
@@ -613,16 +499,16 @@ Allow glob patterns without slashes to match a file path based on its basename.
 **Example**
 
 ```js
-mm(['a/b.js', 'a/c.md'], '*.js');
+micromatch(['a/b.js', 'a/c.md'], '*.js');
 //=> []
 
-mm(['a/b.js', 'a/c.md'], '*.js', {matchBase: true});
+micromatch(['a/b.js', 'a/c.md'], '*.js', { basename: true });
 //=> ['a/b.js']
 ```
 
 ### options.bash
 
-Enabled by default, this option enforces bash-like behavior with stars immediately following a bracket expression. Bash bracket expressions are similar to regex character classes, but unlike regex, a star following a bracket expression **does not repeat the bracketed characters**. Instead, the star is treated the same as an other star.
+Enabled by default, this option enforces bash-like behavior with stars immediately following a bracket expression. Bash bracket expressions are similar to regex character classes, but unlike regex, a star following a bracket expression **does not repeat the bracketed characters**. Instead, the star is treated the same as any other star.
 
 **Type**: `Boolean`
 
@@ -631,90 +517,83 @@ Enabled by default, this option enforces bash-like behavior with stars immediate
 **Example**
 
 ```js
-var files = ['abc', 'ajz'];
-console.log(mm(files, '[a-c]*'));
+const files = ['abc', 'ajz'];
+console.log(micromatch(files, '[a-c]*'));
 //=> ['abc', 'ajz']
 
-console.log(mm(files, '[a-c]*', {bash: false}));
+console.log(micromatch(files, '[a-c]*', { bash: false }));
 ```
 
-### options.cache
+### options.expandRange
 
-Disable regex and function memoization.
-
-**Type**: `Boolean`
+**Type**: `function`
 
 **Default**: `undefined`
 
-### options.dot
-
-Match dotfiles. Same behavior as [minimatch](https://github.com/isaacs/minimatch) option `dot`.
-
-**Type**: `Boolean`
-
-**Default**: `false`
-
-### options.failglob
+Custom function for expanding ranges in brace patterns. The [fill-range](https://github.com/jonschlinkert/fill-range) library is ideal for this purpose, or you can use custom code to do whatever you need.
 
-Similar to the `--failglob` behavior in Bash, throws an error when no matches are found.
-
-**Type**: `Boolean`
-
-**Default**: `undefined`
-
-### options.ignore
-
-String or array of glob patterns to match files to ignore.
+**Example**
 
-**Type**: `String|Array`
+The following example shows how to create a glob that matches a numeric folder name between `01` and `25`, with leading zeros.
 
-**Default**: `undefined`
+```js
+const fill = require('fill-range');
+const regex = micromatch.makeRe('foo/{01..25}/bar', {
+  expandRange(a, b) {
+    return `(${fill(a, b, { toRegex: true })})`;
+  }
+});
 
-### options.matchBase
+console.log(regex)
+//=> /^(?:foo\/((?:0[1-9]|1[0-9]|2[0-5]))\/bar)$/
 
-Alias for [options.basename](#options-basename).
+console.log(regex.test('foo/00/bar')) // false
+console.log(regex.test('foo/01/bar')) // true
+console.log(regex.test('foo/10/bar')) // true
+console.log(regex.test('foo/22/bar')) // true
+console.log(regex.test('foo/25/bar')) // true
+console.log(regex.test('foo/26/bar')) // false
+```
 
-### options.nobrace
+### options.format
 
-Disable expansion of brace patterns. Same behavior as [minimatch](https://github.com/isaacs/minimatch) option `nobrace`.
-
-**Type**: `Boolean`
+**Type**: `function`
 
 **Default**: `undefined`
 
-See [braces](https://github.com/micromatch/braces) for more information about extended brace expansion.
-
-### options.nocase
+Custom function for formatting strings before they're matched.
 
-Use a case-insensitive regex for matching files. Same behavior as [minimatch](https://github.com/isaacs/minimatch).
-
-**Type**: `Boolean`
+**Example**
 
-**Default**: `undefined`
+```js
+// strip leading './' from strings
+const format = str => str.replace(/^\.\//, '');
+const isMatch = picomatch('foo/*.js', { format });
+console.log(isMatch('./foo/bar.js')) //=> true
+```
 
-### options.nodupes
+### options.ignore
 
-Remove duplicate elements from the result array.
+String or array of glob patterns to match files to ignore.
 
-**Type**: `Boolean`
+**Type**: `String|Array`
 
 **Default**: `undefined`
 
-**Example**
-
-Example of using the `unescape` and `nodupes` options together:
-
 ```js
-mm.match(['a/b/c', 'a/b/c'], 'a/b/c');
-//=> ['a/b/c', 'a/b/c']
-
-mm.match(['a/b/c', 'a/b/c'], 'a/b/c', {nodupes: true});
-//=> ['abc']
+const isMatch = micromatch.matcher('*', { ignore: 'f*' });
+console.log(isMatch('foo')) //=> false
+console.log(isMatch('bar')) //=> true
+console.log(isMatch('baz')) //=> true
 ```
 
-### options.noext
+### options.matchBase
+
+Alias for [options.basename](#options-basename).
+
+### options.noextglob
 
-Disable extglob support, so that extglobs are regarded as literal characters.
+Disable extglob support, so that [extglobs](#extglobs) are regarded as literal characters.
 
 **Type**: `Boolean`
 
@@ -723,10 +602,10 @@ Disable extglob support, so that extglobs are regarded as literal characters.
 **Examples**
 
 ```js
-mm(['a/z', 'a/b', 'a/!(z)'], 'a/!(z)');
+console.log(micromatch(['a/z', 'a/b', 'a/!(z)'], 'a/!(z)'));
 //=> ['a/b', 'a/!(z)']
 
-mm(['a/z', 'a/b', 'a/!(z)'], 'a/!(z)', {noext: true});
+console.log(micromatch(['a/z', 'a/b', 'a/!(z)'], 'a/!(z)', { noextglob: true }));
 //=> ['a/!(z)'] (matches only as literal characters)
 ```
 
@@ -747,10 +626,10 @@ Disable matching with globstars (`**`).
 **Default**: `undefined`
 
 ```js
-mm(['a/b', 'a/b/c', 'a/b/c/d'], 'a/**');
+micromatch(['a/b', 'a/b/c', 'a/b/c/d'], 'a/**');
 //=> ['a/b', 'a/b/c', 'a/b/c/d']
 
-mm(['a/b', 'a/b/c', 'a/b/c/d'], 'a/**', {noglobstar: true});
+micromatch(['a/b', 'a/b/c', 'a/b/c/d'], 'a/**', {noglobstar: true});
 //=> ['a/b']
 ```
 
@@ -766,100 +645,99 @@ If `true`, when no matches are found the actual (arrayified) glob pattern is ret
 
 **Default**: `undefined`
 
-### options.snapdragon
+### options.onIgnore
 
-Pass your own instance of [snapdragon](https://github.com/jonschlinkert/snapdragon), to customize parsers or compilers.
+```js
+const onIgnore = ({ glob, regex, input, output }) => {
+  console.log({ glob, regex, input, output });
+  // { glob: '*', regex: /^(?:(?!\.)(?=.)[^\/]*?\/?)$/, input: 'foo', output: 'foo' }
+};
 
-**Type**: `Object`
+const isMatch = micromatch.matcher('*', { onIgnore, ignore: 'f*' });
+isMatch('foo');
+isMatch('bar');
+isMatch('baz');
+```
 
-**Default**: `undefined`
+### options.onMatch
 
-### options.sourcemap
+```js
+const onMatch = ({ glob, regex, input, output }) => {
+  console.log({ input, output });
+  // { input: 'some\\path', output: 'some/path' }
+  // { input: 'some\\path', output: 'some/path' }
+  // { input: 'some\\path', output: 'some/path' }
+};
 
-Generate a source map by enabling the `sourcemap` option with the `.parse`, `.compile`, or `.create` methods.
+const isMatch = micromatch.matcher('**', { onMatch, posixSlashes: true });
+isMatch('some\\path');
+isMatch('some\\path');
+isMatch('some\\path');
+```
 
-_(Note that sourcemaps are currently not enabled for brace patterns)_
+### options.onResult
 
-**Examples**
+```js
+const onResult = ({ glob, regex, input, output }) => {
+  console.log({ glob, regex, input, output });
+};
 
-``` js
-var mm = require('micromatch');
-var pattern = '*(*(of*(a)x)z)';
-
-var res = mm.create('abc/*.js', {sourcemap: true});
-console.log(res.map);
-// { version: 3,
-//   sources: [ 'string' ],
-//   names: [],
-//   mappings: 'AAAA,GAAG,EAAC,iBAAC,EAAC,EAAE',
-//   sourcesContent: [ 'abc/*.js' ] }
-
-var ast = mm.parse('abc/**/*.js');
-var res = mm.compile(ast, {sourcemap: true});
-console.log(res.map);
-// { version: 3,
-//   sources: [ 'string' ],
-//   names: [],
-//   mappings: 'AAAA,GAAG,EAAC,2BAAE,EAAC,iBAAC,EAAC,EAAE',
-//   sourcesContent: [ 'abc/**/*.js' ] }
-
-var ast = mm.parse(pattern);
-var res = mm.compile(ast, {sourcemap: true});
-console.log(res.map);
-// { version: 3,
-//   sources: [ 'string' ],
-//   names: [],
-//   mappings: 'AAAA,CAAE,CAAE,EAAE,CAAE,CAAC,EAAC,CAAC,EAAC,CAAC,EAAC',
-//   sourcesContent: [ '*(*(of*(a)x)z)' ] }
+const isMatch = micromatch('*', { onResult, ignore: 'f*' });
+isMatch('foo');
+isMatch('bar');
+isMatch('baz');
 ```
 
-### options.unescape
+### options.posixSlashes
 
-Remove backslashes from returned matches.
+Convert path separators on returned files to posix/unix-style forward slashes. Aliased as `unixify` for backwards compatibility.
 
 **Type**: `Boolean`
 
-**Default**: `undefined`
+**Default**: `true` on windows, `false` everywhere else.
 
 **Example**
 
-In this example we want to match a literal `*`:
-
 ```js
-mm.match(['abc', 'a\\*c'], 'a\\*c');
-//=> ['a\\*c']
+console.log(micromatch.match(['a\\b\\c'], 'a/**'));
+//=> ['a/b/c']
 
-mm.match(['abc', 'a\\*c'], 'a\\*c', {unescape: true});
-//=> ['a*c']
+console.log(micromatch.match(['a\\b\\c'], { posixSlashes: false }));
+//=> ['a\\b\\c']
 ```
 
-### options.unixify
+### options.unescape
 
-Convert path separators on returned files to posix/unix-style forward slashes.
+Remove backslashes from escaped glob characters before creating the regular expression to perform matches.
 
 **Type**: `Boolean`
 
-**Default**: `true` on windows, `false` everywhere else
+**Default**: `undefined`
 
 **Example**
 
+In this example we want to match a literal `*`:
+
 ```js
-mm.match(['a\\b\\c'], 'a/**');
-//=> ['a/b/c']
+console.log(micromatch.match(['abc', 'a\\*c'], 'a\\*c'));
+//=> ['a\\*c']
 
-mm.match(['a\\b\\c'], {unixify: false});
-//=> ['a\\b\\c']
+console.log(micromatch.match(['abc', 'a\\*c'], 'a\\*c', { unescape: true }));
+//=> ['a*c']
 ```
 
+<br>
+<br>
+
 ## Extended globbing
 
-Micromatch also supports extended globbing features.
+Micromatch supports the following extended globbing features.
 
-### extglobs
+### Extglobs
 
 Extended globbing, as described by the bash man page:
 
-| **pattern** | **regex equivalent** | **description** | 
+| **pattern** | **regex equivalent** | **description** |
 | --- | --- | --- |
 | `?(pattern)` | `(pattern)?` | Matches zero or one occurrence of the given patterns |
 | `*(pattern)` | `(pattern)*` | Matches zero or more occurrences of the given patterns |
@@ -867,13 +745,15 @@ Extended globbing, as described by the bash man page:
 | `@(pattern)` | `(pattern)` <sup>*</sup> | Matches one of the given patterns |
 | `!(pattern)` | N/A (equivalent regex is much more complicated) | Matches anything except one of the given patterns |
 
-<sup><strong>*</strong></sup> Note that `@` isn't a RegEx character.
+<sup><strong>*</strong></sup> Note that `@` isn't a regex character.
 
-Powered by [extglob](https://github.com/micromatch/extglob). Visit that library for the full range of options or to report extglob related issues.
+### Braces
 
-### braces
+Brace patterns can be used to match specific ranges or sets of characters.
 
-Brace patterns can be used to match specific ranges or sets of characters. For example, the pattern `*/{1..3}/*` would match any of following strings:
+**Example**
+
+The pattern `{f,b}*/{1..3}/{b,q}*` would match any of following strings:
 
 ```
 foo/1/bar
@@ -886,7 +766,7 @@ baz/3/qux
 
 Visit [braces](https://github.com/micromatch/braces) to see the full range of features and options related to brace expansion, or to create brace matching or expansion related issues.
 
-### regex character classes
+### Regex character classes
 
 Given the list: `['a.js', 'b.js', 'c.js', 'd.js', 'E.js']`:
 
@@ -897,7 +777,7 @@ Given the list: `['a.js', 'b.js', 'c.js', 'd.js', 'E.js']`:
 
 Learn about [regex character classes](http://www.regular-expressions.info/charclass.html).
 
-### regex groups
+### Regex groups
 
 Given `['a.js', 'b.js', 'c.js', 'd.js', 'E.js']`:
 
@@ -914,15 +794,10 @@ POSIX brackets are intended to be more user-friendly than regex character classe
 **Example**
 
 ```js
-mm.isMatch('a1', '[[:alpha:][:digit:]]');
-//=> true
-
-mm.isMatch('a1', '[[:alpha:][:alpha:]]');
-//=> false
+console.log(micromatch.isMatch('a1', '[[:alpha:][:digit:]]')) //=> true
+console.log(micromatch.isMatch('a1', '[[:alpha:][:alpha:]]')) //=> false
 ```
 
-See [expand-brackets](https://github.com/jonschlinkert/expand-brackets) for more information about bracket expressions.
-
 ***
 
 ## Notes
@@ -937,13 +812,13 @@ However, it's suprising how many edge cases and rabbit holes there are with glob
 
 There is an important, notable difference between minimatch and micromatch _in regards to how backslashes are handled_ in glob patterns.
 
-* Micromatch exclusively and explicitly reserves backslashes for escaping characters in a glob pattern, even on windows. This is consistent with bash behavior.
+* Micromatch exclusively and explicitly reserves backslashes for escaping characters in a glob pattern, even on windows, which is consistent with bash behavior. _More importantly, unescaping globs can result in unsafe regular expressions_.
 * Minimatch converts all backslashes to forward slashes, which means you can't use backslashes to escape any characters in your glob patterns.
 
 We made this decision for micromatch for a couple of reasons:
 
-* consistency with bash conventions.
-* glob patterns are not filepaths. They are a type of [regular language](https://en.wikipedia.org/wiki/Regular_language) that is converted to a JavaScript regular expression. Thus, when forward slashes are defined in a glob pattern, the resulting regular expression will match windows or POSIX path separators just fine.
+* Consistency with bash conventions.
+* Glob patterns are not filepaths. They are a type of [regular language](https://en.wikipedia.org/wiki/Regular_language) that is converted to a JavaScript regular expression. Thus, when forward slashes are defined in a glob pattern, the resulting regular expression will match windows or POSIX path separators just fine.
 
 **A note about joining paths to globs**
 
@@ -951,122 +826,94 @@ Note that when you pass something like `path.join('foo', '*')` to micromatch, yo
 
 In other words, since `\\` is reserved as an escape character in globs, on windows `path.join('foo', '*')` would result in `foo\\*`, which tells micromatch to match `*` as a literal character. This is the same behavior as bash.
 
-## Contributing
-
-All contributions are welcome! Please read [the contributing guide](.github/contributing.md) to get started.
-
-**Bug reports**
-
-Please create an issue if you encounter a bug or matching behavior that doesn't seem correct. If you find a matching-related issue, please:
-
-* [research existing issues first](../../issues) (open and closed)
-* visit the [GNU Bash documentation](https://www.gnu.org/software/bash/manual/) to see how Bash deals with the pattern
-* visit the [minimatch](https://github.com/isaacs/minimatch) documentation to cross-check expected behavior in node.js
-* if all else fails, since there is no real specification for globs we will probably need to discuss expected behavior and decide how to resolve it. which means any detail you can provide to help with this discussion would be greatly appreciated.
-
-**Platform issues**
-
-It's important to us that micromatch work consistently on all platforms. If you encounter any platform-specific matching or path related issues, please let us know (pull requests are also greatly appreciated).
+To solve this, you might be inspired to do something like `'foo\\*'.replace(/\\/g, '/')`, but this causes another, potentially much more serious, problem.
 
 ## Benchmarks
 
 ### Running benchmarks
 
-Install dev dependencies:
+Install dependencies for running benchmarks:
 
-```bash
-npm i -d && npm run benchmark
+```sh
+$ cd bench && npm install 
 ```
 
-### Latest results
-
-As of February 18, 2018 (longer bars are better):
+Run the benchmarks:
 
 ```sh
-# braces-globstar-large-list (485691 bytes)
-  micromatch ██████████████████████████████████████████████████ (517 ops/sec ±0.49%)
-  minimatch  █ (18.92 ops/sec ±0.54%)
-  multimatch █ (18.94 ops/sec ±0.62%)
-
-  micromatch is faster by an avg. of 2,733%
-
-# braces-multiple (3362 bytes)
-  micromatch ██████████████████████████████████████████████████ (33,625 ops/sec ±0.45%)
-  minimatch   (2.92 ops/sec ±3.26%)
-  multimatch  (2.90 ops/sec ±2.76%)
+$ npm run bench
+```
 
-  micromatch is faster by an avg. of 1,156,935%
+### Latest results
 
-# braces-range (727 bytes)
-  micromatch █████████████████████████████████████████████████ (155,220 ops/sec ±0.56%)
-  minimatch  ██████ (20,186 ops/sec ±1.27%)
-  multimatch ██████ (19,809 ops/sec ±0.60%)
+As of April 10, 2019 (longer bars are better):
 
-  micromatch is faster by an avg. of 776%
+```sh
+# .makeRe star
+  micromatch x 1,724,735 ops/sec ±1.69% (87 runs sampled))
+  minimatch x 649,565 ops/sec ±1.93% (91 runs sampled)
 
-# braces-set (2858 bytes)
-  micromatch █████████████████████████████████████████████████ (24,354 ops/sec ±0.92%)
-  minimatch  █████ (2,566 ops/sec ±0.56%)
-  multimatch ████ (2,431 ops/sec ±1.25%)
+# .makeRe star; dot=true
+  micromatch x 1,302,127 ops/sec ±1.43% (92 runs sampled)
+  minimatch x 556,242 ops/sec ±0.71% (86 runs sampled)
 
-  micromatch is faster by an avg. of 975%
+# .makeRe globstar
+  micromatch x 1,393,992 ops/sec ±0.71% (89 runs sampled)
+  minimatch x 1,112,801 ops/sec ±2.02% (91 runs sampled)
 
-# globstar-large-list (485686 bytes)
-  micromatch █████████████████████████████████████████████████ (504 ops/sec ±0.45%)
-  minimatch  ███ (33.36 ops/sec ±1.08%)
-  multimatch ███ (33.19 ops/sec ±1.35%)
+# .makeRe globstars
+  micromatch x 1,419,097 ops/sec ±0.34% (94 runs sampled)
+  minimatch x 541,207 ops/sec ±1.66% (93 runs sampled)
 
-  micromatch is faster by an avg. of 1,514%
+# .makeRe with leading star
+  micromatch x 1,247,825 ops/sec ±0.97% (94 runs sampled)
+  minimatch x 489,660 ops/sec ±0.63% (94 runs sampled)
 
-# globstar-long-list (90647 bytes)
-  micromatch ██████████████████████████████████████████████████ (2,694 ops/sec ±1.08%)
-  minimatch  ████████████████ (870 ops/sec ±1.09%)
-  multimatch ████████████████ (862 ops/sec ±0.84%)
+# .makeRe - braces
+  micromatch x 206,301 ops/sec ±1.62% (81 runs sampled))
+  minimatch x 115,986 ops/sec ±0.59% (94 runs sampled)
 
-  micromatch is faster by an avg. of 311%
+# .makeRe braces - range (expanded)
+  micromatch x 27,782 ops/sec ±0.79% (88 runs sampled)
+  minimatch x 4,683 ops/sec ±1.20% (92 runs sampled)
 
-# globstar-short-list (182 bytes)
-  micromatch ██████████████████████████████████████████████████ (328,921 ops/sec ±1.06%)
-  minimatch  █████████ (64,808 ops/sec ±1.42%)
-  multimatch ████████ (57,991 ops/sec ±2.11%)
+# .makeRe braces - range (compiled)
+  micromatch x 134,056 ops/sec ±2.73% (77 runs sampled))
+  minimatch x 977 ops/sec ±0.85% (91 runs sampled)d)
 
-  micromatch is faster by an avg. of 536%
+# .makeRe braces - nested ranges (expanded)
+  micromatch x 18,353 ops/sec ±0.95% (91 runs sampled)
+  minimatch x 4,514 ops/sec ±1.04% (93 runs sampled)
 
-# no-glob (701 bytes)
-  micromatch █████████████████████████████████████████████████ (415,935 ops/sec ±0.36%)
-  minimatch  ███████████ (92,730 ops/sec ±1.44%)
-  multimatch █████████ (81,958 ops/sec ±2.13%)
+# .makeRe braces - nested ranges (compiled)
+  micromatch x 38,916 ops/sec ±1.85% (82 runs sampled)
+  minimatch x 980 ops/sec ±0.54% (93 runs sampled)d)
 
-  micromatch is faster by an avg. of 476%
+# .makeRe braces - set (compiled)
+  micromatch x 141,088 ops/sec ±1.70% (70 runs sampled))
+  minimatch x 43,385 ops/sec ±0.87% (93 runs sampled)
 
-# star-basename-long (12339 bytes)
-  micromatch █████████████████████████████████████████████████ (7,963 ops/sec ±0.36%)
-  minimatch  ███████████████████████████████ (5,072 ops/sec ±0.83%)
-  multimatch ███████████████████████████████ (5,028 ops/sec ±0.40%)
+# .makeRe braces - nested sets (compiled)
+  micromatch x 87,272 ops/sec ±2.85% (71 runs sampled))
+  minimatch x 25,327 ops/sec ±1.59% (86 runs sampled)
+```
 
-  micromatch is faster by an avg. of 158%
+## Contributing
 
-# star-basename-short (349 bytes)
-  micromatch ██████████████████████████████████████████████████ (269,552 ops/sec ±0.70%)
-  minimatch  ██████████████████████ (122,457 ops/sec ±1.39%)
-  multimatch ████████████████████ (110,788 ops/sec ±1.99%)
+All contributions are welcome! Please read [the contributing guide](.github/contributing.md) to get started.
 
-  micromatch is faster by an avg. of 231%
+**Bug reports**
 
-# star-folder-long (19207 bytes)
-  micromatch █████████████████████████████████████████████████ (3,806 ops/sec ±0.38%)
-  minimatch  ████████████████████████████ (2,204 ops/sec ±0.32%)
-  multimatch ██████████████████████████ (2,020 ops/sec ±1.07%)
+Please create an issue if you encounter a bug or matching behavior that doesn't seem correct. If you find a matching-related issue, please:
 
-  micromatch is faster by an avg. of 180%
+* [research existing issues first](../../issues) (open and closed)
+* visit the [GNU Bash documentation](https://www.gnu.org/software/bash/manual/) to see how Bash deals with the pattern
+* visit the [minimatch](https://github.com/isaacs/minimatch) documentation to cross-check expected behavior in node.js
+* if all else fails, since there is no real specification for globs we will probably need to discuss expected behavior and decide how to resolve it. which means any detail you can provide to help with this discussion would be greatly appreciated.
 
-# star-folder-short (551 bytes)
-  micromatch ██████████████████████████████████████████████████ (249,077 ops/sec ±0.40%)
-  minimatch  ███████████ (59,431 ops/sec ±1.67%)
-  multimatch ███████████ (55,569 ops/sec ±1.43%)
+**Platform issues**
 
-  micromatch is faster by an avg. of 433%
-```
+It's important to us that micromatch work consistently on all platforms. If you encounter any platform-specific matching or path related issues, please let us know (pull requests are also greatly appreciated).
 
 ## About
 
@@ -1108,43 +955,46 @@ $ npm install -g verbose/verb#dev verb-generate-readme && verb
 You might also be interested in these projects:
 
 * [braces](https://www.npmjs.com/package/braces): Bash-like brace expansion, implemented in JavaScript. Safer than other brace expansion libs, with complete support… [more](https://github.com/micromatch/braces) | [homepage](https://github.com/micromatch/braces "Bash-like brace expansion, implemented in JavaScript. Safer than other brace expansion libs, with complete support for the Bash 4.3 braces specification, without sacrificing speed.")
-* [expand-brackets](https://www.npmjs.com/package/expand-brackets): Expand POSIX bracket expressions (character classes) in glob patterns. | [homepage](https://github.com/jonschlinkert/expand-brackets "Expand POSIX bracket expressions (character classes) in glob patterns.")
+* [expand-brackets](https://www.npmjs.com/package/expand-brackets): Expand POSIX bracket expressions (character classes) in glob patterns. | [homepage](https://github.com/micromatch/expand-brackets "Expand POSIX bracket expressions (character classes) in glob patterns.")
 * [extglob](https://www.npmjs.com/package/extglob): Extended glob support for JavaScript. Adds (almost) the expressive power of regular expressions to glob… [more](https://github.com/micromatch/extglob) | [homepage](https://github.com/micromatch/extglob "Extended glob support for JavaScript. Adds (almost) the expressive power of regular expressions to glob patterns.")
 * [fill-range](https://www.npmjs.com/package/fill-range): Fill in a range of numbers or letters, optionally passing an increment or `step` to… [more](https://github.com/jonschlinkert/fill-range) | [homepage](https://github.com/jonschlinkert/fill-range "Fill in a range of numbers or letters, optionally passing an increment or `step` to use, or create a regex-compatible range with `options.toRegex`")
 * [nanomatch](https://www.npmjs.com/package/nanomatch): Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash… [more](https://github.com/micromatch/nanomatch) | [homepage](https://github.com/micromatch/nanomatch "Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash 4.3 wildcard support only (no support for exglobs, posix brackets or braces)")
 
 ### Contributors
 
-| **Commits** | **Contributor** | 
-| --- | --- |
-| 457 | [jonschlinkert](https://github.com/jonschlinkert) |
-| 12 | [es128](https://github.com/es128) |
-| 8 | [doowb](https://github.com/doowb) |
-| 3 | [paulmillr](https://github.com/paulmillr) |
-| 2 | [TrySound](https://github.com/TrySound) |
-| 2 | [MartinKolarik](https://github.com/MartinKolarik) |
-| 2 | [charlike-old](https://github.com/charlike-old) |
-| 1 | [amilajack](https://github.com/amilajack) |
-| 1 | [mrmlnc](https://github.com/mrmlnc) |
-| 1 | [devongovett](https://github.com/devongovett) |
-| 1 | [DianeLooney](https://github.com/DianeLooney) |
-| 1 | [UltCombo](https://github.com/UltCombo) |
-| 1 | [tomByrer](https://github.com/tomByrer) |
-| 1 | [fidian](https://github.com/fidian) |
+| **Commits** | **Contributor** |  
+| --- | --- |  
+| 475 | [jonschlinkert](https://github.com/jonschlinkert) |  
+| 12  | [es128](https://github.com/es128) |  
+| 8   | [doowb](https://github.com/doowb) |  
+| 3   | [paulmillr](https://github.com/paulmillr) |  
+| 2   | [TrySound](https://github.com/TrySound) |  
+| 2   | [MartinKolarik](https://github.com/MartinKolarik) |  
+| 2   | [Tvrqvoise](https://github.com/Tvrqvoise) |  
+| 2   | [tunnckoCore](https://github.com/tunnckoCore) |  
+| 1   | [amilajack](https://github.com/amilajack) |  
+| 1   | [mrmlnc](https://github.com/mrmlnc) |  
+| 1   | [devongovett](https://github.com/devongovett) |  
+| 1   | [DianeLooney](https://github.com/DianeLooney) |  
+| 1   | [UltCombo](https://github.com/UltCombo) |  
+| 1   | [tomByrer](https://github.com/tomByrer) |  
+| 1   | [fidian](https://github.com/fidian) |  
+| 1   | [simlu](https://github.com/simlu) |  
+| 1   | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) |  
 
 ### Author
 
 **Jon Schlinkert**
 
-* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)
-* [github/jonschlinkert](https://github.com/jonschlinkert)
-* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
+* [GitHub Profile](https://github.com/jonschlinkert)
+* [Twitter Profile](https://twitter.com/jonschlinkert)
+* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
 
 ### License
 
-Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
+Copyright © 2019, [Jon Schlinkert](https://github.com/jonschlinkert).
 Released under the [MIT License](LICENSE).
 
 ***
 
-_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on February 18, 2018._
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on April 10, 2019._