| 1 | # Release history
|
|---|
| 2 |
|
|---|
| 3 | All notable changes to this project will be documented in this file.
|
|---|
| 4 |
|
|---|
| 5 | The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
|---|
| 6 | and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
|---|
| 7 |
|
|---|
| 8 | <details>
|
|---|
| 9 | <summary><strong>Guiding Principles</strong></summary>
|
|---|
| 10 |
|
|---|
| 11 | - Changelogs are for humans, not machines.
|
|---|
| 12 | - There should be an entry for every single version.
|
|---|
| 13 | - The same types of changes should be grouped.
|
|---|
| 14 | - Versions and sections should be linkable.
|
|---|
| 15 | - The latest version comes first.
|
|---|
| 16 | - The release date of each versions is displayed.
|
|---|
| 17 | - Mention whether you follow Semantic Versioning.
|
|---|
| 18 |
|
|---|
| 19 | </details>
|
|---|
| 20 |
|
|---|
| 21 | <details>
|
|---|
| 22 | <summary><strong>Types of changes</strong></summary>
|
|---|
| 23 |
|
|---|
| 24 | Changelog entries are classified using the following labels _(from [keep-a-changelog](http://keepachangelog.com/)_):
|
|---|
| 25 |
|
|---|
| 26 | - `Added` for new features.
|
|---|
| 27 | - `Changed` for changes in existing functionality.
|
|---|
| 28 | - `Deprecated` for soon-to-be removed features.
|
|---|
| 29 | - `Removed` for now removed features.
|
|---|
| 30 | - `Fixed` for any bug fixes.
|
|---|
| 31 | - `Security` in case of vulnerabilities.
|
|---|
| 32 |
|
|---|
| 33 | </details>
|
|---|
| 34 |
|
|---|
| 35 | ## [4.0.0] - 2019-03-20
|
|---|
| 36 |
|
|---|
| 37 | ### Added
|
|---|
| 38 |
|
|---|
| 39 | - Adds support for `options.onMatch`. See the readme for details
|
|---|
| 40 | - Adds support for `options.onIgnore`. See the readme for details
|
|---|
| 41 | - Adds support for `options.onResult`. See the readme for details
|
|---|
| 42 |
|
|---|
| 43 |
|
|---|
| 44 | ### Breaking changes
|
|---|
| 45 |
|
|---|
| 46 | - Require Node.js >= 8.6
|
|---|
| 47 | - Removed support for passing an array of brace patterns to `micromatch.braces()`.
|
|---|
| 48 | - To strictly enforce closing brackets (for `{`, `[`, and `(`), you must now use `strictBrackets=true` instead of `strictErrors`.
|
|---|
| 49 | - `cache` - caching and all related options and methods have been removed
|
|---|
| 50 | - `options.unixify` was renamed to `options.windows`
|
|---|
| 51 | - `options.nodupes` Was removed. Duplicates are always removed by default. You can override this with custom behavior by using the `onMatch`, `onResult` and `onIgnore` functions.
|
|---|
| 52 | - `options.snapdragon` was removed, as snapdragon is no longer used.
|
|---|
| 53 | - `options.sourcemap` was removed, as snapdragon is no longer used, which provided sourcemap support.
|
|---|
| 54 |
|
|---|
| 55 | ## [3.0.0] - 2017-04-11
|
|---|
| 56 |
|
|---|
| 57 | Complete overhaul, with 36,000+ new unit tests validated against actual output generated by Bash and minimatch. More specifically, 35,000+ of the tests:
|
|---|
| 58 |
|
|---|
| 59 | - micromatch results are directly compared to bash results
|
|---|
| 60 | - in rare cases, when micromatch and bash disagree, micromatch's results are compared to minimatch's results
|
|---|
| 61 | - micromatch is much more accurate than minimatch, so there were cases where I had to make assumptions. I'll try to document these.
|
|---|
| 62 |
|
|---|
| 63 | 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.
|
|---|
| 64 |
|
|---|
| 65 | 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.
|
|---|
| 66 |
|
|---|
| 67 | Here are those sub-modules with links to related prs on those modules if you want to see how they contribute to this code:
|
|---|
| 68 |
|
|---|
| 69 | [nanomatch](https://github.com/jonschlinkert/nanomatch) (new library) - glob expansion (`*`, `**`, `?` and `[...]`))
|
|---|
| 70 | [braces](https://github.com/jonschlinkert/braces/pull/10) - brace expansion (`{1..10}`, `{a,b,c}`, etc)
|
|---|
| 71 | [extglob](https://github.com/jonschlinkert/extglob/pull/5) - extended globs (`!(a|b)`, `@(!(foo|bar))`, etc)
|
|---|
| 72 | [expand-brackets](https://github.com/jonschlinkert/expand-brackets/pull/5) - POSIX character classes `[[:alpha:][:digit:]]`
|
|---|
| 73 |
|
|---|
| 74 | **Added**
|
|---|
| 75 |
|
|---|
| 76 | - 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).
|
|---|
| 77 | - parser is exposed, so that implementors can customize or override specific micromatch parsers if necessary
|
|---|
| 78 | - compiler is exposed, so that implementors can customize or override specific micromatch compilers if necessary
|
|---|
| 79 |
|
|---|
| 80 | **Fixed**
|
|---|
| 81 |
|
|---|
| 82 | - 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)
|
|---|
| 83 | - 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
|
|---|
| 84 |
|
|---|
| 85 | **Changed**
|
|---|
| 86 |
|
|---|
| 87 | - 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:
|
|---|
| 88 | - out of an abundance of caution due to the large amount of code changed in this release
|
|---|
| 89 | - 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
|
|---|
| 90 |
|
|---|
| 91 | ## [1.0.1] - 2016-12-12
|
|---|
| 92 |
|
|---|
| 93 | **Added**
|
|---|
| 94 |
|
|---|
| 95 | - Support for windows path edge cases where backslashes are used in brackets or other unusual combinations.
|
|---|
| 96 |
|
|---|
| 97 | ## [1.0.0] - 2016-12-12
|
|---|
| 98 |
|
|---|
| 99 | Stable release.
|
|---|
| 100 |
|
|---|
| 101 | ## [0.1.0] - 2016-10-08
|
|---|
| 102 |
|
|---|
| 103 | First release.
|
|---|
| 104 |
|
|---|
| 105 |
|
|---|
| 106 | [Unreleased]: https://github.com/jonschlinkert/micromatch/compare/0.1.0...HEAD
|
|---|
| 107 | [0.2.0]: https://github.com/jonschlinkert/micromatch/compare/0.1.0...0.2.0
|
|---|
| 108 |
|
|---|
| 109 | [keep-a-changelog]: https://github.com/olivierlacan/keep-a-changelog
|
|---|
