Merge pull request #80 from bem/lint

Added lints

Author: eGavr

.editorconfig

@@ -11,3 +11,6 @@ insert_final_newline = true
 
 [*.md]
 trim_trailing_whitespace = false
+
+[package.json]
+indent_size = 2

.jscs.js

@@ -0,0 +1,58 @@
+module.exports = {
+    excludeFiles: [
+        'node_modules/**',
+        'coverage/**'
+    ],
+    requireSpaceAfterKeywords: ['if', 'else', 'for', 'while', 'do', 'switch', 'return', 'try', 'catch'],
+    requireSpaceBeforeBlockStatements: true,
+    requireSpacesInConditionalExpression: true,
+    requireSpacesInFunction: {
+        beforeOpeningCurlyBrace: true
+    },
+    requireSpacesInAnonymousFunctionExpression: {
+        beforeOpeningRoundBrace: true
+    },
+    disallowSpacesInNamedFunctionExpression: {
+        beforeOpeningRoundBrace: true
+    },
+    requireMultipleVarDecl: true,
+    requireBlocksOnNewline: 1,
+    disallowPaddingNewlinesInBlocks: true,
+    disallowSpacesInsideArrayBrackets: 'nested',
+    disallowSpacesInsideParentheses: true,
+    requireSpacesInsideObjectBrackets: 'all',
+    disallowQuotedKeysInObjects: 'allButReserved',
+    disallowDanglingUnderscores: true,
+    disallowSpaceAfterObjectKeys: true,
+    requireCommaBeforeLineBreak: true,
+    requireOperatorBeforeLineBreak: true,
+    disallowSpaceAfterPrefixUnaryOperators: true,
+    disallowSpaceBeforePostfixUnaryOperators: true,
+    requireSpaceBeforeBinaryOperators: true,
+    requireSpaceAfterBinaryOperators: true,
+    requireCamelCaseOrUpperCaseIdentifiers: true,
+    disallowKeywords: ['with'],
+    disallowMultipleLineStrings: true,
+    disallowMultipleLineBreaks: true,
+    validateLineBreaks: 'LF',
+    validateQuoteMarks: {
+        mark: '\'',
+        escape: true
+    },
+    validateIndentation: 4,
+    disallowMixedSpacesAndTabs: true,
+    disallowTrailingWhitespace: true,
+    disallowKeywordsOnNewLine: ['else', 'catch'],
+    requireLineFeedAtFileEnd: true,
+    maximumLineLength: 120,
+    requireCapitalizedConstructors: true,
+    safeContextKeyword: ['_this'],
+    disallowYodaConditions: true,
+    validateJSDoc: {
+        checkParamNames: true,
+        checkRedundantParams: true,
+        requireParamTypes: true
+    },
+    requireSpaceAfterLineComment: true,
+    disallowNewlineBeforeBlockStatements: true
+};

.jshintignore

@@ -0,0 +1,2 @@
+node_modules
+coverage

.jshintrc

@@ -1,21 +1,26 @@
 {
-    "node": true,
-    "esnext": true,
     "bitwise": true,
-    "camelcase": true,
     "curly": true,
     "eqeqeq": true,
+    "es3": true,
+    "forin": true,
+    "freeze": true,
     "immed": true,
-    "indent": 4,
     "latedef": true,
-    "newcap": true,
     "noarg": true,
-    "quotmark": "single",
-    "regexp": true,
+    "noempty": true,
+    "nonbsp": true,
+    "nonew": true,
     "undef": true,
     "unused": true,
-    "strict": true,
-    "trailing": true,
-    "smarttabs": true,
-    "white": true
+
+    "browser": true,
+    "node": true,
+
+    "globals": {
+        "modules": false
+    },
+
+    "expr": true,
+    "sub": true
 }

.travis.yml

@@ -2,7 +2,6 @@ language: node_js
 
 node_js:
   - "0.10"
-  - "0.8"
 
 env:
   global:

lib/cli.js

@@ -12,10 +12,11 @@ module.exports = require('coa').Cmd()
     .opt()
         .name('version')
         .title('Shows the version number')
+        /*jshint -W024 */
         .short('v').long('version')
         .flag()
         .only()
-        .act(function() {
+        .act(function () {
             var p = require('../package.json');
             return p.name + ' ' + p.version;
         })
@@ -30,7 +31,8 @@ module.exports = require('coa').Cmd()
         .title('The number of characters around the diff (default: 40)')
         .long('chars-around-diff')
         .def(40)
-        .val(function(val) {
+        .val(function (val) {
+            /*jshint es3:false */
             return parseInt(val);
         })
         .end()
@@ -44,21 +46,21 @@ module.exports = require('coa').Cmd()
         .title('Path to the 2-nd HTML file')
         .req()
         .end()
-    .act(function(opts, args) {
+    .act(function (opts, args) {
         return vow.all([
-                vfs.read(path.resolve(args.path1), 'utf-8'),
-                vfs.read(path.resolve(args.path2), 'utf-8'),
-                opts.config ? vfs.read(path.resolve(opts.config)) : undefined
-            ]).spread(function (html1, html2, config) {
-                config = config ? JSON.parse(config) : {};
+            vfs.read(path.resolve(args.path1), 'utf-8'),
+            vfs.read(path.resolve(args.path2), 'utf-8'),
+            opts.config ? vfs.read(path.resolve(opts.config)) : undefined
+        ]).spread(function (html1, html2, config) {
+            config = config ? JSON.parse(config) : {};
 
-                var options = utils.defaults(config),
-                    loggerOptions = {
-                        charsAroundDiff: opts.charsAroundDiff
-                    },
-                    htmlDiffer = new HtmlDiffer(options);
+            var options = utils.defaults(config),
+                loggerOptions = {
+                    charsAroundDiff: opts.charsAroundDiff
+                },
+                htmlDiffer = new HtmlDiffer(options);
 
-                diffLogger.log(htmlDiffer.diffHtml(html1, html2), loggerOptions);
-            });
+            diffLogger.log(htmlDiffer.diffHtml(html1, html2), loggerOptions);
+        });
     })
     .run(process.argv.slice(2));

lib/diff-logger.js

@@ -24,15 +24,15 @@ function getDiffText(diff, options) {
         charsAroundDiff = 40;
     }
 
-    if (diff.length === 1 && !diff[0].added && !diff[0].removed) return output;
+    if (diff.length === 1 && !diff[0].added && !diff[0].removed) { return output; }
 
-    diff.forEach(function(part) {
+    diff.forEach(function (part) {
         var index = diff.indexOf(part),
             partValue = part.value,
             color = 'grey';
 
-        if (part.added) color = 'green';
-        if (part.removed) color = 'red';
+        if (part.added) { color = 'green'; }
+        if (part.removed) { color = 'red'; }
 
         if (color !== 'grey') {
             output += (!index ? '\n' : '') + partValue.inverse[color];

lib/index.js

@@ -8,15 +8,14 @@ var utils = require('./utils'),
 /**
  * Converts the HTML document to the AST Tree
  * @param {String} HTMLDoc
- * @param {Object} options
  * @returns {AST}
  */
 function htmlToAST(HTMLDoc) {
     var parser,
         parserHandler;
 
-    parserHandler = new htmlParser.DomHandler(function(err) {
-        if (err) console.log(err);
+    parserHandler = new htmlParser.DomHandler(function (err) {
+        if (err) { console.log(err); }
     });
 
     parser = new htmlParser.Parser(parserHandler);
@@ -34,9 +33,8 @@ function htmlToAST(HTMLDoc) {
 function modifyASTTree(tree, options) {
     var delComments = [];
 
-    _.forEach(tree, function(node) {
+    _.forEach(tree, function (node) {
         if (options.ignoreWhitespaces && node.type === 'text') {
-
             node.data = node.data
                 .replace(/(\n|\r|\t|\v|\f)+/g, '')
                 .replace(/\s+/g, ' ')
@@ -52,31 +50,30 @@ function modifyASTTree(tree, options) {
         }
 
         if (node.hasOwnProperty('attribs')) {
-            var attrs = utils.sortObj(node['attribs']);
+            var attrs = utils.sortObj(node.attribs);
 
             if (attrs.hasOwnProperty('class')) {
                 attrs['class'] = utils.sortCssClasses(attrs['class']);
             }
 
-            _.forEach(options.compareHtmlAttrsAsJSON, function(attr) {
+            _.forEach(options.compareHtmlAttrsAsJSON, function (attr) {
                 var attrValue,
                     isFunction = (attr === 'onclick' || attr === 'ondblclick'); // @FIXME: should be configurable
 
                 if (attrs.hasOwnProperty(attr)) {
-
                     attrValue = utils.parseAttr(attrs[attr].replace(/"/g, '"'), isFunction);
                     attrValue = utils.sortObj(attrValue);
                     attrValue = JSON.stringify(attrValue);
 
-                    attrs[attr] = (isFunction ? 'return ' : '') + attrValue.replace(/"/g, '"')
+                    attrs[attr] = (isFunction ? 'return ' : '') + attrValue.replace(/"/g, '"');
                 }
             });
 
-            _.forEach(options.ignoreHtmlAttrs, function(attr) {
+            _.forEach(options.ignoreHtmlAttrs, function (attr) {
                 attrs.hasOwnProperty(attr) && (attrs[attr] = '');
             });
 
-            node['attribs'] = attrs;
+            node.attribs = attrs;
         }
 
         if (node.hasOwnProperty('children')) {
@@ -93,19 +90,18 @@ function modifyASTTree(tree, options) {
 
 /**
  *
- * @param [options]
+ * @param {Object} [options]
  * @param {String[]} [options.ignoreHtmlAttrs]
  * @param {String[]} [options.compareHtmlAttrsAsJSON]
  * @param {Boolean} [options.verbose]
  * @param {Boolean} [options.ignoreWhitespaces=true]
  * @param {Boolean} [options.bem=false]
  * @constructor
  */
-var HtmlDiff = function(options) {
+var HtmlDiff = function (options) {
     this.options = utils.defaults(options);
-};
-
-var Diff = diff.Diff;
+},
+Diff = diff.Diff;
 
 HtmlDiff.prototype = Diff.prototype;
 
@@ -114,7 +110,7 @@ HtmlDiff.prototype = Diff.prototype;
  * @param {String} value
  * @returns {Array}
  */
-HtmlDiff.prototype.tokenize = function(value) {
+HtmlDiff.prototype.tokenize = function (value) {
     var options = this.options,
         ASTTree = htmlToAST(value, options);
 
@@ -132,18 +128,18 @@ HtmlDiff.prototype.tokenize = function(value) {
 
 /**
  *
- * @param [options]
+ * @param {Object} [options]
  * @param {String[]} [options.ignoreHtmlAttrs]
  * @param {String[]} [options.compareHtmlAttrsAsJSON]
  * @param {Boolean} [options.verbose]
  * @param {Boolean} [options.ignoreWhitespaces=true]
  * @param {Boolean} [options.bem=false]
  * @constructor
  */
-var HtmlDiffer = function(options) {
+var HtmlDiffer = function (options) {
     options = utils.defaults(options);
 
-    if (options['bem']) {
+    if (options.bem) {
         options.ignoreHtmlAttrs = ['id', 'for'];
         options.compareHtmlAttrsAsJSON = ['data-bem', 'onclick', 'ondblclick'];
     }
@@ -158,7 +154,7 @@ var HtmlDiffer = function(options) {
  * @param {Object} [options]
  * @returns {Diff}
  */
-HtmlDiffer.prototype.diffHtml = function(html1, html2, options) {
+HtmlDiffer.prototype.diffHtml = function (html1, html2, options) {
     if (options) {
         console.warn('WARNING! The third param of \'diffHtml\' method is deprecated!'.bold.red);
     }
@@ -177,7 +173,7 @@ HtmlDiffer.prototype.diffHtml = function(html1, html2, options) {
  * @param {Object} [options]
  * @returns {Boolean}
  */
-HtmlDiffer.prototype.isEqual = function(html1, html2, options) {
+HtmlDiffer.prototype.isEqual = function (html1, html2, options) {
     if (options) {
         console.warn('WARNING! The third param of \'isEqual\' method is deprecated!'.bold.red);
     }
@@ -211,7 +207,6 @@ function bemDiff(html1, html2) {
     logger.log(htmlDiffer.diff(html1, html2), loggerOptions);
 }
 
-
 var htmlDiffer = new HtmlDiffer();
 
 module.exports = {