rebase on latest socketstream, latest chokidar, better events

Author: mdlawson

lib/client/live_reload.js

@@ -1,77 +1,59 @@
-var consoleMessage, cssExtensions, fileUtils, fs, lastRun, pathlib;
+var chokidar, consoleMessage, cssExtensions, lastRun, pathlib,
+  __indexOf = Array.prototype.indexOf || function(item) { for (var i = 0, l = this.length; i < l; i++) { if (i in this && this[i] === item) return i; } return -1; };
 
 require('colors');
 
-fs = require('fs');
-
 pathlib = require('path');
 
-fileUtils = require('../utils/file');
+chokidar = require('chokidar');
 
 lastRun = {
   updateCSS: Date.now(),
   reload: Date.now()
 };
 
-cssExtensions = ['css', 'styl', 'stylus', 'less'];
+cssExtensions = ['.css', '.styl', '.stylus', '.less'];
 
 consoleMessage = {
   updateCSS: 'CSS files changed. Updating browser...',
   reload: 'Client files changed. Reloading browser...'
 };
 
 module.exports = function(ss, options) {
-  var allPaths, assetsToWatch, detectNewFiles, handleFileChange, watch;
-  handleFileChange = function(action) {
+  var dir, onChange, watchDirs, watcher;
+  watchDirs = (function() {
+    var _i, _len, _ref, _results;
+    _ref = options.liveReload;
+    _results = [];
+    for (_i = 0, _len = _ref.length; _i < _len; _i++) {
+      dir = _ref[_i];
+      _results.push(pathlib.join(ss.root, options.dirs[dir]));
+    }
+    return _results;
+  })();
+  watcher = chokidar.watch(watchDirs, {
+    ignored: /(\/\.|~$)/
+  });
+  watcher.on('add', function(path) {
+    return onChange(path, 'added');
+  });
+  watcher.on('change', function(path) {
+    return onChange(path, 'changed');
+  });
+  watcher.on('unlink', function(path) {
+    return onChange(path, 'removed');
+  });
+  watcher.on('error', function(path) {
+    return console.log('✎'.red, ("Error: " + error).red);
+  });
+  return onChange = function(path, event) {
+    var action, _ref;
+    action = (_ref = pathlib.extname(path), __indexOf.call(cssExtensions, _ref) >= 0) ? 'updateCSS' : 'reload';
     if ((Date.now() - lastRun[action]) > 1000) {
+      console.log('✎'.green, ("File " + event + ": " + path).grey);
       console.log('✎'.green, consoleMessage[action].grey);
       ss.publish.all('__ss:' + action);
       return lastRun[action] = Date.now();
     }
   };
-  assetsToWatch = function() {
-    var output;
-    output = {
-      files: [],
-      dirs: []
-    };
-    options.liveReload.forEach(function(dir) {
-      var path, result;
-      path = pathlib.join(ss.root, options.dirs[dir]);
-      result = fileUtils.readDirSync(path);
-      output.files = output.files.concat(result.files);
-      return output.dirs = output.dirs.concat(result.dirs);
-    });
-    return output;
-  };
-  allPaths = assetsToWatch();
-  watch = function(paths) {
-    paths.dirs.forEach(function(dir) {
-      return fs.watch(dir, detectNewFiles);
-    });
-    return paths.files.forEach(function(file) {
-      var changeAction, extension, watcher;
-      extension = file.split('.')[file.split('.').length - 1];
-      changeAction = cssExtensions.indexOf(extension) >= 0 && 'updateCSS' || 'reload';
-      return watcher = fs.watch(file, function(event) {
-        handleFileChange(changeAction);
-        if (event === "rename") return watcher.close();
-      });
-    });
-  };
-  detectNewFiles = function() {
-    var newPaths, pathsNow;
-    pathsNow = assetsToWatch();
-    newPaths = {
-      dirs: pathsNow.dirs.filter(function(dir) {
-        return allPaths.dirs.indexOf(dir) === -1;
-      }),
-      files: pathsNow.files.filter(function(file) {
-        return allPaths.files.indexOf(file) === -1;
-      })
-    };
-    watch(newPaths);
-    return allPaths = pathsNow;
-  };
-  return watch(allPaths);
 };

package.json

@@ -28,7 +28,8 @@
     "socket.io":        "= 0.9.6",
     "redis":            "= 0.7.1",
     "connect":          "= 2.0.3",
-    "connect-redis":    "= 1.3.0"
+    "connect-redis":    "= 1.3.0",
+    "chokidar":         "= 0.2.3"
   },
   "devDependencies": {
     "coffee-script":    "= 1.2.0",

src/client/live_reload.coffee

@@ -3,15 +3,14 @@
 # Detects changes in client files and sends an event to connected browsers instructing them to refresh the page
 
 require('colors')
-fs = require('fs')
 pathlib = require('path')
-fileUtils = require('../utils/file')
+chokidar = require('chokidar')
 
 lastRun =
   updateCSS: Date.now()
   reload:    Date.now()
 
-cssExtensions = ['css', 'styl', 'stylus', 'less']
+cssExtensions = ['.css', '.styl', '.stylus', '.less']
 
 consoleMessage =
   updateCSS: 'CSS files changed. Updating browser...'
@@ -20,42 +19,19 @@ consoleMessage =
 
 module.exports = (ss, options) ->
 
-  handleFileChange = (action) ->
+  watchDirs = for dir in options.liveReload
+    pathlib.join ss.root, options.dirs[dir]
+
+  watcher = chokidar.watch watchDirs, { ignored: /(\/\.|~$)/ }
+  watcher.on 'add', (path) -> onChange(path, 'added')
+  watcher.on 'change', (path) -> onChange(path, 'changed')
+  watcher.on 'unlink', (path) -> onChange(path, 'removed')
+  watcher.on 'error', (path) -> console.log('✎'.red, "Error: #{error}".red)
+    
+  onChange = (path, event) ->
+    action = if pathlib.extname(path) in cssExtensions then 'updateCSS' else 'reload'
     if (Date.now() - lastRun[action]) > 1000  # Reload browser max once per second
+      console.log('✎'.green, "File #{event}: #{path}".grey);
       console.log('✎'.green, consoleMessage[action].grey)
       ss.publish.all('__ss:' + action)
-      lastRun[action] = Date.now()
-
-  assetsToWatch = ->
-    output = {files: [], dirs: []}
-    options.liveReload.forEach (dir) ->
-      path = pathlib.join(ss.root, options.dirs[dir])
-      result = fileUtils.readDirSync(path)
-      output.files = output.files.concat(result.files)
-      output.dirs = output.dirs.concat(result.dirs)
-    output
-
-  allPaths = assetsToWatch()
-
-  watch = (paths) ->
-    paths.dirs.forEach (dir) -> fs.watch(dir, detectNewFiles)
-    paths.files.forEach (file) ->
-      extension = file.split('.')[file.split('.').length-1]
-      changeAction = cssExtensions.indexOf(extension) >= 0 && 'updateCSS' || 'reload'
-      watcher = fs.watch file, (event) ->
-        handleFileChange(changeAction)
-        if event == "rename"
-          watcher.close()
-          # Disabling for now as file = the old filename and although fs.watch
-          # should pass (event, filename) this does not work on all OSes
-          #watch({files: [file], dirs: []})
-
-  detectNewFiles = ->
-    pathsNow = assetsToWatch()
-    newPaths =
-      dirs:  pathsNow.dirs.filter (dir) ->   allPaths.dirs.indexOf(dir) == -1
-      files: pathsNow.files.filter (file) -> allPaths.files.indexOf(file) == -1
-    watch(newPaths)
-    allPaths = pathsNow
-   
-  watch(allPaths)
+      lastRun[action] = Date.now()