fix(rewrite-rules): add back-compat option transformation to work around rewriteRules default now being an array - fixes #1226

Author: shakyShane

lib/options.js

@@ -19,6 +19,7 @@ module.exports.update = function (options) {
         setServerOpts(item);
         setNamespace(item);
         fixSnippetOptions(item);
+        fixRewriteRules(item);
         setMiddleware(item);
         setOpen(item);
 
@@ -148,8 +149,14 @@ function setServerOpts(item) {
 }
 
 /**
- * Back-compat options for snippetOptions.ignorePaths
+ * Back-compat fixes for rewriteRules being set to a boolean
  */
+function fixRewriteRules (item) {
+    return item.update("rewriteRules", function (rr) {
+        return Immutable.List([]).concat(rr).filter(Boolean)
+    });
+}
+
 function fixSnippetOptions (item) {
 
     var ignorePaths  = item.getIn(["snippetOptions", "ignorePaths"]);

test/specs/e2e/server/e2e.server.rewrite.rules.js

@@ -7,9 +7,7 @@ var assert  = require("chai").assert;
 
 describe("E2E server test with rewrite rules", function () {
 
-    var instance;
-
-    before(function (done) {
+    it("serves files with HTML rewritten", function (done) {
 
         browserSync.reset();
 
@@ -29,22 +27,41 @@ describe("E2E server test with rewrite rules", function () {
             open: false
         };
 
-        instance = browserSync.init(config, done).instance;
+        browserSync.init(config, function (err, bs) {
+            request(bs.server)
+                .get("/index.html")
+                .set("accept", "text/html")
+                .expect(200)
+                .end(function (err, res) {
+                    if (err) return done(err);
+                    assert.include(res.text, "Shane's forms");
+                    bs.cleanup(done);
+                });
+        });
     });
+    it("supports legacy boolean for rewriteRules", function (done) {
 
-    after(function () {
-        instance.cleanup();
-    });
+        browserSync.reset();
 
-    it("serves files with HTML rewritten", function (done) {
+        var config = {
+            server: {
+                baseDir: "test/fixtures"
+            },
+            rewriteRules: false,
+            logLevel: "silent",
+            open: false
+        };
+
+        browserSync.init(config, function (err, bs) {
 
-        request(instance.server)
-            .get("/index.html")
-            .set("accept", "text/html")
-            .expect(200)
-            .end(function (err, res) {
-                assert.include(res.text, "Shane's forms");
-                done();
-            });
+            request(bs.server)
+                .get("/index.html")
+                .set("accept", "text/html")
+                .expect(200)
+                .end(function (err) {
+                    if (err) return done(err);
+                    bs.cleanup(done);
+                });
+        });
     });
 });