Merge pull request #347 from marko-js/issue-345

Fixes issue #345 - Whitespace preservation should apply to all nested text

compiler/CodeGenerator.js

@@ -189,9 +189,15 @@ class Generator {
             beforeAfterEvent = new GeneratorEvent(node, this);
         }
 
+        var isWhitespacePreserved = node.isPreserveWhitespace();
+
         if (beforeAfterEvent) {
             beforeAfterEvent.isBefore = true;
             beforeAfterEvent.node.emit('beforeGenerateCode', beforeAfterEvent);
+
+            if (isWhitespacePreserved) {
+                this.context.beginPreserveWhitespace();
+            }
         }
 
         if (node.getCodeGenerator) {
@@ -268,6 +274,10 @@ class Generator {
         if (beforeAfterEvent) {
             beforeAfterEvent.isBefore = false;
             beforeAfterEvent.node.emit('afterGenerateCode', beforeAfterEvent);
+
+            if (isWhitespacePreserved) {
+                this.context.endPreserveWhitespace();
+            }
         }
 
         this._currentNode = oldCurrentNode;

compiler/CompileContext.js

@@ -14,6 +14,8 @@ var macros = require('./util/macros');
 var extend = require('raptor-util/extend');
 var Walker = require('./Walker');
 
+const FLAG_PRESERVE_WHITESPACE = 'PRESERVE_WHITESPACE';
+
 const deresolveOptions = {
     shouldRemoveExt(ext) {
         return ext === '.js' || ext === '.json' || ext === '.es6';
@@ -392,8 +394,18 @@ class CompileContext {
         this._preserveWhitespace = preserveWhitespace;
     }
 
+    beginPreserveWhitespace() {
+        this.pushFlag(FLAG_PRESERVE_WHITESPACE);
+    }
+
+    endPreserveWhitespace() {
+        this.popFlag(FLAG_PRESERVE_WHITESPACE);
+    }
+
     isPreserveWhitespace() {
-        return this._preserveWhitespace === true;
+        if (this.isFlagSet(FLAG_PRESERVE_WHITESPACE) || this._preserveWhitespace === true) {
+            return true;
+        }
     }
 
     setPreserveComments(preserveComments) {

docs/language-guide.md

@@ -782,6 +782,8 @@ __Option 2)__ Disable whitespace removal using the `marko-preserve-whitespace` a
 </div>
 ```
 
+NOTE: When whitespace preservation is enabled, whitespace will be preserved for text at any level below the tag that the `marko-preserve-whitespace` attribute is attached to.
+
 __Option 3)__ Disable _all_ whitespace removal by changing a compiler option
 
 ```javascript
@@ -800,6 +802,8 @@ Adding the `"preserve-whitespace": true` property to a tag definition will resul
 }
 ```
 
+NOTE: When whitespace preservation is enabled, whitespace will be preserved for text at any level below the tag.
+
 # Helpers
 
 Since Marko template files compile into CommonJS modules, any Node.js module can be "imported" into a template for use as a helper module. For example, given the following helper module:

test/autotests/render/bodyText/expected.html

@@ -1 +1,3 @@
-<script><DIV>FOO</DIV></script>
+<script>
+    <DIV>FOO</DIV>
+</script>

test/autotests/render/marko-compiler-options-preserve-whitespace-nested/expected.html

@@ -0,0 +1,12 @@
+<div>
+    This
+    whitespace
+    should be
+    preserved
+    <div>
+        This
+        whitespace
+        should also be
+        preserved
+    </div>
+</div>

test/autotests/render/marko-compiler-options-preserve-whitespace-nested/template.marko

@@ -0,0 +1,14 @@
+<marko-compiler-options preserve-whitespace/>
+
+<div>
+    This
+    whitespace
+    should be
+    preserved
+    <div>
+        This
+        whitespace
+        should also be
+        preserved
+    </div>
+</div>

test/autotests/render/marko-compiler-options-preserve-whitespace-nested/test.js

@@ -0,0 +1 @@
+exports.templateData = {};

test/autotests/render/whitespace-marko-preserve-whitespace-attr/expected.html

@@ -0,0 +1,12 @@
+<div>
+    This
+    whitespace
+    should be
+    preserved
+    <div>
+        This
+        whitespace
+        should also be
+        preserved
+    </div>
+</div>

test/autotests/render/whitespace-marko-preserve-whitespace-attr/template.marko

@@ -0,0 +1,12 @@
+<div marko-preserve-whitespace>
+    This
+    whitespace
+    should be
+    preserved
+    <div>
+        This
+        whitespace
+        should also be
+        preserved
+    </div>
+</div>

test/autotests/render/whitespace-marko-preserve-whitespace-attr/test.js

@@ -0,0 +1,3 @@
+exports.templateData = {
+    "name": "World"
+};

test/autotests/render/whitespace-pre-code/expected.html

@@ -0,0 +1,3 @@
+<pre><code>// Hello World
+
+console.log('Hello World!');</code></pre>

test/autotests/render/whitespace-pre-code/template.marko

@@ -0,0 +1,3 @@
+<pre><code>// Hello World
+
+console.log('Hello World!');</code></pre>

test/autotests/render/whitespace-pre-code/test.js

@@ -0,0 +1,3 @@
+exports.templateData = {
+    "name": "World"
+};