chore: comments/docs

Author: shakyShane

lib/cli/opts.start.json

@@ -65,6 +65,10 @@
     "type": "string",
     "desc": "Choose which URL is auto-opened (local, external or tunnel), or provide a url"
   },
+  "cors": {
+    "type": "boolean",
+    "desc": "Add Access Control headers to every request"
+  },
   "config": {
     "type": "string",
     "alias": "c",

lib/default-config.js

@@ -105,6 +105,16 @@ module.exports = {
      */
     serveStatic: [],
 
+    /**
+     * Options that are passed to the serve-static middleware
+     * when you use the string[] syntax: eg: `serveStatic: ['./app']`. Please see
+     * [serve-static](https://github.com/expressjs/serve-static) for details
+     *
+     * @property serveStaticOptions
+     * @type Object
+     * @since 1.17.0
+     */
+
     /**
      * Enable https for localhost development. **Note** - this is not needed for proxy
      * option as it will be inferred from your target url.

lib/server/utils.js

@@ -77,6 +77,10 @@ var utils = {
             }
         ];
 
+        /**
+         * Add cors middleware to the front of the stack
+         * if a user provided a 'cors' flag
+         */
         if (options.get("cors")) {
             defaultMiddlewares.unshift({
                 id: "Browsersync CORS support",
@@ -85,8 +89,10 @@ var utils = {
             })
         }
 
+        /**
+         * Add serve static middleware
+         */
         if (options.get("serveStatic")) {
-
             var ssMiddlewares = utils.getServeStaticMiddlewares(options.get("serveStatic"), options.get("serveStaticOptions", Immutable.Map({})).toJS());
             var withErrors    = ssMiddlewares.filter(function(x) { return x.get("errors").size > 0 });
             var withoutErrors = ssMiddlewares.filter(function(x) { return x.get("errors").size === 0 });
@@ -172,6 +178,11 @@ var utils = {
             next();
         }
     },
+    /**
+     * @param ssOption
+     * @param serveStaticOptions
+     * @returns {*}
+     */
     getServeStaticMiddlewares: function (ssOption, serveStaticOptions) {
 
         return ssOption.map(function (dir, i) {
@@ -212,10 +223,20 @@ var utils = {
                 }]
             })
         });
+
+        /**
+         * @param {string} x
+         * @returns {string}
+         */
         function getRoute (x) {
             if (x === "") return "";
             return x[0] === "/" ? x : "/" + x;
         }
+
+        /**
+         * @param dir
+         * @returns {Map}
+         */
         function getFromString(dir) {
             return fromJS({
                 items: [
@@ -227,6 +248,11 @@ var utils = {
                 errors: []
             })
         }
+
+        /**
+         * @param dir
+         * @returns {Map}
+         */
         function getFromMap(dir) {
 
             var ssOptions = (function () {