Merge branch 'feature/backport-proxy'

Author: shakyShane

bin/browser-sync.js

@@ -1,92 +1,90 @@
-#!/usr/bin/env node
-"use strict";
-
-var meow         = require("meow");
-var fs           = require("fs");
-var path         = require("path");
-var compile      = require("eazy-logger").compile;
-var longest      = require("longest");
-var utils        = require("../lib/utils");
-var logger       = require("../lib/logger").logger;
-var cmdWhitelist = ["start", "init", "reload", "recipe"];
-
-var cli = meow({
-    pkg:  "../package.json",
-    help: getHelpText(path.join(__dirname, "../lib/cli/help.txt"))
-});
+var startOpts  = require("../lib/cli/opts.start.json");
+var reloadOpts = require("../lib/cli/opts.reload.json");
+var recipeOpts = require("../lib/cli/opts.recipe.json");
+var pkg        = require("../package.json");
+var utils      = require("../lib/utils");
 
 /**
  * Handle cli input
  */
 if (!module.parent) {
-    handleCli({cli: cli, whitelist: cmdWhitelist});
-}
-
-/**
- * Generate & colour the help text
- * @param {String} filepath - relative file path to the help text
- * @returns {String}
- */
-function getHelpText(filepath) {
-
-    /**
-     * Help text template
-     */
-    var template = fs.readFileSync(filepath, "utf8");
-
-    cmdWhitelist.forEach(function (command) {
-
-        var flags = require("../lib/cli/opts." + command + ".json");
-        template = template.replace("%" + command + "flags%", listFlags(flags));
-    });
-
-    return compile(template);
+    var yargs = require("yargs")
+        .command("start", "Start the server")
+        .command("init", "Create a configuration file")
+        .command("reload", "Send a reload event over HTTP protocol")
+        .command("recipe", "Generate the files for a recipe")
+        .version(function () {
+            return pkg.version;
+        })
+        .epilogue("For help running a certain command, type <command> --help\neg: $0 start --help");
+
+    var argv    = yargs.argv;
+    var command = argv._[0];
+    var valid   = ["start", "init", "reload", "recipe"];
+
+    if (valid.indexOf(command) > -1) {
+        handleIncoming(command, yargs.reset());
+    } else {
+        yargs.showHelp();
+    }
 }
 
 /**
  * @param {{cli: object, [whitelist]: array, [cb]: function}} opts
  * @returns {*}
  */
-function handleCli (opts) {
+function handleCli(opts) {
 
     opts.cb = opts.cb || utils.defaultCallback;
+    return require("../lib/cli/command." + opts.cli.input[0])(opts);
+}
 
-    var input = opts.cli.input;
+module.exports = handleCli;
 
-    if (!opts.whitelist) {
-        opts.whitelist = cmdWhitelist;
+/**
+ * @param {string} command
+ * @param {object} yargs
+ */
+function handleIncoming(command, yargs) {
+    var out;
+    if (command === "start") {
+        out = yargs
+            .usage("Usage: $0 start [options]")
+            .options(startOpts)
+            .example("$0 start -s app", "- Use the App directory to serve files")
+            .example("$0 start -p www.bbc.co.uk", "- Proxy an existing website")
+            .help()
+            .argv;
     }
-
-    if (!input.length || opts.whitelist.indexOf(input[0]) === -1) {
-        return console.log(opts.cli.help);
+    if (command === "init") {
+        out = yargs
+            .usage("Usage: $0 init")
+            .example("$0 init")
+            .help()
+            .argv;
     }
-
-    if (!require("../lib/cli/cli-utils").verifyOpts(input[0], opts.cli.flags)) {
-        logger.info("For help, run: {cyan:browser-sync --help}");
-        return opts.cb(new Error("Unknown flag given. Please refer to the documentation for help."));
+    if (command === "reload") {
+        out = yargs
+            .usage("Usage: $0 reload")
+            .options(reloadOpts)
+            .example("$0 reload")
+            .example("$0 reload --port 4000")
+            .help()
+            .argv;
+    }
+    if (command === "recipe") {
+        out = yargs
+            .usage("Usage: $0 recipe <recipe-name>")
+            .option(recipeOpts)
+            .example("$0 recipe ls", "list the recipes")
+            .example("$0 recipe gulp.sass", "use the gulp.sass recipe")
+            .help()
+            .argv;
     }
 
-    return require("../lib/cli/command." + input[0])(opts);
-}
-
-/**
- * @param {Object} flags
- */
-function listFlags (flags) {
-
-    var flagKeys = Object.keys(flags);
-    var maxLength = (longest(Object.keys(flags)) || "").length + 4;
-
-    return flagKeys.map(function (item) {
-        var length = maxLength - item.length;
-        return "    {bold:--" + item + chars(length, " ") + "}" +
-               flags[item];
-    }).join("\n");
-}
+    if (out.help) {
+        return yargs.showHelp();
+    }
 
-function chars (length, char) {
-    return new Array(length).join(char);
+    handleCli({cli: {flags: out, input: out._}});
 }
-
-module.exports = handleCli;
-module.exports.getHelpText = getHelpText;

lib/async.js

@@ -4,6 +4,7 @@ var _            = require("lodash");
 var Immutable    = require("immutable");
 
 var utils        = require("./utils");
+var pluginUtils  = require("./plugins");
 var connectUtils = require("./connect-utils");
 
 module.exports = {
@@ -110,29 +111,22 @@ module.exports = {
      */
     resolveInlineUserPlugins: function (bs, done) {
 
-        bs.options.get("plugins").forEach(function (item) {
+        var plugins = bs.options
+            .get("plugins")
+            .map(pluginUtils.resolvePlugin)
+            .map(pluginUtils.requirePlugin);
 
-            if (_.isString(item)) {
-                loadPlugin(item);
-            }
-
-            if (Immutable.Map.isMap(item)) {
-                if (item.has("module")) {
-                    loadPlugin(item.get("module"), item.get("options"));
-                } else {
-                    loadPlugin(item);
+        plugins
+            .forEach(function (plugin) {
+                if (plugin.get("errors").size) {
+                    return logPluginError(plugin);
                 }
-            }
-        });
+                var jsPlugin = plugin.toJS();
+                bs.registerPlugin(jsPlugin.module, jsPlugin.options);
+            });
 
-        function loadPlugin (name, opts) {
-            opts = opts ? opts.toJS() : {};
-            if (_.isString(name)) {
-                opts.moduleName = name;
-                bs.registerPlugin(require(name), opts);
-            } else {
-                bs.registerPlugin(name.toJS(), opts);
-            }
+        function logPluginError (plugin) {
+            utils.fail(true, new Error("Plugin: " + plugin.get("name") + " not found"), bs.cb);
         }
 
         done();
@@ -330,7 +324,10 @@ module.exports = {
         bs.addMiddleware(
             require("./config").httpProtocol.path,
             require("./http-protocol").middleware(bs),
-            {override: true}
+            {
+                override: true,
+                id: "Browsersync HTTP Protocol"
+            }
         );
 
         done();

lib/browser-sync.js

@@ -7,7 +7,7 @@ var connectUtils    = require("./connect-utils");
 var utils           = require("./utils");
 var logger          = require("./logger");
 
-var eachSeries      = require("async-each-series");
+var eachSeries      = utils.eachSeries;
 var _               = require("lodash");
 var EE              = require("easy-extender");
 
@@ -364,24 +364,41 @@ BrowserSync.prototype.getMiddleware = function (type) {
  * @param {String} path
  * @param {{type: string, content: string}} props
  */
+var _serveFileCount = 0;
 BrowserSync.prototype.serveFile = function (path, props) {
 
     var bs = this;
-
-    if (bs.app) {
-        bs.app.use(path, function (req, res) {
+    var mode = bs.options.get("mode");
+    var entry = {
+        handle: function (req, res) {
             res.setHeader("Content-Type", props.type);
             res.end(props.content);
-        });
+        },
+        id: "Browsersync - " + _serveFileCount++,
+        route: path
+    };
+
+    if (!bs.app) {
+        return;
     }
+
+    bs._addMiddlewareToStack(entry);
 };
 
 /**
  * Add middlewares on the fly
- * @param route
- * @param handle
- * @param opts
+ * @param {{route: string, handle: function, id?: string}}
  */
+BrowserSync.prototype._addMiddlewareToStack = function (entry) {
+    var bs = this;
+    if (bs.options.get("mode") === "proxy") {
+        bs.app.stack.splice(bs.app.stack.length-1, 0, entry);
+    } else {
+        bs.app.stack.push(entry);
+    }
+};
+
+var _addMiddlewareCount = 0;
 BrowserSync.prototype.addMiddleware = function (route, handle, opts) {
 
     var bs   = this;
@@ -390,31 +407,27 @@ BrowserSync.prototype.addMiddleware = function (route, handle, opts) {
         return;
     }
 
-    var mode = bs.options.get("mode");
-
     opts = opts || {};
 
     if (!opts.id) {
-        opts.id = "bs-mw-" + Math.random();
+        opts.id = "bs-mw-" + _addMiddlewareCount++;
     }
 
     if (route === "*") {
         route = "";
     }
 
-    if (opts.override) {
-        return bs.app.stack.unshift({id: opts.id, route: route, handle: handle});
-    }
-
-    if (mode === "proxy") {
-        return bs.app.use(route, handle, opts);
-    }
-
-    return bs.app.stack.push({
+    var entry = {
         id: opts.id,
         route: route,
         handle: handle
-    }); // function + route;
+    };
+
+    if (opts.override) {
+        return bs.app.stack.unshift(entry);
+    }
+
+    bs._addMiddlewareToStack(entry);
 };
 
 /**
@@ -611,14 +624,7 @@ BrowserSync.prototype.setRewriteRules = function (rules) {
     var bs = this;
 
     bs.rewriteRules = rules;
-
-    if (bs.options.get("mode") === "server") {
-        bs.snippetMw.opts.rules = rules;
-    }
-
-    if (bs.options.get("mode") === "proxy") {
-        bs.proxy.config.rules = rules;
-    }
+    bs.snippetMw.opts.rules = rules;
 };
 
 /**

lib/cli/cli-utils.js

@@ -19,20 +19,24 @@ module.exports = function (opts) {
     var dir       = path.dirname(resolved);
 
     var logRecipes = function () {
-        var dirs = fs.readdirSync(path.join(dir, "recipes"), function (err, output) {
-        });
+        var dirs = fs.readdirSync(path.join(dir, "recipes"));
         logger.info("Install one of the following with {cyan:browser-sync recipe <name>\n");
         dirs.forEach(function (name) {
             console.log("    " + name);
         });
-    }
+    };
 
     if (!input.length) {
         logger.info("No recipe name provided!");
         logRecipes();
         return opts.cb();
     }
 
+    if (opts.cli.input[1] === "ls") {
+        logRecipes();
+        return opts.cb();
+    }
+
     input         = input[0];
     var flags     = opts.cli.flags;
     var output    = flags.output ? path.resolve(flags.output) : path.join(process.cwd(), input);