Support comment nodes in html pretty printing

jestjs · Apr 23, 2017 · e7bc468 · e7bc468
1 parent 7cba8fb
commit e7bc468
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/packages/pretty-format/src/__tests__/HTMLElementPlugin-test.js b/packages/pretty-format/src/__tests__/HTMLElementPlugin-test.js
@@ -123,4 +123,16 @@ describe('HTMLElement Plugin', () => {
       '</div>',
     ].join('\n'));
   });
+
+  it('supports comment node', () => {
+    const parent = document.createElement('div');
+    parent.innerHTML = 'some <!-- comments -->';
+
+    expect(parent).toPrettyPrintTo([
+      '<div>',
+      '  some ',
+      '  <!-- comments -->',
+      '</div>',
+    ].join('\n'));
+  });
 });
diff --git a/packages/pretty-format/src/plugins/HTMLElement.js b/packages/pretty-format/src/plugins/HTMLElement.js
@@ -13,14 +13,14 @@
 import type {Colors, Indent, Options, Print, Plugin} from '../types.js';
 
 const escapeHTML = require('./lib/escapeHTML');
-const HTML_ELEMENT_REGEXP = /(HTML\w*?Element)|Text/;
+const HTML_ELEMENT_REGEXP = /(HTML\w*?Element)|Text|Comment/;
 const test = isHTMLElement;
 
 function isHTMLElement(value: any) {
   return (
     value !== undefined &&
     value !== null &&
-    (value.nodeType === 1 || value.nodeType === 3) &&
+    (value.nodeType === 1 || value.nodeType === 3 || value.nodeType === 8) &&
     value.constructor !== undefined &&
     value.constructor.name !== undefined &&
     HTML_ELEMENT_REGEXP.test(value.constructor.name)
@@ -67,6 +67,10 @@ const print = (
     return element.data;
   }
 
+  if (element.nodeType === 8) {
+    return `<!--${element.data}-->`;
+  }
+
   let result = colors.tag.open + '<';
   const elementName = element.tagName.toLowerCase();
   result += elementName + colors.tag.close;