feat(recipes): Allow easy install of curated Browsersync recipes

Author: shakyShane

bin/browser-sync.js

@@ -8,7 +8,7 @@ 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"];
+var cmdWhitelist = ["start", "init", "reload", "recipe"];
 
 var cli = meow({
     pkg:  "../package.json",

lib/cli/command.recipe.js

@@ -0,0 +1,60 @@
+"use strict";
+var logger = require('../logger').logger;
+
+/**
+ * $ browser-sync recipe <name> <options>
+ *
+ * This command will copy a recipe into either the current directory
+ * or one given with the --output flag
+ *
+ * @param opts
+ * @returns {Function}
+ */
+module.exports = function (opts) {
+
+    var path      = require('path');
+    var fs        = require('fs-extra');
+    var input     = opts.cli.input.slice(1);
+    var resolved  = require.resolve('bs-recipes');
+    var dir       = path.dirname(resolved);
+
+    var logRecipes = function (cb) {
+        fs.readdir(path.join(dir, 'recipes'), function (err, output) {
+            logger.info('Install one of the following with {cyan:browser-sync recipe <name>\n');
+            output.forEach(function (name) {
+                console.log('    ', name);
+            });
+            cb();
+        });
+    }
+
+    if (!input.length) {
+        logger.info('No recipe name provided!');
+        return logRecipes(opts.cb);
+    }
+
+    input         = input[0];
+    var flags     = opts.cli.flags;
+    var output    = flags.output ? path.resolve(flags.output) : path.join(process.cwd(), input);
+    var targetDir = path.join(dir, 'recipes', input);
+
+
+    if (fs.existsSync(output)) {
+        return opts.cb(new Error("Target folder exists remove it first and then try again"));
+    }
+
+    if (fs.existsSync(targetDir)) {
+        fs.copy(targetDir, output, function (err) {
+            if (err) {
+                opts.cb(err);
+            } else {
+                logger.info('Recipe copied into {cyan:%s}', output);
+                logger.info('Next, inside that folder, run {cyan:npm i && npm start}');
+                opts.cb(null);
+            }
+        });
+    } else {
+        logger.info('Recipe {cyan:%s} not found. The following are available though', input);
+        logRecipes();
+    }
+};

lib/cli/opts.recipe.json

@@ -0,0 +1,3 @@
+{
+  "output": "Specify an output directory"
+}

package.json

@@ -34,13 +34,15 @@
     "async-each-series": "^0.1.1",
     "browser-sync-client": "^2.3.3",
     "browser-sync-ui": "^0.5.16",
+    "bs-recipes": "^1.0.5",
     "chokidar": "^1.0.5",
     "connect": "^3.4.0",
     "dev-ip": "^1.0.1",
     "easy-extender": "^2.3.1",
     "eazy-logger": "^2.1.2",
     "emitter-steward": "^1.0.0",
     "foxy": "^11.1.2",
+    "fs-extra": "^0.26.2",
     "immutable": "^3.7.4",
     "localtunnel": "^1.7.0",
     "lodash": "^3.9.3",