@electric-eloquence/chokidar - npm Package Compare versions

Comparing version 1.7.2 to 1.7.3-rc.1

CHANGELOG.md

 # Chokidar Changelog
 
+### 1.7.3
+* Downgrading optional dependency (Mac only) fsevents to major version 1
+* Otherwise, minor maintenance and doc updates
+
 ### 1.7.2
@@ -4,0 +8,0 @@ * Better handling of renamed and removed directories

index.js

@@ -151,4 +151,3 @@ 'use strict';
 
-  // Editor atomic write normalization enabled by default with fs.watch
-  if (undef('atomic')) opts.atomic = !opts.usePolling && !opts.useFsEvents;
+  if (undef('ignoreTmpFiles')) opts.ignoreTmpFiles = true;
   if (opts.atomic) this._pendingUnlinks = Object.create(null);
@@ -411,5 +410,9 @@
 // Returns boolean
-var dotRe = /\..*\.(sw[px])$|\~$|\.subl.*\.tmp/;
+var dotRe = /\..*\.swp$|~$|\.subl.*\.tmp$/;
 FSWatcher.prototype._isIgnored = function(path, stats) {
-  if (this.options.atomic && dotRe.test(path)) return true;
+  if (dotRe.test(path)) {
+    if (this.options.atomic || this.options.ignoreTmpFiles) {
+      return true;
+    }
+  }
 
@@ -416,0 +419,0 @@ if (!this._userIgnored) {

package.json

 {
   "name": "@electric-eloquence/chokidar",
   "description": "A neat wrapper around node.js fs.watch / fs.watchFile / fsevents.",
-  "version": "1.7.2",
+  "version": "1.7.3-rc.1",
   "keywords": [
@@ -34,2 +34,5 @@ "fs",
   ],
+  "engines": {
+    "node": ">=6.14.2"
+  },
   "devDependencies": {
@@ -41,3 +44,3 @@ "chai": "4.x",
     "mocha": "5.x",
-    "nyc": "^11.9.0",
+    "nyc": "^13.1.0",
     "rimraf": "^2.6.2",
@@ -48,3 +51,3 @@ "sinon": "7.x",
   "optionalDependencies": {
-    "fsevents": "^2.0.1"
+    "fsevents": "^1.2.7"
   },
@@ -51,0 +54,0 @@ "dependencies": {

README.md

@@ -1,2 +0,2 @@
-# Chokidar [![Known Vulnerabilities][snyk-image]][snyk-url] [![Mac/Linux Build Status][travis-image]][travis-url] [![Windows Build Status][appveyor-image]][appveyor-url] [![Coverage Status][coveralls-image]][coveralls-url] [![License][license-image]][license-url]
+# Chokidar [![Known Vulnerabilities][snyk-image]][snyk-url] [![Mac/Linux Build Status][travis-image]][travis-url] [![Windows Build Status][appveyor-image]][appveyor-url] [![Coverage Status][coveralls-image]][coveralls-url] ![Node Version][version-image] [![License][license-image]][license-url]
 
@@ -17,15 +17,13 @@ > A neat wrapper around node.js fs.watch / fs.watchFile / fsevents.
 ## Install
-* Latest version (without Git):
-  * `npm install --save https://github.com/electric-eloquence/chokidar/tarball/v1-lts@1.7.2`
-  * Or add `"chokidar": "https://github.com/electric-eloquence/chokidar/tarball/v1-lts@1.7.2"`
-    as a dependency in package.json.
-* Latest version (with Git):
-  * `npm install --save electric-eloquence/chokidar`
-* Specific version (with Git):
-  * `npm install --save electric-eloquence/chokidar#1.7.2`
-* Semver range (with Git):
-  * `npm install --save electric-eloquence/chokidar#semver:^1.7.2`
-* When installed one of these ways, other packages depending on Chokidar will
-  get Chokidar v1 with long-term support.
 
+```shell
+npm install --save @electric-eloquence/chokidar
+```
+
+## Use
+
+```javascript
+var chokidar = require('@electric-eloquence/chokidar');
+```
+
 ## Why Chokidar?
@@ -49,13 +47,2 @@ Node.js `fs.watch`:
 
-Initially made for [brunch](http://brunch.io) (an ultra-swift web app build tool), it is now used in
-[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.
-
 ## How?
@@ -85,3 +72,3 @@ Chokidar does still rely on the Node.js core `fs` module, but when using
 ```javascript
-var chokidar = require('chokidar');
+var chokidar = require('@electric-eloquence/chokidar');
 
@@ -142,3 +129,3 @@ // One-liner for current directory, ignores .dotfiles
 
-// Full list of options. See below for descriptions. (do not use this example)
+// Full list of options. See below for descriptions. (Do not use this example.)
 chokidar.watch('file', {
@@ -253,9 +240,14 @@ persistent: true,
   or `EACCES` with this set to `true`, the errors will be suppressed silently.
-* `atomic` (default: `true` if `useFsEvents` and `usePolling` are `false`).
-  Automatically filters out artifacts that occur when using editors that use
-  "atomic writes" instead of writing directly to the source file. If a file is
-  re-added within 100 ms of being deleted, Chokidar emits a `change` event
-  rather than `unlink` then `add`. If the default of 100 ms does not work well
-  for you, you can override it by setting `atomic` to a custom value, in
-  milliseconds.
+* `atomic` (default: `false`). Automatically filters out artifacts that occur
+  when using editors that use "atomic saves" instead of saving directly to the
+  source file. If a file is re-added within 100 ms of being deleted, Chokidar
+  emits a `change` event rather than `unlink` then `add`. If the default of 100
+  ms does not work well for you, you can override it by setting `atomic` to a
+  custom value, in milliseconds.
+* `ignoreTmpFiles` (default: `true`). Ignores editor artifacts filtered by the
+  non-false `atomic` option, but without any delay. Specifically ignores the
+  `.swp` and `~` extensions, and filenames with a `.subl` substring and `.tmp`
+  extension. The `atomic` option is less useful these days since the Sublime
+  editor was the primary culprit for atomic saves, and
+  [atomic saves are now off by default](http://docs.sublimetext.info/en/latest/reference/settings.html#file-and-directory-settings).
 
@@ -291,11 +283,12 @@ ### Methods & Events
 * `npm ERR! code EINTEGRITY`
-  * If npm warns that the tarball data seems to be corrupted, delete your
+  * If npm warns that the tarball seems to be corrupted, delete your
     package-lock.json, and install again.
 
 * `npm WARN optional dep failed, continuing fsevents@n.n.n`
-  * This message is normal part of how `npm` handles optional dependencies and is
-    not indicative of a problem. Even if accompanied by other related error messages,
-    Chokidar should function properly.
+  * This message is normal part of how `npm` handles optional dependencies and
+    is not indicative of a problem. Even if accompanied by other related error
+    messages, Chokidar should function properly.
 
-* `ERR! stack Error: Python executable "python" is v3.4.1, which is not supported by gyp.`
+* `ERR! stack Error: Python executable "python" is v3.4.1, which is not
+  supported by gyp.`
   * You should be able to resolve this by installing python 2.7 and running:
@@ -310,12 +303,14 @@ `npm config set python python2.7`
 
-[travis-image]: https://img.shields.io/travis/electric-eloquence/chokidar.svg
+[travis-image]: https://img.shields.io/travis/electric-eloquence/chokidar.svg?label=mac%20%26%20linux
 [travis-url]: https://travis-ci.org/electric-eloquence/chokidar
 
-[appveyor-image]: https://img.shields.io/appveyor/ci/e2tha-e/chokidar.svg?label=appveyor
+[appveyor-image]: https://img.shields.io/appveyor/ci/e2tha-e/chokidar.svg?label=windows
 [appveyor-url]: https://ci.appveyor.com/project/e2tha-e/chokidar
 
-[coveralls-image]: https://img.shields.io/coveralls/electric-eloquence/chokidar/v1-lts.svg
-[coveralls-url]: https://coveralls.io/r/electric-eloquence/chokidar
+[coveralls-image]: https://coveralls.io/repos/github/electric-eloquence/chokidar/badge.svg?branch=v1-lts
+[coveralls-url]: https://coveralls.io/github/electric-eloquence/chokidar?branch=v1-lts
 
+[version-image]: https://img.shields.io/node/v/@electric-eloquence/chokidar.svg
+
 [license-image]: https://img.shields.io/github/license/electric-eloquence/chokidar.svg
 [license-url]: https://raw.githubusercontent.com/electric-eloquence/chokidar/v1-lts/LICENSE

New alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Lines of code

1512

increased by0.2%

Worsened metrics

Total package byte prevSize

74747

decreased by-0.33%

Number of medium maintenance alerts

1

increased byInfinity%

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

310

decreased by-1.59%

No dependency changes