micromatch 2.3.7 → 2.3.11

package/README.md

@@ -1,101 +1,135 @@
-# micromatch [![NPM version](https://badge.fury.io/js/micromatch.svg)](http://badge.fury.io/js/micromatch)  [![Build Status](https://travis-ci.org/jonschlinkert/micromatch.svg)](https://travis-ci.org/jonschlinkert/micromatch)
+# micromatch [![NPM version](https://img.shields.io/npm/v/micromatch.svg?style=flat)](https://www.npmjs.com/package/micromatch) [![NPM downloads](https://img.shields.io/npm/dm/micromatch.svg?style=flat)](https://npmjs.org/package/micromatch) [![Build Status](https://img.shields.io/travis/jonschlinkert/micromatch.svg?style=flat)](https://travis-ci.org/jonschlinkert/micromatch)
 
-> Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just use `micromatch.isMatch()` instead of `minimatch()`, or use `micromatch()` instead of `multimatch()`.
+> Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.
+
+Micromatch supports all of the same matching features as [minimatch](https://github.com/isaacs/minimatch) and [multimatch](https://github.com/sindresorhus/multimatch).
+
+* [mm()](#usage) is the same as [multimatch()](https://github.com/sindresorhus/multimatch)
+* [mm.match()](#match) is the same as [minimatch.match()](https://github.com/isaacs/minimatch)
+* use [mm.isMatch()](#ismatch) instead of [minimatch()](https://github.com/isaacs/minimatch)
 
 ## Install
 
-Install with [npm](https://www.npmjs.com/)
+Install with [npm](https://www.npmjs.com/):
 
 ```sh
-$ npm i micromatch --save
-```
-
-## Table of contents
-
-<!-- toc -->
-
-* [Features](#features)
-* [Usage](#usage)
-* [Switch from minimatch](#switch-from-minimatch)
-* [Methods](#methods)
-  - [.isMatch](#ismatch)
-  - [.contains](#contains)
-  - [.matcher](#matcher)
-  - [.filter](#filter)
-  - [.any](#any)
-  - [.expand](#expand)
-  - [.makeRe](#makere)
-* [Options](#options)
-  - [options.unixify](#optionsunixify)
-  - [options.dot](#optionsdot)
-  - [options.unescape](#optionsunescape)
-  - [options.nodupes](#optionsnodupes)
-  - [options.matchBase](#optionsmatchbase)
-  - [options.nobraces](#optionsnobraces)
-  - [options.nobrackets](#optionsnobrackets)
-  - [options.noextglob](#optionsnoextglob)
-  - [options.nocase](#optionsnocase)
-  - [options.nonull](#optionsnonull)
-  - [options.cache](#optionscache)
-* [Other features](#other-features)
-  - [Extended globbing](#extended-globbing)
-    + [extglobs](#extglobs)
-    + [brace expansion](#brace-expansion)
-    + [regex character classes](#regex-character-classes)
-    + [regex groups](#regex-groups)
-    + [POSIX bracket expressions](#posix-bracket-expressions)
-* [Notes](#notes)
-* [Benchmarks](#benchmarks)
-* [Run tests](#run-tests)
-* [Contributing](#contributing)
-* [Related](#related)
-* [Author](#author)
-* [License](#license)
-
-_(Table of contents generated by [verb](https://github.com/verbose/verb))_
-
-<!-- tocstop -->
-
-## Features
-
-Micromatch is [10-55x faster](#benchmarks) than [minimatch](https://github.com/isaacs/minimatch), resulting from a combination of caching, tokenization, parsing, runtime compilation and regex optimization strategies.
+$ npm install --save micromatch
+```
 
-* [Drop-in replacement](#switch-from-minimatch) for [minimatch](https://github.com/isaacs/minimatch) and [multimatch](https://github.com/sindresorhus/multimatch)
-* Built-in support for multiple glob patterns, like `['foo/*.js', '!bar.js']`
-* Better support for the Bash 4.3 specification, and less buggy
-* Extensive [unit tests](./test) (approx. 1,300 tests). Minimatch fails many of the tests.
+## Start matching!
 
-**Mainstream glob features:**
+```js
+var mm = require('micromatch');
+console.log(mm(['']))
+```
+
+***
+
+### Features
 
+* [Drop-in replacement](#switch-from-minimatch) for [minimatch](https://github.com/isaacs/minimatch) and [multimatch](https://github.com/sindresorhus/multimatch)
+* Built-in support for multiple glob patterns, like `['foo/*.js', '!bar.js']`
 * [Brace Expansion](https://github.com/jonschlinkert/braces) (`foo/bar-{1..5}.md`, `one/{two,three}/four.md`)
 * Typical glob patterns, like `**/*`, `a/b/*.js`, or `['foo/*.js', '!bar.js']`
+* Methods like `.isMatch()`, `.contains()` and `.any()`
 
 **Extended globbing features:**
 
 * Logical `OR` (`foo/bar/(abc|xyz).js`)
 * Regex character classes (`foo/bar/baz-[1-5].js`)
 * POSIX [bracket expressions](https://github.com/jonschlinkert/expand-brackets) (`**/[[:alpha:][:digit:]]/`)
-* [extglobs](https://github.com/jonschlinkert/extglob) (`**/+(x|y)`, `!(a|b)`, etc)
+* [extglobs](https://github.com/jonschlinkert/extglob) (`**/+(x|y)`, `!(a|b)`, etc).
 
 You can combine these to create whatever matching patterns you need.
 
+**Example**
+
+```js
+// double-negation!
+mm(['fa', 'fb', 'f', 'fo'], '!(f!(o))');
+//=> ['fo']
+```
+
+## Why switch to micromatch?
+
+* Native support for multiple glob patterns, no need for wrappers like [multimatch](https://github.com/sindresorhus/multimatch)
+* [10-55x faster](#benchmarks) and more performant than [minimatch](https://github.com/isaacs/minimatch) and [multimatch](https://github.com/sindresorhus/multimatch). This is achieved through a combination of caching and regex optimization strategies, a fundamentally different approach than minimatch.
+* More extensive support for the Bash 4.3 specification
+* More complete extglob support
+* Extensive [unit tests](./test) (approx. 1,300 tests). Minimatch fails many of the tests.
+
+### Switch from minimatch
+
+Use `mm.isMatch()` instead of `minimatch()`:
+
+```js
+mm.isMatch('foo', 'b*');
+//=> false
+```
+
+Use `mm.match()` instead of `minimatch.match()`:
+
+```js
+mm.match(['foo', 'bar'], 'b*');
+//=> 'bar'
+```
+
+### Switch from multimatch
+
+Same signature:
+
+```js
+mm(['foo', 'bar', 'baz'], ['f*', '*z']);
+//=> ['foo', 'baz']
+```
+
+***
+
 ## Usage
 
+Add micromatch to your node.js project:
+
 ```js
 var mm = require('micromatch');
-mm(array, patterns);
 ```
 
-**Examples**
+**Signature**
+
+```js
+mm(array_of_strings, glob_patterns[, options]);
+```
+
+**Example**
+
+```js
+mm(['foo', 'bar', 'baz'], 'b*');
+//=> ['bar', 'baz']
+```
+
+### Usage examples
+
+**Brace expansion**
+
+Match files with `.js` or `.txt` extensions.
 
 ```js
 mm(['a.js', 'b.md', 'c.txt'], '*.{js,txt}');
 //=> ['a.js', 'c.txt']
 ```
 
+**Extglobs**
+
+Match anything except for files with the `.md` extension.
+
+```js
+mm(files, '**/*.!(md)');
+
+//=> ['a.js', 'c.txt']
+```
+
 **Multiple patterns**
 
-Multiple patterns can also be passed:
+Match using an array of patterns.
 
 ```js
 mm(['a.md', 'b.js', 'c.txt', 'd.json'], ['*.md', '*.txt']);
@@ -104,10 +138,10 @@ mm(['a.md', 'b.js', 'c.txt', 'd.json'], ['*.md', '*.txt']);
 
 **Negation patterns:**
 
-Behavior;
+Behavior is designed to be what users would expect, based on conventions that are already well-established.
 
-* when the pattern is a string, [minimatch](https://github.com/isaacs/minimatch) behavior is used, so patterns are **inclusive by default**.
-* when an array of patterns is passed, [multimatch](https://github.com/sindresorhus/multimatch) behavior is used, so patterns are **exclusive by default**
+* [minimatch](https://github.com/isaacs/minimatch) behavior is used when the pattern is a string, so patterns are **inclusive by default**.
+* [multimatch](https://github.com/sindresorhus/multimatch) behavior is used when an array of patterns is passed, so patterns are **exclusive by default**.
 
 ```js
 mm(['a.js', 'b.md', 'c.txt'], '!*.{js,txt}');
@@ -117,42 +151,36 @@ mm(['a.md', 'b.js', 'c.txt', 'd.json'], ['*.*', '!*.{js,txt}']);
 //=> ['a.md', 'd.json']
 ```
 
-## Switch from minimatch
-
-> Use `micromatch.isMatch()` instead of `minimatch()`
-
-**Minimatch**
+***
 
-The main `minimatch()` function returns true/false for a single file path and pattern:
+## API methods
 
 ```js
-var minimatch = require('minimatch');
-minimatch('foo.js', '*.js');
-//=> 'true'
+var mm = require('micromatch');
 ```
 
-**Micromatch**
-
-With micromatch, `.isMatch()` to get the same result:
+### .match
 
 ```js
-var mm = require('micromatch');
-mm.isMatch('foo.js', '*.js');
-//=> 'true'
+mm.match(array, globString);
 ```
 
-This implementation difference is necessary since the main `micromatch()` method supports matching on multiple globs, with behavior similar to [multimatch](https://github.com/sindresorhus/multimatch).
+Return an array of files that match the given glob pattern. Useful if you only need to use a single glob pattern.
 
-## Methods
+**Example**
 
 ```js
-var mm = require('micromatch');
+mm.match(['ab', 'a/b', 'bb', 'b/c'], '?b');
+//=> ['ab', 'bb']
+
+mm.match(['ab', 'a/b', 'bb', 'b/c'], '*/b');
+//=> ['a/b']
 ```
 
 ### .isMatch
 
 ```js
-mm.isMatch(filepath, globPattern);
+mm.isMatch(filepath, globString);
 ```
 
 Returns true if a file path matches the given glob pattern.
@@ -419,6 +447,14 @@ Type: `{Boolean}`
 
 Default: `false`
 
+### options.nonegate
+
+Disallow negation (`!`) patterns.
+
+Type: `{Boolean}`
+
+Default: `false`
+
 ### options.nonull
 
 If `true`, when no matches are found the actual (array-ified) glob pattern is returned instead of an empty array. Same behavior as [minimatch](https://github.com/isaacs/minimatch).
@@ -435,6 +471,8 @@ Type: `{Boolean}`
 
 Default: `true`
 
+***
+
 ## Other features
 
 Micromatch also supports the following.
@@ -445,13 +483,13 @@ Micromatch also supports the following.
 
 Extended globbing, as described by the bash man page:
 
-| **pattern** | **regex equivalent** | **description** |
+| **pattern** | **regex equivalent** | **description** | 
 | --- | --- | --- |
-| `?(pattern-list)` | `(...|...)?` |  Matches zero or one occurrence of the given patterns |
-| `*(pattern-list)` | `(...|...)*` |  Matches zero or more occurrences of the given patterns |
-| `+(pattern-list)` | `(...|...)+` |  Matches one or more occurrences of the given patterns |
-| `@(pattern-list)` | `(...|...)` <sup>*</sup> |  Matches one of the given patterns |
-| `!(pattern-list)` | N/A |  Matches anything except one of the given patterns |
+| `?(pattern-list)` | `(... | ...)?` | Matches zero or one occurrence of the given patterns |
+| `*(pattern-list)` | `(... | ...)*` | Matches zero or more occurrences of the given patterns |
+| `+(pattern-list)` | `(... | ...)+` | Matches one or more occurrences of the given patterns |
+| `@(pattern-list)` | `(... | ...)` <sup>*</sup> | Matches one of the given patterns |
+| `!(pattern-list)` | N/A | Matches anything except one of the given patterns |
 
 <sup><strong>*</strong></sup> `@` isn't a RegEx character.
 
@@ -504,6 +542,8 @@ mm.isMatch('a1', '[[:alpha:][:digit:]]');
 
 See [expand-brackets](https://github.com/jonschlinkert/expand-brackets) for more information about extended bracket expressions.
 
+***
+
 ## Notes
 
 Whenever possible parsing behavior for patterns is based on globbing specifications in Bash 4.3. Patterns that aren't described by Bash follow wildmatch spec (used by git).
@@ -516,7 +556,7 @@ Run the [benchmarks](./benchmark):
 node benchmark
 ```
 
-As of October 03, 2015:
+As of July 15, 2016:
 
 ```bash
 #1: basename-braces
@@ -572,45 +612,78 @@ As of October 03, 2015:
   minimatch x 53,765 ops/sec ±0.75% (95 runs sampled)
 ```
 
-## Run tests
+## Tests
+
+### Running tests
 
 Install dev dependencies:
 
 ```sh
-$ npm i -d && npm test
+$ npm install -d && npm test
+```
+
+### Coverage
+
+As of July 15, 2016:
+
+```sh
+Statements : 100% (441/441)
+Branches   : 100% (270/270)
+Functions  : 100% (54/54)
+Lines      : 100% (429/429)
 ```
 
 ## Contributing
 
-Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/micromatch/issues/new).
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
 
 Please be sure to run the benchmarks before/after any code changes to judge the impact before you do a PR. thanks!
 
 ## Related
 
-* [braces](https://www.npmjs.com/package/braces): Fastest brace expansion for node.js, with the most complete… [more](https://www.npmjs.com/package/braces) | [homepage](https://github.com/jonschlinkert/braces)
-* [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-range](https://www.npmjs.com/package/expand-range): Fast, bash-like range expansion. Expand a range of numbers… [more](https://www.npmjs.com/package/expand-range) | [homepage](https://github.com/jonschlinkert/expand-range)
-* [extglob](https://www.npmjs.com/package/extglob): Convert extended globs to regex-compatible strings. Add (almost) the… [more](https://www.npmjs.com/package/extglob) | [homepage](https://github.com/jonschlinkert/extglob)
-* [fill-range](https://www.npmjs.com/package/fill-range): Fill in a range of numbers or letters, optionally… [more](https://www.npmjs.com/package/fill-range) | [homepage](https://github.com/jonschlinkert/fill-range)
-* [gulp-micromatch](https://www.npmjs.com/package/gulp-micromatch): Filter vinyl files with glob patterns, string, regexp, array,… [more](https://www.npmjs.com/package/gulp-micromatch) | [homepage](https://github.com/tunnckocore/gulp-micromatch)
-* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a… [more](https://www.npmjs.com/package/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob)
-* [parse-glob](https://www.npmjs.com/package/parse-glob): Parse a glob pattern into an object of tokens. | [homepage](https://github.com/jonschlinkert/parse-glob)
+* [braces](https://www.npmjs.com/package/braces): Fastest brace expansion for node.js, with the most complete support for the Bash 4.3 braces… [more](https://github.com/jonschlinkert/braces) | [homepage](https://github.com/jonschlinkert/braces "Fastest brace expansion for node.js, with the most complete support for the Bash 4.3 braces specification.")
+* [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-range](https://www.npmjs.com/package/expand-range): Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. See… [more](https://github.com/jonschlinkert/expand-range) | [homepage](https://github.com/jonschlinkert/expand-range "Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. See the benchmarks. Used by micromatch.")
+* [extglob](https://www.npmjs.com/package/extglob): Convert extended globs to regex-compatible strings. Add (almost) the expressive power of regular expressions to… [more](https://github.com/jonschlinkert/extglob) | [homepage](https://github.com/jonschlinkert/extglob "Convert extended globs to regex-compatible strings. Add (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 multiplier 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 multiplier to use.")
+* [gulp-micromatch](https://www.npmjs.com/package/gulp-micromatch): Filter vinyl files with glob patterns, string, regexp, array, object or matcher function. micromatch stream. | [homepage](https://github.com/tunnckocore/gulp-micromatch#readme "Filter vinyl files with glob patterns, string, regexp, array, object or matcher function. micromatch stream.")
+* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob "Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet")
+* [parse-glob](https://www.npmjs.com/package/parse-glob): Parse a glob pattern into an object of tokens. | [homepage](https://github.com/jonschlinkert/parse-glob "Parse a glob pattern into an object of tokens.")
+
+## Contributing
+
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
+
+## Building docs
+
+_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
+
+To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
+
+```sh
+$ npm install -g verb verb-generate-readme && verb
+```
+
+## Running tests
+
+Install dev dependencies:
+
+```sh
+$ npm install -d && npm test
+```
 
 ## Author
 
 **Jon Schlinkert**
 
-+ [github/jonschlinkert](https://github.com/jonschlinkert)
-+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
+* [github/jonschlinkert](https://github.com/jonschlinkert)
+* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
 
 ## License
 
-Copyright © 2014-2015 [Jon Schlinkert](https://github.com/jonschlinkert)
-Released under the MIT license.
+Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
+Released under the [MIT license](https://github.com/jonschlinkert/micromatch/blob/master/LICENSE).
 
 ***
 
-_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on October 03, 2015._
-
-<!-- deps:mocha browserify -->
+_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on July 15, 2016._

package/index.js

@@ -47,14 +47,14 @@ function micromatch(files, patterns, opts) {
 }
 
 /**
- * Pass an array of files and a glob pattern as a string.
+ * Return an array of files that match the given glob pattern.
  *
- * This function is called by the main `micromatch` function
- * If you only need to pass a single pattern you might get
- * very minor speed improvements using this function.
+ * This function is called by the main `micromatch` function If you only
+ * need to pass a single pattern you might get very minor speed improvements
+ * using this function.
  *
  * @param  {Array} `files`
- * @param  {Array} `pattern`
+ * @param  {String} `pattern`
  * @param  {Object} `options`
  * @return {Array}
  */
@@ -131,7 +131,6 @@ function match(files, pattern, opts) {
  * ['a', 'b', 'c', 'd', 'e'].filter(fn);
  * //=> ['a', 'b', 'c']
  * ```
- *
  * @param  {String|Array} `patterns` Can be a glob or array of globs.
  * @param  {Options} `opts` Options to pass to the [matcher] method.
  * @return {Function} Filter function to be passed to `Array#filter()`.
@@ -177,7 +176,6 @@ function filter(patterns, opts) {
  * isMatch('*.md', {})('foo.md')
  * //=> true
  * ```
- *
  * @param  {String} `fp`
  * @param  {String} `pattern`
  * @param  {Object} `opts`
@@ -375,8 +373,13 @@ function wrapGlob(glob, opts) {
 }
 
 /**
- * Wrap `toRegex` to memoize the generated regex when
- * the string and options don't change
+ * Create and cache a regular expression for matching file paths.
+ * If the leading character in the `glob` is `!`, a negation
+ * regex is returned.
+ *
+ * @param  {String} `glob`
+ * @param  {Object} `options`
+ * @return {RegExp}
  */
 
 function makeRe(glob, opts) {

package/lib/expand.js

@@ -138,13 +138,6 @@ function expand(pattern, options) {
     glob.pattern = globstar(opts.dot);
 
   } else {
-    // '/*/*/*' => '(?:/*){3}'
-    glob._replace(/(\/\*)+/g, function(match) {
-      var len = match.length / 2;
-      if (len === 1) { return match; }
-      return '(?:\\/*){' + len + '}';
-    });
-
     glob.pattern = balance(glob.pattern, '[', ']');
     glob.escape(glob.pattern);
 

package/lib/utils.js

@@ -43,8 +43,13 @@ utils.filename = function filename(fp) {
  */
 
 utils.isPath = function isPath(pattern, opts) {
+  opts = opts || {};
   return function(fp) {
-    return pattern === utils.unixify(fp, opts);
+    var unixified = utils.unixify(fp, opts);
+    if(opts.nocase){
+      return pattern.toLowerCase() === unixified.toLowerCase();
+    }
+    return pattern === unixified;
   };
 };
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "micromatch",
-  "description": "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just use `micromatch.isMatch()` instead of `minimatch()`, or use `micromatch()` instead of `multimatch()`.",
-  "version": "2.3.7",
+  "description": "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.",
+  "version": "2.3.11",
   "homepage": "https://github.com/jonschlinkert/micromatch",
   "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
   "repository": "jonschlinkert/micromatch",
@@ -11,7 +11,7 @@
   "license": "MIT",
   "files": [
     "index.js",
-    "lib/"
+    "lib"
   ],
   "main": "index.js",
   "engines": {
@@ -40,13 +40,14 @@
     "chalk": "^1.1.1",
     "gulp": "^3.9.0",
     "gulp-eslint": "^1.1.1",
+    "gulp-format-md": "^0.1.8",
     "gulp-istanbul": "^0.10.1",
     "gulp-mocha": "^2.1.3",
     "minimatch": "^3.0.0",
     "minimist": "^1.2.0",
-    "mocha": "*",
+    "mocha": "^2",
     "multimatch": "^2.0.0",
-    "should": "*",
+    "should": "^8",
     "write": "^0.2.1"
   },
   "keywords": [
@@ -81,13 +82,13 @@
     "related": {
       "list": [
         "braces",
-        "extglob",
         "expand-brackets",
-        "fill-range",
         "expand-range",
+        "extglob",
+        "fill-range",
         "gulp-micromatch",
-        "parse-glob",
-        "is-glob"
+        "is-glob",
+        "parse-glob"
       ]
     },
     "reflinks": [
@@ -97,6 +98,17 @@
       "minimatch",
       "multimatch",
       "verb"
-    ]
+    ],
+    "toc": false,
+    "layout": false,
+    "tasks": [
+      "readme"
+    ],
+    "plugins": [
+      "gulp-format-md"
+    ],
+    "lint": {
+      "reflinks": true
+    }
   }
 }