| 1 | # History
|
| 2 |
|
| 3 | ## v6.4.0 2020 June 25
|
| 4 |
|
| 5 | - Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
|
| 6 |
|
| 7 | ## v6.3.0 2020 June 21
|
| 8 |
|
| 9 | - Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
|
| 10 |
|
| 11 | ## v6.2.0 2020 June 10
|
| 12 |
|
| 13 | - Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
|
| 14 |
|
| 15 | ## v6.1.0 2020 May 22
|
| 16 |
|
| 17 | - Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
|
| 18 |
|
| 19 | ## v6.0.0 2020 May 21
|
| 20 |
|
| 21 | - Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
|
| 22 | - Minimum required node version changed from `node: >=8` to `node: >=10` to keep up with mandatory ecosystem changes
|
| 23 |
|
| 24 | ## v5.6.0 2019 December 10
|
| 25 |
|
| 26 | - Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
|
| 27 |
|
| 28 | ## v5.5.0 2019 December 1
|
| 29 |
|
| 30 | - Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
|
| 31 |
|
| 32 | ## v5.4.0 2019 December 1
|
| 33 |
|
| 34 | - Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
|
| 35 |
|
| 36 | ## v5.3.0 2019 November 18
|
| 37 |
|
| 38 | - Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
|
| 39 |
|
| 40 | ## v5.2.0 2019 November 18
|
| 41 |
|
| 42 | - Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
|
| 43 |
|
| 44 | ## v5.1.0 2019 November 13
|
| 45 |
|
| 46 | - Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
|
| 47 |
|
| 48 | ## v5.0.0 2019 November 10
|
| 49 |
|
| 50 | - Updated dependencies, [base files](https://github.com/bevry/base) and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
|
| 51 | - Development dependency `rimraf` now requires node version `6` at minimum
|
| 52 | - As such, the minimum supported node version of watchr has changed from `0.12` to the latest LTS at the time of this release which is `8`
|
| 53 |
|
| 54 | ## v4.1.0 2018 December 7
|
| 55 |
|
| 56 | - Updated dependencies, [base files](https://github.com/bevry/base) and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
|
| 57 |
|
| 58 | ## v4.0.1 2018 January 24
|
| 59 |
|
| 60 | - Updated minimum supported node version to 0.12, due [readdir-cluster](https://github.com/bevry/readdir-cluster)'s use of Promises
|
| 61 | - Fixes [ReferenceError: Promise is not defined](https://travis-ci.org/bevry/watchr/jobs/332806957)
|
| 62 |
|
| 63 | ## v4.0.0 2018 January 24
|
| 64 |
|
| 65 | - This is an API backwards compatible release, however the underlying changes may introduce some problems, so a rolling adoption is warranted
|
| 66 | - Directory contents are now scanned in parallel
|
| 67 | - Directory scanning is now done by [scandirectory v3](https://github.com/bevry/scandirectory) (instead of v2) which uses [readdir-cluster](https://github.com/bevry/readdir-cluster)
|
| 68 | - readdir-cluster should offer performance benefits, but [currently does not run in non-master processes](https://github.com/bevry/readdir-cluster/issues/5)
|
| 69 | - Updated dependencies
|
| 70 | - Updated base files
|
| 71 |
|
| 72 | ## v3.0.1 2016 October 23
|
| 73 |
|
| 74 | - Fixed `open` not returning the stalker instance - Thanks to [Davide Mancuso](https://github.com/atomictag) for [issue #88](https://github.com/bevry/watchr/issues/88)
|
| 75 | - Fixed documentation on `create` not indicating that it returns the stalker instance
|
| 76 | - Updated base files
|
| 77 |
|
| 78 | ## v3.0.0 2016 October 19
|
| 79 |
|
| 80 | - Rewrote for better stability, all issues should now be considered closed
|
| 81 | - Converted from CoffeeScript to JavaScript
|
| 82 | - Node v0.8 support added once again (before node v0.12 was the earliest supported version)
|
| 83 | - Added jsdoc
|
| 84 | - Added flow type annotations
|
| 85 |
|
| 86 | ## v2.6.0 2016 July 15
|
| 87 |
|
| 88 | - Potentially fixed swapfiles breaking watching - Thanks to [Josh Levine](https://github.com/jlevine22) for [pull request #76](https://github.com/bevry/watchr/pull/76)
|
| 89 |
|
| 90 | ## v2.5.0 2016 July 15
|
| 91 |
|
| 92 | - Updated dependencies
|
| 93 | - Updated engines to be node >=0.12 as to align with safefs v4 - May still work with node 0.10, file a bug report if it doesn't
|
| 94 |
|
| 95 | ## v2.4.13 2015 February 7
|
| 96 |
|
| 97 | - Updated dependencies
|
| 98 |
|
| 99 | ## v2.4.12 2014 December 17
|
| 100 |
|
| 101 | - Fixed `previousStat` not existing sporadically on delete events - Thanks to [Stuart Knightley](https://github.com/Stuk) for [pull request #61](https://github.com/bevry/watchr/pull/61)
|
| 102 | - Updated dependencies
|
| 103 |
|
| 104 | ## v2.4.11 2014 February 7
|
| 105 |
|
| 106 | - Fixed interval option not beeing passed on to child watchers (regression since v2.4.7) - Thanks to [David Byrd](https://github.com/thebyrd) for [pull request #58](https://github.com/bevry/watchr/pull/58)
|
| 107 |
|
| 108 | ## v2.4.10 2014 February 7
|
| 109 |
|
| 110 | - Fixed watchr emitting error events incorrectly (regression since v2.4.7) - Thanks to [Aaron O'Mullan](https://github.com/AaronO) for [pull request #59](https://github.com/bevry/watchr/pull/59)
|
| 111 |
|
| 112 | ## v2.4.9 2014 January 28
|
| 113 |
|
| 114 | - Fixed `"me" is undefined` errors (regression since v2.4.7)
|
| 115 |
|
| 116 | ## v2.4.8 2013 December 30
|
| 117 |
|
| 118 | - You can now pass falsey values for`catchupDelay` to disable it
|
| 119 |
|
| 120 | ## v2.4.7 2013 December 19
|
| 121 |
|
| 122 | - Fixed: [Text Editor swap files on saving can throw it off](https://github.com/bevry/watchr/issues/33)
|
| 123 | - Fixed: [`ENOENT` errors are emitted when dead links a broken symlink is encountered](https://github.com/bevry/watchr/issues/42)
|
| 124 | - Updated dependencies
|
| 125 |
|
| 126 | ## v2.4.6 2013 November 18
|
| 127 |
|
| 128 | - Updated dependencies
|
| 129 |
|
| 130 | ## v2.4.5 2013 November 17
|
| 131 |
|
| 132 | - Updated dependencies
|
| 133 |
|
| 134 | ## v2.4.4 2013 October 10
|
| 135 |
|
| 136 | - Added the ability to turn off following links by setting `followLinks` to `false` - Thanks to [Fredrik Noren](https://github.com/FredrikNoren) for [pull request #47](https://github.com/bevry/watchr/pull/47)
|
| 137 | - Prefer accuracy over speed - Use the watch method by default, but don't trust it at all, always double check everything
|
| 138 |
|
| 139 | ## v2.4.3 2013 April 10
|
| 140 |
|
| 141 | - More work on swap file handling
|
| 142 |
|
| 143 | ## v2.4.2 2013 April 10
|
| 144 |
|
| 145 | - File copies will now trigger events throughout the copy rather than just at the start of the copy - Close [issue #35](https://github.com/bevry/watchr/issues/35)
|
| 146 |
|
| 147 | ## v2.4.1 2013 April 10
|
| 148 |
|
| 149 | - Fixed bubblr events
|
| 150 | - Fixed swap file detection
|
| 151 |
|
| 152 | ## v2.4.0 2013 April 5
|
| 153 |
|
| 154 | - Updated dependencies
|
| 155 |
|
| 156 | ## v2.3.10 2013 April 1
|
| 157 |
|
| 158 | - Updated dependencies
|
| 159 |
|
| 160 | ## v2.3.9 2013 March 17
|
| 161 |
|
| 162 | - Made it so if `duplicateDelay` is falsey we will not do a duplicate check
|
| 163 |
|
| 164 | ## v2.3.8 2013 March 17
|
| 165 |
|
| 166 | - Fix `Object #<Object> has no method 'emit'` error - Thanks to [Casey Foster](https://github.com/caseywebdev) for [pull request #32](https://github.com/bevry/watchr/pull/32)
|
| 167 |
|
| 168 | ## v2.3.7 2013 February 6
|
| 169 |
|
| 170 | - Changed the `preferredMethod` option into `preferredMethods` which accepts an array, defaults to `['watch','watchFile']`
|
| 171 | - If the watch action fails at the eve level we will try again with the preferredMethods reversed - This solves [issue #31](https://github.com/bevry/watchr/issues/31) where watching of large files would fail
|
| 172 | - Changed the `interval` option to default to `5007` (recommended by node) instead of `100` as it was before - The `watch` method provides us with immediate notification of changes without utilising polling, however the `watch` method fails for large amounts of files, in which case we will fall back to the `watchFile` method that will use this option, if the option is too small we will be constantly polling the large amount of files for changes using up all the CPU and memory, hence the change into a larger increment which has no CPU and memory impact.
|
| 173 |
|
| 174 | ## v2.3.6 2013 February 6
|
| 175 |
|
| 176 | - Fixed fallback when preferredMethod is `watchFile`
|
| 177 |
|
| 178 | ## v2.3.5 2013 February 6
|
| 179 |
|
| 180 | - Fixed uncaught exceptions when intialising watchers under certain circumstances
|
| 181 |
|
| 182 | ## v2.3.4 2013 February 5
|
| 183 |
|
| 184 | - Better handling and detection of failed watching operations
|
| 185 | - Better handling of duplicated events
|
| 186 | - Watching is now an atomic operation - If watching fails for a descendant, we will close everything related to that watch operation of the eve
|
| 187 | - We now prefer the `watch` method over the `watchFile` method - This offers great reliability and way less CPU and memory foot print - If you still wish to prefer `watchFile`, then set the new configuration option `preferredMethod` to `watchFile`
|
| 188 | - Closes [issue #30](https://github.com/bevry/watchr/issues/30) thanks to [Howard Tyson](https://github.com/tizzo)
|
| 189 |
|
| 190 | ## v2.3.3 2013 January 8
|
| 191 |
|
| 192 | - Added `outputLog` option
|
| 193 | - Added `ignorePaths` option - Thanks to [Tane Piper](https://github.com/tanepiper) for [issue #24](https://github.com/bevry/watchr/issues/24)
|
| 194 | - Now properly ignores hidden files - Thanks to [Ting-yu (Joseph) Chiang](https://github.com/josephj) for [issue #25](https://github.com/bevry/watchr/issues/25) and [Julien M.](https://github.com/julienma) for [issue #28](https://github.com/bevry/watchr/issues/28)
|
| 195 | - Added `Watcher::isIgnoredPath` method
|
| 196 | - Added tests for ignored and hidden files
|
| 197 |
|
| 198 | ## v2.3.2 2013 January 6
|
| 199 |
|
| 200 | - Fixed closing when a child path watcher doesn't exist - Closes [pull request #26](https://github.com/bevry/watchr/pull/26) thanks to [Jason Als](https://github.com/jasonals)
|
| 201 | - Added close tests
|
| 202 |
|
| 203 | ## v2.3.1 2012 December 19
|
| 204 |
|
| 205 | - Fixed a bug with closing directories that have children - Thanks to [Casey Foster](https://github.com/caseywebdev) for [issue #23](https://github.com/bevry/watchr/issues/23)
|
| 206 |
|
| 207 | ## v2.3.0 2012 December 17
|
| 208 |
|
| 209 | - This is a backwards compatiblity break, however updating is easy, read the notes below.
|
| 210 | - We've updated the events we emit to be: - `log` for debugging, receives the arguments `logLevel ,args...` - `watching` for when watching of the path has completed, receives the arguments `err, isWatching` - `change` for listening to change events, receives the arguments `changeType, fullPath, currentStat, previousStat` - `error` for gracefully listening to error events, receives the arguments `err` - read the README to learn how to bind to these new events
|
| 211 | - The `changeType` argument for change listeners has been changed for better clarity and consitency: - `change` is now `update` - `new` is now `create` - `unlink` is now `delete`
|
| 212 | - We've updated the return arguments for `require('watchr').watch` for better consitency: - if you send the `paths` option, you will receive the arguments `err, results` where `results` is an array of watcher instances - if you send the `path` option, you receive the arguments `err, watcherInstance`
|
| 213 |
|
| 214 | ## v2.2.1 2012 December 16
|
| 215 |
|
| 216 | - Fixed sub directory scans ignoring our ignore patterns
|
| 217 | - Updated dependencies
|
| 218 |
|
| 219 | ## v2.2.0 2012 December 15
|
| 220 |
|
| 221 | - We now ignore common ignore patterns by default
|
| 222 | - `ignorePatterns` configuration option renamed to `ignoreCommonPatterns`
|
| 223 | - Added new `ignoreCustomPatterns` configuration option
|
| 224 | - Updated dependencies - [bal-util](https://github.com/balupton/bal-util) from 1.13.x to 1.15.x
|
| 225 | - Closes [issue #22](https://github.com/bevry/watchr/issues/22) and [issue #21](https://github.com/bevry/watchr/issues/21) - Thanks [Andrew Petersen](https://github.com/kirbysayshi), [Sascha Depold](https://github.com/sdepold), [Raynos](https://github.com/Raynos), and [Prajwalit](https://github.com/prajwalit) for your help!
|
| 226 |
|
| 227 | ## v2.1.6 2012 November 6
|
| 228 |
|
| 229 | - Added missing `bin` configuration - Fixes [#16](https://github.com/bevry/watchr/issues/16) thanks to [pull request #17](https://github.com/bevry/watchr/pull/17) by [Robson Roberto Souza Peixoto](https://github.com/robsonpeixoto)
|
| 230 |
|
| 231 | ## v2.1.5 2012 September 29
|
| 232 |
|
| 233 | - Fixed completion callback not firing when trying to watch a path that doesn't exist
|
| 234 |
|
| 235 | ## v2.1.4 2012 September 27
|
| 236 |
|
| 237 | - Fixed new listeners not being added for directories that have already been watched
|
| 238 | - Fixed completion callbacks happening too soon
|
| 239 | - Thanks to [pull request #14](https://github.com/bevry/watchr/pull/14) by [Casey Foster](https://github.com/caseywebdev)
|
| 240 |
|
| 241 | ## v2.1.3 2012 August 10
|
| 242 |
|
| 243 | - Re-added markdown files to npm distribution as they are required for the npm website
|
| 244 |
|
| 245 | ## v2.1.2 2012 July 7
|
| 246 |
|
| 247 | - Fixed spelling of `persistent`
|
| 248 | - Explicitly set the defaults for the options `ignoreHiddenFiles` and `ignorePatterns`
|
| 249 |
|
| 250 | ## v2.1.1 2012 July 7
|
| 251 |
|
| 252 | - Added support for `interval` and `persistant` options
|
| 253 | - Improved unlink detection
|
| 254 | - Optimised unlink handling
|
| 255 |
|
| 256 | ## v2.1.0 2012 June 22
|
| 257 |
|
| 258 | - `watchr.watchr` changes - now only accepts one argument which is an object - added new `paths` property which is an array of multiple paths to watch - will only watch paths that actually exist (before it use to throw an error)
|
| 259 | - Fixed a few bugs
|
| 260 | - Added support for node v0.7/v0.8
|
| 261 | - Moved tests from Mocha to [Joe](https://github.com/bevry/joe)
|
| 262 |
|
| 263 | ## v2.0.3 2012 April 19
|
| 264 |
|
| 265 | - Fixed a bug with closing watchers
|
| 266 | - Now requires pre-compiled code
|
| 267 |
|
| 268 | ## v2.0.0 2012 April 19
|
| 269 |
|
| 270 | - Big rewrite
|
| 271 | - Got rid of the delay
|
| 272 | - Now always fires events
|
| 273 | - Watcher instsances inherit from Node's EventEmitter
|
| 274 | - Events for `change`, `unlink` and `new`
|
| 275 |
|
| 276 | ## v1.0.0 2012 February 11
|
| 277 |
|
| 278 | - Better support for ignoring hidden files
|
| 279 | - Improved documentation, readme
|
| 280 | - Added `History.md` file
|
| 281 | - Added unit tests using [Mocha](http://visionmedia.github.com/mocha/)
|
| 282 |
|
| 283 | ## v0.1.0 2012 November 13
|
| 284 |
|
| 285 | - Initial working version
|