Merge pull request #67 from bem/ignore-html-comments-option

eGavr · eGavr · commit c3cfc512c973 · 2014-07-24T23:46:03.000+04:00
Ignore html comments option
diff --git a/lib/cli.js b/lib/cli.js
@@ -55,9 +55,9 @@ module.exports = require('coa').Cmd()
                 var options = utils.defaults(config),
                     loggerOptions = {
                         charsAroundDiff: opts.charsAroundDiff
-                    };
+                    },
+                    htmlDiffer = new HtmlDiffer(options);
 
-                htmlDiffer = new HtmlDiffer(options),
                 diffLogger.log(htmlDiffer.diffHtml(html1, html2), loggerOptions);
             });
     })
diff --git a/lib/index.js b/lib/index.js
@@ -1,5 +1,4 @@
 var utils = require('./utils'),
-
     diff = require('diff'),
     htmlParser = require('htmlparser2'),
     AST2Html = require('htmlparser-to-html'),
@@ -32,6 +31,8 @@ function htmlToAST(HTMLDoc) {
  * @returns {AST}
  */
 function modifyASTTree(tree, options) {
+    var delComments = [];
+
     _.forEach(tree, function(node) {
         if (options.ignoreWhitespace && node.type === 'text') {
 
@@ -43,6 +44,12 @@ function modifyASTTree(tree, options) {
             return;
         }
 
+        if (options.ignoreHtmlComments && node.type === 'comment') {
+            delComments.push(tree.indexOf(node));
+
+            return;
+        }
+
         if (node.hasOwnProperty('attribs')) {
             var attrs = utils.sortObj(node['attribs']);
 
@@ -76,6 +83,10 @@ function modifyASTTree(tree, options) {
         }
     });
 
+    for (var i = 0; i < delComments.length; i++) {
+        tree.splice(delComments[i] - i, 1);
+    }
+
     return tree;
 }
 
@@ -194,7 +205,6 @@ function bemDiff(html1, html2) {
         loggerOptions = {
             showCharacters: 40
         },
-
         htmlDiffer = new HtmlDiff(options);
 
     logger.log(htmlDiffer.diff(html1, html2), loggerOptions);
diff --git a/lib/utils.js b/lib/utils.js
@@ -59,6 +59,7 @@ exports.defaults = function(options) {
         compareHtmlAttrsAsJSON: [],
 
         ignoreWhitespace: true,
+        ignoreHtmlComments: true,
 
         bem: false
     });
diff --git a/test/diffHtml.js b/test/diffHtml.js
@@ -14,9 +14,7 @@ describe('\'diffHtml\'', function () {
 
     it('must set options', function () {
         var htmlDiffer = new HtmlDiffer({ ignoreHtmlAttrs: ['id', 'for'], ignoreWhitespace: true }),
-
             files = readFiles('3.html', '_3.html'),
-
             res = [ {
                 value: '<html><head><title>Test</title></head><body><label for="">label for input</label><input id=""></body></html>',
                 added: undefined,
diff --git a/test/fixtures/10.html b/test/fixtures/10.html
@@ -1,12 +1,12 @@
 <!DOCTYPE html>
 <!-- comments1 -->
 <html>
-<head lang="en">
+<!-- comments2 --><head lang="en"><!-- comments3 -->
     <meta charset="UTF-8">
-    <title><!-- comments2 --></title>
-</head>
+    <title><!-- comments4 --></title>
+</head><!-- comments5 -->
 <body>
-Text<!-- comments3 -->
+Text<!-- comments6 -->
 </body>
 </html>
-<!-- comments4 -->
+<!-- comments7 -->
diff --git a/test/getDiffText.js b/test/getDiffText.js
@@ -38,7 +38,6 @@ describe('\'diffHtml\'', function () {
                 added: undefined,
                 removed: undefined
             } ],
-
             out = '\n...\n' + 'texttexttexttexttext'.grey + '!'.inverse.green + 'Text'.grey + '!'.inverse.green + 'texttexttexttext'.grey;
 
         diffLoger.getDiffText(inp, { charsAroundDiff: 20 }).must.be.eql(out);
@@ -67,7 +66,6 @@ describe('\'diffHtml\'', function () {
                 added: false,
                 removed: true
             } ],
-
             out = '\n' + 'texttexttexttexttexttexttexttexttexttexttext'.inverse.green + 'ololoololoololoololoololoololoololoololoolol'.inverse.red;
 
         diffLoger.getDiffText(inp, { charsAroundDiff: 20 }).must.be.eql(out);
@@ -88,7 +86,6 @@ describe('\'diffHtml\'', function () {
                 added: undefined,
                 removed: undefined
             } ],
-
             out = '\n' + 'texttexttext'.grey + 'text'.inverse.red + 'texttexttexttext'.grey;
 
         diffLoger.getDiffText(inp).must.be.eql(out);
@@ -125,7 +122,6 @@ describe('\'diffHtml\'', function () {
                 added: undefined,
                 removed: undefined
             } ],
-
             out = '\n...\n' + 'texttexttexttexttext'.grey + 'text'.inverse.red + 'texttexttexttexttext'.grey + '\n...\n' + 'texttexttexttexttext'.grey + '!'.inverse.green + 'text'.grey + '!'.inverse.green + 'texttexttexttexttext'.grey;
 
         diffLoger.getDiffText(inp, { charsAroundDiff: 20 }).must.be.eql(out);
diff --git a/test/isEqual.js b/test/isEqual.js
@@ -84,4 +84,12 @@ describe('\'isEqual\'', function () {
         htmlDiffer.isEqual(files.html1, files.html2).must.be.true();
     });
 
+    it('must ignore html comments', function() {
+        var htmlDiffer = new HtmlDiffer(),
+
+            files = readFiles('10.html', '_10.html');
+
+        htmlDiffer.isEqual(files.html1, files.html2).must.be.true();
+    });
+
 });
