Merge pull request #2972 from mjmlio/fix-2882

fix(mjml-parser): HTML Comments rendered with additional white space … fixes #2882

Author: totocap

packages/mjml-parser-xml/src/index.js

@@ -319,7 +319,7 @@ export default function MJMLParser(xml, options = {}, includedIn = []) {
           cur.children.push({
             line: findLastIndex(lineIndexes, (i) => i <= parser.startIndex) + 1,
             tagName: 'mj-raw',
-            content: `<!-- ${data.trim()} -->`,
+            content: `<!--${data}-->`,
             includedIn,
           })
         }

packages/mjml/test/html-comments.test.js

@@ -0,0 +1,33 @@
+const chai = require('chai')
+const mjml = require('../lib')
+
+const input = `
+<mjml>
+  <mj-body>
+    <mj-section>
+      <mj-column>
+        <mj-text>
+        <p>View source to see comments below</p>
+        <!-- comment with standard spaces -->
+        <br>
+        <!--comment without spaces-->
+        <br>
+        <!--     comment with 5 spaces     -->
+        </mj-text>
+      </mj-column>
+    </mj-section>
+  </mj-body>
+</mjml>
+`
+
+const { html } = mjml(input)
+
+// should not alter templating syntax, or move the content that is outside any tag (mj-raws)
+const expected = [
+  '<!-- comment with standard spaces -->',
+  '<!--comment without spaces-->',
+  '<!--     comment with 5 spaces     -->',
+]
+const indexes = expected.map((str) => html.indexOf(str))
+
+chai.expect(indexes, 'Cmment syntax unaltered').to.not.include(-1)

packages/mjml/test/index.js

@@ -3,3 +3,4 @@ require('./lazy-head-style.test')
 require('./tableWidth.test')
 require('./wrapper-border-radius.test')
 require('./accordionTitle-fontWeight.test')
+require('./html-comments.test')