fix(files): added watchEvents option

- this will allow the user to provide an array of supported file event names to which Browsersync will respond. fixes #1291 #1291
BrowserSync · Feb 13, 2017 · de2e2fa · de2e2fa
1 parent 5d1e084
commit de2e2fa
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 7 deletions.
diff --git a/lib/cli/opts.start.json b/lib/cli/opts.start.json
@@ -92,6 +92,10 @@
     "type": "number",
     "desc": "Specify a port for the UI to use"
   },
+  "watchEvents": {
+    "type": "array",
+    "desc": "Specify which file events to respond to"
+  },
   "no-notify": {
     "desc": "Disable the notify element in browsers"
   },

diff --git a/lib/default-config.js b/lib/default-config.js
@@ -31,6 +31,16 @@ module.exports = {
      */
     files: false,
 
+    /**
+     * Specify which file events to respond to.
+     * Available events: `add`, `change`, `unlink`, `addDir`, `unlinkDir`
+     * @property watchEvents
+     * @type Array
+     * @default ["change"]
+     * @since 2.18.8
+     */
+    watchEvents: ["change"],
+
     /**
      * File watching options that get passed along to [Chokidar](https://github.com/paulmillr/chokidar).
      * Check their docs for available options
@@ -40,11 +50,11 @@ module.exports = {
      * @since 2.6.0
      */
     watchOptions: {
+        ignoreInitial: true
         /*
          persistent: true,
 
          ignored: '*.txt',
-         ignoreInitial: false,
          followSymlinks: true,
          cwd: '.',
 
@@ -130,7 +140,7 @@ module.exports = {
      * @type string
      * @default undefined
      * @since 2.18.0
-     */    
+     */
 
     /**
      * Clicks, Scrolls & Form inputs on any device will be mirrored to all others.

diff --git a/lib/file-utils.js b/lib/file-utils.js
@@ -21,7 +21,7 @@ var fileUtils = {
          * `add` `unlink` etc etc so we need to check for that and only
          * respond to 'change', for now.
          */
-        if (data.event === "change") {
+        if (bs.options.get("watchEvents").indexOf(data.event) > -1) {
             if (!bs.paused && data.namespace === "core") {
                 bs.events.emit("file:reload", fileUtils.getFileInfo(data, bs.options));
             }
@@ -41,6 +41,7 @@ var fileUtils = {
             ext:           data.ext,
             path:          data.path,
             basename:      data.basename,
+            event:         data.event,
             type:          "inject"
         };
 

diff --git a/lib/logger.js b/lib/logger.js
@@ -50,7 +50,7 @@ module.exports.callbacks = {
                 return logger.info("{cyan:Reloading files that match: {magenta:%s", data.path);
             }
 
-            logger.info("{cyan:File changed: {magenta:%s", data.path);
+            logger.info("{cyan:File event [" + data.event + "] : {magenta:%s", data.path);
         }
     },
     /**

diff --git a/test/specs/api/init.reload.stream.js b/test/specs/api/init.reload.stream.js
@@ -125,14 +125,15 @@ describe("API: .stream()", function () {
             log:       false,
             namespace: "core",
             event:     "change",
-            ext:       "css"
+            ext:       "css",
         });
         sinon.assert.calledWithExactly(emitterStub, "file:reload", {
             ext: "css",
             path: "/users/shakyshane/.tmp/css/core.css",
             basename: "core.css",
             type: "inject",
-            log: false
+            log: false,
+            event: "change"
         });
         sinon.assert.calledWithExactly(emitterStub, "stream:changed", {
             changed: ["core.css"]

diff --git a/test/specs/files/files.watching.js b/test/specs/files/files.watching.js
@@ -47,7 +47,7 @@ describe("File Watcher Module", function () {
             ],
             watchOptions: {
                 interval: 200
-                
+
             }
         }, function (err, bs) {
             assert.equal(bs.watchers.core.watchers.length, 2);
@@ -96,6 +96,45 @@ describe("File Watcher Module", function () {
             bs.watchers.core.watchers[0]._events.all("change", tempFile);
         });
     });
+    it("should emit events about added files when watchEvents added", function (done) {
+
+        var tempFile = path.join(outpath, "watch-func.txt");
+        var called = false;
+
+        browserSync.reset();
+
+        // assert: it works if it calls done
+        var bs = browserSync.create();
+
+        bs.init({
+            watchEvents: ["add"],
+            files: [
+                {
+                    options: {
+                        ignoreInitial: true
+                    },
+                    match: tempFile,
+                    fn: function (event, file) {
+                        assert.equal(event, "add");
+                        assert.equal(file, tempFile);
+                        assert.isFunction(this.reload);
+                        assert.isFunction(this.notify);
+                        bs.cleanup();
+                        if (!called) {
+                            done();
+                            called = true;
+                        }
+                    }
+                }
+            ],
+            ui: false,
+            online: false,
+            logSnippet: false,
+            logLevel: "silent"
+        }, function (err, bs) {
+            bs.watchers.core.watchers[0]._events.all("add", tempFile);
+        });
+    });
     it("should allow obj literal with match & options, but without callback fn", function (done) {
 
         browserSync.reset();