.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Versions (please complete the following information):**
+ - Chokidar version [e.g. 2.0.4, or commit hash]
+ - Node version [e.g. 10.4.1]
+ - OS version: [e.g. Ubuntu 16.04, or Windows 10]
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+Ideally prove a problem by isolating and making it reproducible with a very short sample program, which you could paste here:
+
+```
+var chokidar = require('chokidar');
+var fs = require('fs');
+// One-liner for files and directories starting with 'test'
+chokidar.watch('test*', {}).on('all', (event, path) => {
+  console.log(event, path);
+});
+fs.writeFileSync('test.txt', 'testing 1');
+// In a comment describe expected output versus observed problem
+```
+
+Most valuable could be one or more test cases for [test.js](https://github.com/paulmillr/chokidar/blob/master/test.js) to demonstrate the problem.
+
+**Expected behavior**
+A clear and concise description of what you expect to happen.
+
+**Additional context**
+Add any other context about the problem here.
+Optionally nice to know what project you are working on.

CHANGELOG.md → .github/full_changelog.md

@@ -1,3 +1,47 @@
+# Chokidar 3.0.0 (Apr 30, 2019)
+* Massive CPU & RAM consumption improvements. 17x package & deps size reduction
+* Node 8+-only
+
+# Chokidar 2.1.4 (Mar 22, 2019)
+* Improve TypeScript type definitions for `on` method.
+
+# Chokidar 2.1.3 (Mar 22, 2019)
+* Improve atomic writes handling
+
+# Chokidar 2.1.2 (Feb 18, 2019)
+* Add TypeScript type definitions
+* More fixes for accessTime behavior (#800)
+
+# Chokidar 2.1.1 (Feb 8, 2019)
+* Handle simultaneous change of LastAccessTime and ModifiedTime (#793)
+
+# Chokidar 2.1.0 (Feb 5, 2019)
+* Ignore accessTime updates caused by read operations (#762).
+* Updated dependencies. Removed `lodash.debounce`.
+
+# Chokidar 2.0.4 (Jun 18, 2018)
+* Prevent watcher.close() from crashing (#730).
+
+# Chokidar 2.0.3 (Mar 22, 2018)
+* Fixes an issue that using fd = 0 is not closed in case
+Windows is used and a `EPERM` error is triggered.
+
+# Chokidar 2.0.2 (Feb 14, 2018)
+* Allow semver range updates for upath dependency
+
+# Chokidar 2.0.1 (Feb 8, 2018)
+  * Fix #668 glob issue on Windows when using `ignore` and `cwd`. Thanks @remy!
+  * Fix #546 possible uncaught exception when using `awaitWriteFinish`.
+    Thanks @dsagal!
+
+# Chokidar 2.0.0 (Dec 29, 2017)
+* Breaking: Upgrade globbing dependencies which require globs to be more strict and always use POSIX-style slashes because Windows-style slashes are used as escape sequences
+* Update tests to work with upgraded globbing dependencies
+* Add ability to log FSEvents require error by setting `CHOKIDAR_PRINT_FSEVENTS_REQUIRE_ERROR` env
+* Fix for handling braces in globs
+* Add node 8 & 9 to CI configs
+* Allow node 0.10 failures on Windows
+
 # Chokidar 1.7.0 (May 8, 2017)
 * Add `disableGlobbing` option
 * Add ability to force interval value by setting CHOKIDAR_INTERVAL env

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 test-fixtures
-coverage
 *.bak
 *.log
+.nyc_output
+package-lock.json

.travis.yml

@@ -1,13 +1,12 @@
 language: node_js
 node_js:
-  - '7'
-  - '6'
-  - '5'
-  - '4'
-  - '0.10'
+  - "12"
+  - "10"
+  - "8"
 os:
-  - linux
   - osx
-script:
-  - npm run ci-test
-sudo: false
+  - linux
+  - windows
+after_script:
+  - npm run coveralls
+  # - npm run dtslint

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2012-2019 Paul Miller (https://paulmillr.com), Elan Shanker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,18 +1,16 @@
-# Chokidar [![Mac/Linux Build Status](https://img.shields.io/travis/paulmillr/chokidar/master.svg?label=Mac%20OSX%20%26%20Linux)](https://travis-ci.org/paulmillr/chokidar) [![Windows Build status](https://img.shields.io/appveyor/ci/es128/chokidar/master.svg?label=Windows)](https://ci.appveyor.com/project/es128/chokidar/branch/master) [![Coverage Status](https://coveralls.io/repos/paulmillr/chokidar/badge.svg)](https://coveralls.io/r/paulmillr/chokidar) [![Join the chat at https://gitter.im/paulmillr/chokidar](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/paulmillr/chokidar?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+# Chokidar [![Weekly downloads](https://img.shields.io/npm/dw/chokidar.svg)](https://github.com/paulmillr/chokidar) [![Yearly downloads](https://img.shields.io/npm/dy/chokidar.svg)](https://github.com/paulmillr/chokidar)
 
-> A neat wrapper around node.js fs.watch / fs.watchFile / fsevents.
+> A neat wrapper around node.js fs.watch / fs.watchFile / FSEvents.
 
-[![NPM](https://nodei.co/npm-dl/chokidar.png)](https://nodei.co/npm/chokidar/)
-[![NPM](https://nodei.co/npm/chokidar.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/chokidar/)
+[![NPM](https://nodei.co/npm/chokidar.png)](https://www.npmjs.com/package/chokidar)
 
 ## Why?
 Node.js `fs.watch`:
 
-* Doesn't report filenames on OS X.
-* Doesn't report events at all when using editors like Sublime on OS X.
+* Doesn't report filenames on MacOS.
+* Doesn't report events at all when using editors like Sublime on MacOS.
 * Often reports events twice.
 * Emits most changes as `rename`.
-* Has [a lot of other issues](https://github.com/joyent/node/search?q=fs.watch&type=Issues)
 * Does not provide an easy way to recursively watch file trees.
 
 Node.js `fs.watchFile`:
@@ -23,14 +21,14 @@ Node.js `fs.watchFile`:
 
 Chokidar resolves these problems.
 
-Initially made for [brunch](http://brunch.io) (an ultra-swift web app build tool), it is now used in
+Initially made for **[Brunch](http://brunch.io)** (an ultra-swift web app build tool), it is now used in
+[Microsoft's Visual Studio Code](https://github.com/microsoft/vscode),
 [gulp](https://github.com/gulpjs/gulp/),
 [karma](http://karma-runner.github.io),
 [PM2](https://github.com/Unitech/PM2),
 [browserify](http://browserify.org/),
 [webpack](http://webpack.github.io/),
 [BrowserSync](http://www.browsersync.io/),
-[Microsoft's Visual Studio Code](https://github.com/microsoft/vscode),
 and [many others](https://www.npmjs.org/browse/depended/chokidar/).
 It has proven itself in production environments.
 
@@ -39,7 +37,7 @@ Chokidar does still rely on the Node.js core `fs` module, but when using
 `fs.watch` and `fs.watchFile` for watching, it normalizes the events it
 receives, often checking for truth by getting file stats and/or dir contents.
 
-On Mac OS X, chokidar by default uses a native extension exposing the Darwin
+On MacOS, chokidar by default uses a native extension exposing the Darwin
 `FSEvents` API. This provides very efficient recursive watching compared with
 implementations like `kqueue` available on most \*nix platforms. Chokidar still
 does have to do some work to normalize the events received that way as well.
@@ -53,30 +51,34 @@ more than needed.
 ## Getting started
 Install with npm:
 
-    npm install chokidar --save
+```sh
+npm install chokidar
+```
 
 Then `require` and use it in your code:
 
 ```javascript
-var chokidar = require('chokidar');
+const chokidar = require('chokidar');
 
 // One-liner for current directory, ignores .dotfiles
 chokidar.watch('.', {ignored: /(^|[\/\\])\../}).on('all', (event, path) => {
   console.log(event, path);
 });
 ```
 
+## API
+
 ```javascript
 // Example of a more typical implementation structure:
 
 // Initialize watcher.
-var watcher = chokidar.watch('file, dir, glob, or array', {
+const watcher = chokidar.watch('file, dir, glob, or array', {
   ignored: /(^|[\/\\])\../,
   persistent: true
 });
 
 // Something to use when events are received.
-var log = console.log.bind(console);
+const log = console.log.bind(console);
 // Add event listeners.
 watcher
   .on('add', path => log(`File ${path} has been added`))
@@ -138,8 +140,6 @@ chokidar.watch('file', {
 
 ```
 
-## API
-
 `chokidar.watch(paths, [options])`
 
 * `paths` (string or array of strings). Paths to files, dirs to be watched
@@ -179,19 +179,19 @@ Whether to use fs.watchFile (backed by polling), or fs.watch. If polling
 leads to high CPU utilization, consider setting this to `false`. It is
 typically necessary to **set this to `true` to successfully watch files over
 a network**, and it may be necessary to successfully watch files in other
-non-standard situations. Setting to `true` explicitly on OS X overrides the
+non-standard situations. Setting to `true` explicitly on MacOS overrides the
 `useFsEvents` default. You may also set the CHOKIDAR_USEPOLLING env variable
 to true (1) or false (0) in order to override this option.
 * _Polling-specific settings_ (effective when `usePolling: true`)
-  * `interval` (default: `100`). Interval of file system polling. You may also 
+  * `interval` (default: `100`). Interval of file system polling. You may also
     set the CHOKIDAR_INTERVAL env variable to override this option.
   * `binaryInterval` (default: `300`). Interval of file system
   polling for binary files.
   ([see list of binary extensions](https://github.com/sindresorhus/binary-extensions/blob/master/binary-extensions.json))
-* `useFsEvents` (default: `true` on OS X). Whether to use the
+* `useFsEvents` (default: `true` on MacOS). Whether to use the
 `fsevents` watching interface if available. When set to `true` explicitly
 and `fsevents` is available this supercedes the `usePolling` setting. When
-set to `false` on OS X, `usePolling: true` becomes the default.
+set to `false` on MacOS, `usePolling: true` becomes the default.
 * `alwaysStat` (default: `false`). If relying upon the
 [`fs.Stats`](http://nodejs.org/api/fs.html#fs_class_fs_stats)
 object that may get passed with `add`, `addDir`, and `change` events, set
@@ -268,26 +268,16 @@ execute a command on each change, or get a stdio stream of change events.
 * `gyp ERR! stack Error: not found: make`
   * On Mac, install the XCode command-line tools
 
-## License
 
-The MIT License (MIT)
+## Changelog
 
-Copyright (c) 2016 Paul Miller (http://paulmillr.com) & Elan Shanker
+For more detailed changelog, see `.github/full_changelog.md`
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the “Software”), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+- v3 (Apr 30, 2019): Massive CPU & RAM consumption improvements. 17x package & deps size reduction. Node 8+-only
+- v2 (Dec 29, 2017): Globs are now posix-style-only; without windows support. Tons of bugfixes.
+- v1 (Apr 7, 2015): Glob support, symlink support, tons of bugfixes. Node 0.8+ is supported
+- v0.1 (Apr 20, 2012): Initial release, extracted from [Brunch](https://github.com/brunch/brunch/blob/9847a065aea300da99bd0753f90354cde9de1261/src/helpers.coffee#L66)
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+## License
 
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+MIT (c) Paul Miller (https://paulmillr.com), see LICENSE file.

example.js

@@ -1,4 +1,4 @@
-require('./').watch('.', {
+global.watcher = require('./').watch('.', {
   ignored: /node_modules|\.git/,
   persistent: true,
   // followSymlinks: false,