Merge pull request #134 from Tvrqvoise/v3-changelog

Add CHANGELOG for version 3, fixes #133

CHANGELOG.md

@@ -13,7 +13,52 @@ Changelog entries are classified using the following labels _(from [keep-a-chang
 
 ### [3.0.0] - 2017-04-11
 
-TODO. There should be no breaking changes. Please report any regressions. I will [reformat these release notes](https://github.com/micromatch/micromatch/pull/76) and add them to the changelog as soon as I have a chance. 
+Complete overhaul, with 36,000+ new unit tests validated against actual output generated by Bash and minimatch. More specifically, 35,000+ of the tests:
+
+ - micromatch results are directly compared to bash results
+ - in rare cases, when micromatch and bash disagree, micromatch's results are compared to minimatch's results
+ - micromatch is much more accurate than minimatch, so there were cases where I had to make assumptions. I'll try to document these.
+
+This refactor introduces a parser and compiler that are supersets of more granular parsers and compilers from other sub-modules. Each of these sub-modules has a singular responsibility and focuses on a certain type of matching that aligns with a specific part of the Bash "expansion" API.
+
+These sub-modules work like plugins to seamlessly create the micromatch parser/compiler, so that strings are parsed in one pass, an [AST is created](https://gist.github.com/jonschlinkert/099c8914f56529f75bc757cc9e5e8e2a), then a new string is generated by the compiler.
+
+Here are those sub-modules with links to related prs on those modules if you want to see how they contribute to this code:
+
+[nanomatch](https://github.com/jonschlinkert/nanomatch) (new library) - glob expansion (`*`, `**`, `?` and `[...]`))
+[braces](https://github.com/jonschlinkert/braces/pull/10) - brace expansion (`{1..10}`, `{a,b,c}`, etc)
+[extglob](https://github.com/jonschlinkert/extglob/pull/5) - extended globs (`!(a|b)`, `@(!(foo|bar))`, etc)
+[expand-brackets](https://github.com/jonschlinkert/expand-brackets/pull/5) - POSIX character classes `[[:alpha:][:digit:]]`
+
+**Added**
+
+ - source map support (optionally created when using parse or compile - I have no idea what the use case is yet, but they come for free) (note that source maps are not generated for brace expansion at present, since the braces compiler uses a different strategy. I'll update if/when this changes). Example:
+   ```js
+   var mm = require('micromatch');
+   var pattern = '*(*(of*(a)x)z)';
+
+   var ast = mm.parse(pattern, {sourcemap: true});
+   var res = mm.compile(ast);
+   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)' ] }},
+   ```
+ - parser is exposed, so that implementors can customize or override specific micromatch parsers if necessary
+ - compiler is exposed, so that implementors can customize or override specific micromatch compilers if necessary
+
+**Fixed**
+
+ - more accurate matching (passes 100% of Bash 4.3 of the brace expansion and extglob unit tests, as well as all Bash glob tests that are relevant to node.js usage, all minimatch tests, all brace-expansion tests, and also passes a couple of tests that bash fails)
+ - even safer - micromatch has always generated optimized patterns so it's not subject to DoS exploits like minimatch (completely different than the regex DoS issue, minimatch and multimatch are still openly exposed to being used for DoS attacks), but more safeguards were built into this refactor
+
+**Changed**
+ - the public API of this library did not change in this version and should be safe to upgrade without changing implentor code. However, we have released this as a major version for the following reasons:
+   - out of an abundance of caution due to the large amount of code changed in this release
+   - we have improved parser accuracy to such a degree that some implementors using invalid globs have noted change in behavior. If this is the case for you, please check that you are using a valid glob expression before logging a bug with this library
 
 ### [1.0.1] - 2016-12-12
 
@@ -34,4 +79,3 @@ First release.
 [0.2.0]: https://github.com/jonschlinkert/micromatch/compare/0.1.0...0.2.0
 
 [keep-a-changelog]: https://github.com/olivierlacan/keep-a-changelog
-

package.json

@@ -17,7 +17,8 @@
     "Paul Miller (paulmillr.com)",
     "Tom Byrer (https://github.com/tomByrer)",
     "Tyler Akins (http://rumkin.com)",
-    "(https://github.com/DianeLooney)"
+    "(https://github.com/DianeLooney)",
+    "Tvrqvoise (https://github.com/tvrqvoise)"
   ],
   "repository": "micromatch/micromatch",
   "bugs": {