Move to option 'ignoreWhitespaces'

Author: eGavr

lib/diff-logger.js

@@ -13,7 +13,7 @@ function getDiffText(diff, options) {
     };
 
     if (options.showCharacters) {
-        console.log('Option \'showCharacters\' is deprecated, please, use \'charsAroundDiff\'');
+        console.log('WARNING! Option \'showCharacters\' is deprecated, please, use \'charsAroundDiff\''.red);
         options.charsAroundDiff = options.showCharacters;
     }
 

lib/index.js

@@ -1,4 +1,5 @@
 var utils = require('./utils'),
+
     diff = require('diff'),
     htmlParser = require('htmlparser2'),
     AST2Html = require('htmlparser-to-html'),
@@ -34,7 +35,7 @@ function modifyASTTree(tree, options) {
     var delComments = [];
 
     _.forEach(tree, function(node) {
-        if (options.ignoreWhitespace && node.type === 'text') {
+        if (options.ignoreWhitespaces && node.type === 'text') {
 
             node.data = node.data
                 .replace(/(\n|\r|\t|\v|\f)+/g, '')
@@ -96,7 +97,7 @@ function modifyASTTree(tree, options) {
  * @param {String[]} [options.ignoreHtmlAttrs]
  * @param {String[]} [options.compareHtmlAttrsAsJSON]
  * @param {Boolean} [options.verbose]
- * @param {Boolean} [options.ignoreWhitespace=true]
+ * @param {Boolean} [options.ignoreWhitespaces=true]
  * @param {Boolean} [options.bem=false]
  * @constructor
  */
@@ -135,7 +136,7 @@ HtmlDiff.prototype.tokenize = function(value) {
  * @param {String[]} [options.ignoreHtmlAttrs]
  * @param {String[]} [options.compareHtmlAttrsAsJSON]
  * @param {Boolean} [options.verbose]
- * @param {Boolean} [options.ignoreWhitespace=true]
+ * @param {Boolean} [options.ignoreWhitespaces=true]
  * @param {Boolean} [options.bem=false]
  * @constructor
  */
@@ -159,7 +160,7 @@ var HtmlDiffer = function(options) {
  */
 HtmlDiffer.prototype.diffHtml = function(html1, html2, options) {
     if (options) {
-        console.warn('WARNING! The third param of \'diffHtml\' method is deprecated!');
+        console.warn('WARNING! The third param of \'diffHtml\' method is deprecated!'.bold.red);
     }
 
     options = _.defaults(this.options, options);
@@ -178,7 +179,7 @@ HtmlDiffer.prototype.diffHtml = function(html1, html2, options) {
  */
 HtmlDiffer.prototype.isEqual = function(html1, html2, options) {
     if (options) {
-        console.warn('WARNING! The third param of \'isEqual\' method is deprecated!');
+        console.warn('WARNING! The third param of \'isEqual\' method is deprecated!'.bold.red);
     }
 
     options = _.defaults(this.options, options);
@@ -195,7 +196,7 @@ HtmlDiffer.prototype.isEqual = function(html1, html2, options) {
  * @param {String} html2
  */
 function bemDiff(html1, html2) {
-    console.warn('WARNING! You use deprecated method \'bemDiff\'!');
+    console.warn('WARNING! You use deprecated method \'bemDiff\'!'.bold.red);
 
     var logger = require('./diff-logger'),
         options = {

lib/utils.js

@@ -1,5 +1,7 @@
 var _ = require('lodash');
 
+require('colors');
+
 /**
  * Recursively sorts the given object by key
  * @param {Object} obj
@@ -54,11 +56,18 @@ exports.sortCssClasses = function(cssClasses) {
  * @returns {Object}
  */
 exports.defaults = function(options) {
+    if (options && options.hasOwnProperty('ignoreWhitespace')) {
+        console.log('WARNING! Option \'ignoreWhitespace\' is deprecated, please, use \'ignoreWhitespaces\''.bold.red);
+        options.ignoreWhitespaces = options.ignoreWhitespace;
+
+        delete options.ignoreWhitespace;
+    }
+
     return _.defaults(options || {}, {
         ignoreHtmlAttrs: [],
         compareHtmlAttrsAsJSON: [],
 
-        ignoreWhitespace: true,
+        ignoreWhitespaces: true,
         ignoreHtmlComments: true,
 
         bem: false

test/diffHtml.js

@@ -13,7 +13,7 @@ function readFiles(f1, f2) {
 describe('\'diffHtml\'', function () {
 
     it('must set options', function () {
-        var htmlDiffer = new HtmlDiffer({ ignoreHtmlAttrs: ['id', 'for'], ignoreWhitespace: true }),
+        var htmlDiffer = new HtmlDiffer({ ignoreHtmlAttrs: ['id', 'for'], ignoreWhitespaces: 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>',

test/isEqual.js

@@ -14,79 +14,69 @@ describe('\'isEqual\'', function () {
 
     it('must be equal', function () {
         var htmlDiffer = new HtmlDiffer(),
-
             files = readFiles('1.html', '_1.html');
 
         htmlDiffer.isEqual(files.html1, files.html2).must.be.true();
     });
 
     it('must be not equal', function () {
         var htmlDiffer = new HtmlDiffer(),
-
             files = readFiles('2.html', '_2.html');
 
         htmlDiffer.isEqual(files.html1, files.html2).must.be.false();
     });
 
     it('must ignore html attrs', function () {
         var htmlDiffer = new HtmlDiffer({ ignoreHtmlAttrs: ['id', 'for'] }),
-
             files = readFiles('3.html', '_3.html');
 
         htmlDiffer.isEqual(files.html1, files.html2).must.be.true();
     });
 
     it('must sort classes', function () {
         var htmlDiffer = new HtmlDiffer(),
-
             files = readFiles('4.html', '_4.html');
 
         htmlDiffer.isEqual(files.html1, files.html2).must.be.true();
     });
 
     it('must sort attrs', function () {
         var htmlDiffer = new HtmlDiffer(),
-
             files = readFiles('5.html', '_5.html');
 
         htmlDiffer.isEqual(files.html1, files.html2).must.be.true();
     });
 
     it('must sort content of attrs', function () {
         var htmlDiffer = new HtmlDiffer({ compareHtmlAttrsAsJSON: [ 'a', 'b' ] }),
-
             files = readFiles('6.html', '_6.html');
 
         htmlDiffer.isEqual(files.html1, files.html2).must.be.true();
     });
 
     it('must ignore space characters', function () {
-        var htmlDiffer = new HtmlDiffer({ ignoreWhitespace: true }),
-
+        var htmlDiffer = new HtmlDiffer({ ignoreWhitespaces: true }),
             files = readFiles('7.html', '_7.html');
 
         htmlDiffer.isEqual(files.html1, files.html2).must.be.true();
     });
 
     it('must sort \'onclick\' and \'ondblclick\' attrs content', function () {
         var htmlDiffer = new HtmlDiffer({ compareHtmlAttrsAsJSON: [ 'onclick', 'ondblclick' ] }),
-
             files = readFiles('8.html', '_8.html');
 
         htmlDiffer.isEqual(files.html1, files.html2).must.be.true();
     });
 
     it('must work \'bem\' option', function() {
         var htmlDiffer = new HtmlDiffer({ bem: true }),
-
             files = readFiles('9.html', '_9.html');
 
         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();