Merge pull request #30 from kasperpedersen/feature/comment-diff

feat: Report differences for comments
i-like-robots · Apr 19, 2021 · 7e79c43 · 7e79c43
2 parents bc4043c + e9dd26f
commit 7e79c43
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/lib/strategy.js b/lib/strategy.js
@@ -3,6 +3,8 @@
 function thing (ast) {
   if (ast.nodeName === '#text') {
     return `text "${ast.value}"`
+  } else if (ast.nodeName === '#comment') {
+    return `comment "${ast.data}"`
   } else if (ast.tagName) {
     return `tag <${ast.tagName}>`
   } else if (ast.name && ast.value) {

diff --git a/tests/spec/chai-html.js b/tests/spec/chai-html.js
@@ -145,6 +145,14 @@ describe('Chai HTML', () => {
           expect(e.message).to.equal('text "Hej world!" was changed to text "Hello world!"')
         }
       })
+
+      it('detects comment changes', () => {
+        try {
+          expect('<p>Hello world!</p><!-- Hello -->').html.to.equal('<p>Hello world!</p><!-- Hej -->')
+        } catch (e) {
+          expect(e.message).to.equal('comment " Hej " was changed to comment " Hello "')
+        }
+      })
     })
 
     context('additions', () => {
@@ -171,6 +179,14 @@ describe('Chai HTML', () => {
           expect(e.message).to.equal('text " Hej!" has been added')
         }
       })
+
+      it('detects comment added', () => {
+        try {
+          expect('<p>Hello world!</p><!-- Hej! -->').html.to.equal('<p>Hello world!</p>')
+        } catch (e) {
+          expect(e.message).to.equal('comment " Hej! " has been added')
+        }
+      })
     })
 
     context('deletions', () => {
@@ -197,6 +213,14 @@ describe('Chai HTML', () => {
           expect(e.message).to.equal('text " Hej!" has been removed')
         }
       })
+
+      it('detects comment removed', () => {
+        try {
+          expect('<p>Hello world!</p>').html.to.equal('<p>Hello world!</p> <!-- Hej! -->')
+        } catch (e) {
+          expect(e.message).to.equal('comment " Hej! " has been removed')
+        }
+      })
     })
   })
 })