eslint 0.5.0 → 0.6.2

package/lib/eslint.js

@@ -150,14 +150,78 @@ function addDeclaredGlobals(program, globalScope, config) {
     });
 }
 
+/**
+ * Add data to reporting configuration to disable reporting for list of rules
+ * starting from start location
+ * @param  {Object[]} reportingConfig Current reporting configuration
+ * @param  {Object} start Position to start
+ * @param  {string[]} rules List of rules
+ * @returns {void}
+ */
+function disableReporting(reportingConfig, start, rules) {
+
+    if (rules.length) {
+        rules.forEach(function(rule){
+            reportingConfig.push({
+                start: start,
+                end: null,
+                rule: rule
+            });
+        });
+    } else {
+        reportingConfig.push({
+            start: start,
+            end: null,
+            rule: null
+        });
+    }
+}
+
+/**
+ * Add data to reporting configuration to enable reporting for list of rules
+ * starting from start location
+ * @param  {Object[]} reportingConfig Current reporting configuration
+ * @param  {Object} start Position to start
+ * @param  {string[]} rules List of rules
+ * @returns {void}
+ */
+function enableReporting(reportingConfig, start, rules) {
+    if (rules.length) {
+        rules.forEach(function(rule){
+            for (var i = reportingConfig.length - 1; i >= 0; i--) {
+                if (!reportingConfig[i].end && reportingConfig[i].rule === rule ) {
+                    reportingConfig[i].end = start;
+                    break;
+                }
+            }
+        });
+    } else {
+        // find all previous disabled locations if they was started as list of rules
+        var prevStart;
+        for (var i = reportingConfig.length - 1; i >= 0; i--) {
+            if (prevStart && prevStart !== reportingConfig[i].start) {
+                break;
+            }
+
+            if (!reportingConfig[i].end) {
+                reportingConfig[i].end = start;
+                prevStart = reportingConfig[i].start;
+            }
+        }
+    }
+}
+
+
 /**
  * Parses comments in file to extract file-specific config of rules, globals
- * and environments and merges them with global config.
+ * and environments and merges them with global config; also code blocks
+ * where reporting is disabled or enabled and merges them with reporting config.
  * @param {ASTNode} ast The top node of the AST.
  * @param {Object} config The existing configuration data.
- * @returns {Object} Merged config
+ * @param {Object[]} reportingConfig The existing reporting configuration data.
+ * @returns {void}
  */
-function modifyConfigFromComments(ast, config) {
+function modifyConfigsFromComments(ast, config, reportingConfig) {
 
     var commentConfig = {
         globals: {},
@@ -170,7 +234,7 @@ function modifyConfigFromComments(ast, config) {
         if (comment.type === "Block") {
 
             var value = comment.value.trim();
-            var match = /^(eslint-env|eslint|globals?)\s/.exec(value);
+            var match = /^(eslint-\w+|eslint|globals?)(\s|$)/.exec(value);
 
             if (match) {
                 value = value.substring(match.index + match[1].length);
@@ -185,6 +249,14 @@ function modifyConfigFromComments(ast, config) {
                         util.mixin(commentConfig.env, parseListConfig(value));
                         break;
 
+                    case "eslint-disable":
+                        disableReporting(reportingConfig, comment.loc.start, Object.keys(parseListConfig(value)));
+                        break;
+
+                    case "eslint-enable":
+                        enableReporting(reportingConfig, comment.loc.start, Object.keys(parseListConfig(value)));
+                        break;
+
                     case "eslint":
                         var items = parseJsonConfig(value);
                         Object.keys(items).forEach(function(name) {
@@ -210,7 +282,58 @@ function modifyConfigFromComments(ast, config) {
     });
     util.mixin(commentConfig.rules, commentRules);
 
-    return util.mergeConfigs(config, commentConfig);
+    util.mergeConfigs(config, commentConfig);
+}
+
+/**
+ * Check if message of rule with ruleId should be ignored in location
+ * @param  {Object[]} reportingConfig  Collection of ignore records
+ * @param  {string} ruleId   Id of rule
+ * @param  {Object} location Location of message
+ * @returns {boolean}          True if message should be ignored, false otherwise
+ */
+function isDisabledByReportingConfig(reportingConfig, ruleId, location) {
+
+    for (var i = 0, c = reportingConfig.length; i < c; i++) {
+
+        var ignore = reportingConfig[i];
+        if ((!ignore.rule || ignore.rule === ruleId) &&
+            (location.line > ignore.start.line || (location.line === ignore.start.line && location.column >= ignore.start.column)) &&
+            (!ignore.end || (location.line < ignore.end.line || (location.line === ignore.end.line && location.column <= ignore.end.column)))) {
+                return true;
+        }
+    }
+
+    return false;
+}
+
+/**
+ * Process initial config to make it safe to extend by file comment config
+ * @param  {Object} config Initial config
+ * @returns {Object}        Processed config
+ */
+function prepareConfig(config) {
+
+    config.globals = config.globals || config.global || {};
+    delete config.global;
+
+    var copiedRules = {};
+    if (typeof config.rules === "object") {
+        Object.keys(config.rules).forEach(function(k){
+            var rule = config.rules[k];
+            if (Array.isArray(rule)) {
+                copiedRules[k] = rule.slice();
+            } else {
+                copiedRules[k] = rule;
+            }
+        });
+    }
+
+    return {
+        rules: copiedRules,
+        globals: util.mergeConfigs({}, config.globals),
+        env: util.mergeConfigs({}, config.env || {})
+    };
 }
 
 //------------------------------------------------------------------------------
@@ -225,14 +348,15 @@ module.exports = (function() {
 
     var api = Object.create(new EventEmitter()),
         messages = [],
-        commentsAttached = false,
         currentText = null,
         currentConfig = null,
         currentTokens = null,
         currentScopes = null,
         currentFilename = null,
-        controller = null;
-
+        controller = null,
+        reportingConfig = [],
+        commentLocsEnter = [],
+        commentLocsExit = [];
 
     /**
      * Parses text into an AST. Moved out here because the try-catch prevents
@@ -250,7 +374,14 @@ module.exports = (function() {
          * problem that ESLint identified just like any other.
          */
         try {
-            return esprima.parse(text, { loc: true, range: true, raw: true, tokens: true, comment: true });
+            return esprima.parse(text, {
+                loc: true,
+                range: true,
+                raw: true,
+                tokens: true,
+                comment: true,
+                attachComment: true
+            });
         } catch (ex) {
 
             messages.push({
@@ -267,6 +398,46 @@ module.exports = (function() {
         }
     }
 
+    /**
+     * Check collection of comments to prevent double event for comment as
+     * leading and trailing, then emit event if passing
+     * @param {ASTNode[]} comments Collection of comment nodes
+     * @param {Object[]} locs List of locations of previous comment nodes
+     * @param {string} eventName Event name postfix
+     * @returns {void}
+     */
+    function emitComments(comments, locs, eventName) {
+
+        if (comments.length) {
+            comments.forEach(function(node) {
+                if (locs.indexOf(node.loc) >= 0) {
+                    locs.splice(locs.indexOf(node.loc), 1);
+                } else {
+                    locs.push(node.loc);
+                    api.emit(node.type + eventName, node);
+                }
+            });
+        }
+    }
+
+    /**
+     * Shortcut to check and emit enter of comment nodes
+     * @param {ASTNode[]} comments Collection of comment nodes
+     * @returns {void}
+     */
+    function emitCommentsEnter(comments) {
+        emitComments(comments, commentLocsEnter, "Comment");
+    }
+
+    /**
+     * Shortcut to check and emit exit of comment nodes
+     * @param {ASTNode[]} comments Collection of comment nodes
+     * @returns {void}
+     */
+    function emitCommentsExit(comments) {
+        emitComments(comments, commentLocsExit, "Comment:exit");
+    }
+
     // set unlimited listeners (see https://github.com/eslint/eslint/issues/524)
     api.setMaxListeners(0);
 
@@ -277,12 +448,14 @@ module.exports = (function() {
     api.reset = function() {
         this.removeAllListeners();
         messages = [];
-        commentsAttached = false;
         currentConfig = null;
         currentText = null;
         currentTokens = null;
         currentScopes = null;
         controller = null;
+        reportingConfig = [];
+        commentLocsEnter = [];
+        commentLocsExit = [];
     };
 
     /**
@@ -310,12 +483,11 @@ module.exports = (function() {
 
         //if Esprima failed to parse the file, there's no sense in setting up rules
         if (ast) {
-
-            config.globals = config.globals || config.global || {};
-            delete config.global;
+            // process initial config to make it safe to extend
+            config = prepareConfig(config);
 
             // parse global comments and modify config
-            config = modifyConfigFromComments(ast, config);
+            modifyConfigsFromComments(ast, config, reportingConfig);
 
             // enable appropriate rules
             Object.keys(config.rules).filter(function(key) {
@@ -383,46 +555,21 @@ module.exports = (function() {
              */
             controller.traverse(ast, {
                 enter: function(node, parent) {
-                    var comments = api.getComments(node),
-                        leadingComments = comments.leading,
-                        trailingComments = comments.trailing;
 
-                    if (leadingComments.length) {
-                        leadingComments.forEach(function(node) {
-                            api.emit(node.type + "Comment", node);
-                        });
-                    }
+                    var comments = api.getComments(node);
 
+                    emitCommentsEnter(comments.leading);
                     node.parent = parent;
-
                     api.emit(node.type, node);
-
-                    if (trailingComments.length) {
-                        trailingComments.forEach(function(node) {
-                            api.emit(node.type + "Comment", node);
-                        });
-                    }
-
+                    emitCommentsEnter(comments.trailing);
                 },
                 leave: function(node) {
 
-                    var comments = api.getComments(node),
-                        leadingComments = comments.leading,
-                        trailingComments = comments.trailing;
-
-                    if (trailingComments.length) {
-                        trailingComments.forEach(function(node) {
-                            api.emit(node.type + "Comment:exit", node);
-                        });
-                    }
+                    var comments = api.getComments(node);
 
+                    emitCommentsExit(comments.trailing);
                     api.emit(node.type + ":exit", node);
-
-                    if (leadingComments.length) {
-                        leadingComments.forEach(function(node) {
-                            api.emit(node.type + "Comment:exit", node);
-                        });
-                    }
+                    emitCommentsExit(comments.leading);
                 }
             });
 
@@ -456,6 +603,10 @@ module.exports = (function() {
             message = message.replace(rx, opts[key]);
         });
 
+        if (isDisabledByReportingConfig(reportingConfig, ruleId, location)) {
+            return;
+        }
+
         messages.push({
             ruleId: ruleId,
             node: node,
@@ -489,17 +640,24 @@ module.exports = (function() {
      * @returns {Object} The list of comments indexed by their position.
      */
     api.getComments = function(node) {
-        var ast = controller.root;
 
-        if (!commentsAttached) {
-            // Attaching comments is a potentially expensive operation, so we do this lazily.
-            estraverse.attachComments(ast, ast.comments, ast.tokens);
-            commentsAttached = true;
+        var leadingComments = node.leadingComments || [],
+            trailingComments = node.trailingComments || [];
+
+        /*
+         * Esprima adds a "comments" array on Program nodes rather than
+         * leadingComments/trailingComments. Comments are only left in the
+         * Program node comments array if there is no executable code.
+         */
+        if (node.type === "Program") {
+            if (node.body.length === 0) {
+                leadingComments = node.comments;
+            }
         }
 
         return {
-            leading: node.leadingComments || [],
-            trailing: node.trailingComments || []
+            leading: leadingComments,
+            trailing: trailingComments
         };
     };
 
@@ -538,12 +696,9 @@ module.exports = (function() {
             return null;
         }
 
-        switch(node.type) {
+        switch (node.type) {
             case "FunctionDeclaration":
-
-                // first global function has its comments stolen by Program
-                var nodeToCheck = (node.leadingComments ? node : parent);
-                return findJSDocComment(nodeToCheck.leadingComments);
+                return findJSDocComment(node.leadingComments);
 
             case "FunctionExpression":
 
@@ -552,7 +707,7 @@ module.exports = (function() {
                         parent = parent.parent;
                     }
 
-                    return parent ? findJSDocComment(parent.leadingComments) : null;
+                    return parent && (parent.type !== "FunctionDeclaration") ? findJSDocComment(parent.leadingComments) : null;
                 }
 
                 // falls through
@@ -571,7 +726,7 @@ module.exports = (function() {
     api.getTokensBefore = function(node, beforeCount) {
         var beforeTokens = [], cursor = node.range[0] - 1;
         while (beforeCount > 0 && cursor >= 0) {
-            if(currentTokens[cursor]) {
+            if (currentTokens[cursor]) {
                 beforeTokens.unshift(currentTokens[cursor]);
                 --beforeCount;
             }
@@ -607,7 +762,7 @@ module.exports = (function() {
     api.getTokensAfter = function(node, afterCount) {
         var afterTokens = [], cursor = node.range[1];
         while (afterCount > 0 && cursor < currentTokens.length) {
-            if(currentTokens[cursor]) {
+            if (currentTokens[cursor]) {
                 afterTokens.push(currentTokens[cursor]);
                 --afterCount;
                 cursor = currentTokens[cursor].range[1];
@@ -649,7 +804,7 @@ module.exports = (function() {
             tokens = [],
             cursor = node.range[0];
         while (cursor < node.range[1]) {
-            if(currentTokens[cursor]) {
+            if (currentTokens[cursor]) {
                 tokens.push(currentTokens[cursor]);
                 cursor = currentTokens[cursor].range[1];
             } else {
@@ -668,7 +823,7 @@ module.exports = (function() {
     api.getFirstTokens = function(node, count) {
         var tokens = [], cursor = node.range[0];
         while (count > 0 && cursor < node.range[1]) {
-            if(currentTokens[cursor]) {
+            if (currentTokens[cursor]) {
                 tokens.push(currentTokens[cursor]);
                 --count;
                 cursor = currentTokens[cursor].range[1];
@@ -706,7 +861,7 @@ module.exports = (function() {
     api.getLastTokens = function(node, count) {
         var tokens = [], cursor = node.range[1] - 1;
         while (count > 0 && cursor >= node.range[0]) {
-            if(currentTokens[cursor]) {
+            if (currentTokens[cursor]) {
                 tokens.unshift(currentTokens[cursor]);
                 --count;
             }

package/lib/formatters/checkstyle.js

@@ -9,15 +9,12 @@
 //------------------------------------------------------------------------------
 
 function getMessageType(message, rules) {
-
-    // TODO: Get rule severity in a better way
-    var severity = null;
-
     if (message.fatal) {
         return "error";
     }
 
-    severity = rules[message.ruleId][0] || rules[message.ruleId];
+    var rule = rules[message.ruleId],
+        severity = rule && (rule[0] || rule);
 
     if (severity === 2) {
         return "error";
@@ -28,7 +25,7 @@ function getMessageType(message, rules) {
 
 function xmlEscape(s) {
     return ("" + s).replace(/[<>&"']/g, function(c) {
-        switch(c) {
+        switch (c) {
             case "<":
                 return "&lt;";
             case ">":
@@ -39,6 +36,7 @@ function xmlEscape(s) {
                 return "&quot;";
             case "'":
                 return "&apos;";
+            // no default
         }
     });
 }

package/lib/formatters/compact.js

@@ -9,15 +9,12 @@
 //------------------------------------------------------------------------------
 
 function getMessageType(message, rules) {
-
-    // TODO: Get rule severity in a better way
-    var severity = null;
-
     if (message.fatal) {
         return "Error";
     }
 
-    severity = rules[message.ruleId][0] || rules[message.ruleId];
+    var rule = rules[message.ruleId],
+        severity = rule && (rule[0] || rule);
 
     if (severity === 2) {
         return "Error";

package/lib/formatters/junit.js

@@ -11,15 +11,12 @@
 //------------------------------------------------------------------------------
 
 function getMessageType(message, rules) {
-
-    // TODO: Get rule severity in a better way
-    var severity = null;
-
     if (message.fatal) {
         return "Error";
     }
 
-    severity = rules[message.ruleId][0] || rules[message.ruleId];
+    var rule = rules[message.ruleId],
+        severity = rule && (rule[0] || rule);
 
     if (severity === 2) {
         return "Error";

package/lib/formatters/stylish.js

@@ -16,7 +16,8 @@ function getMessageType(message, rules) {
         return chalk.red("error");
     }
 
-    var severity = rules[message.ruleId][0] || rules[message.ruleId];
+    var rule = rules[message.ruleId],
+        severity = rule && (rule[0] || rule);
 
     if (severity === 2) {
         return chalk.red("error");

package/lib/formatters/tap.js

@@ -20,15 +20,12 @@ var yaml = require("js-yaml");
  * @returns {String} Error level string
  */
 function getMessageType(message, rules) {
-
-    // TODO: Get rule severity in a better way
-    var severity = null;
-
     if (message.fatal) {
         return "error";
     }
 
-    severity = rules[message.ruleId][0] || rules[message.ruleId];
+    var rule = rules[message.ruleId],
+        severity = rule && (rule[0] || rule);
 
     if (severity === 2) {
         return "error";
@@ -94,7 +91,7 @@ module.exports = function(results, config) {
 
         output += testResult + " " + (id + 1) + " - " + result.filePath + "\n";
 
-        // If we have an error include diagnostics 
+        // If we have an error include diagnostics
         if (messages.length > 0) {
             output += outputDiagnostics(diagnostics);
         }

package/lib/load-rules.js

@@ -30,7 +30,9 @@ module.exports = function(rulesDir) {
 
     var rules = Object.create(null);
     fs.readdirSync(rulesDir).forEach(function(file) {
-        if (path.extname(file) !== ".js") { return; }
+        if (path.extname(file) !== ".js") {
+            return;
+        }
         rules[file.slice(0, -3)] = require(path.join(rulesDir, file));
     });
     return rules;

package/lib/options.js

@@ -16,51 +16,60 @@ var optionator = require("optionator");
 
 // exports "parse(args)", "generateHelp()", and "generateHelpForOption(optionName)"
 module.exports = optionator({
-  prepend: "eslint [options] file.js [file.js] [dir]",
-  concatRepeatedArrays: true,
-  options: [{
-    heading: "Options"
-  }, {
-    option: "help",
-    alias: "h",
-    type: "Boolean",
-    description: "Show help."
-  }, {
-    option: "config",
-    alias: "c",
-    type: "path::String",
-    description: "Load configuration data from this file."
-  }, {
-    option: "rulesdir",
-    type: "path::String",
-    description: "Load additional rules from this directory."
-  }, {
-    option: "format",
-    alias: "f",
-    type: "String",
-    default: "stylish",
-    description: "Use a specific output format."
-  }, {
-    option: "version",
-    alias: "v",
-    type: "Boolean",
-    description: "Outputs the version number."
-  }, {
-    option: "reset",
-    type: "Boolean",
-    description: "Set all default rules to off."
-  }, {
-    option: "eslintrc",
-    type: "Boolean",
-    default: "true",
-    description: "Enable loading .eslintrc configuration."
-  }, {
-    option: "env",
-    type: "[String]",
-    description: "Specify environments."
-  }, {
-    option: "global",
-    type: "[String]",
-    description: "Define global variables."
-  }]
+    prepend: "eslint [options] file.js [file.js] [dir]",
+    concatRepeatedArrays: true,
+    mergeRepeatedObjects: true,
+    options: [{
+        heading: "Options"
+    }, {
+        option: "help",
+        alias: "h",
+        type: "Boolean",
+        description: "Show help."
+    }, {
+        option: "config",
+        alias: "c",
+        type: "path::String",
+        description: "Load configuration data from this file."
+    }, {
+        option: "rulesdir",
+        type: "[path::String]",
+        description: "Load additional rules from this directory."
+    }, {
+        option: "format",
+        alias: "f",
+        type: "String",
+        default: "stylish",
+        description: "Use a specific output format."
+    }, {
+        option: "version",
+        alias: "v",
+        type: "Boolean",
+        description: "Outputs the version number."
+    }, {
+        option: "reset",
+        type: "Boolean",
+        description: "Set all default rules to off."
+    }, {
+        option: "eslintrc",
+        type: "Boolean",
+        default: "true",
+        description: "Enable loading .eslintrc configuration."
+    }, {
+        option: "env",
+        type: "[String]",
+        description: "Specify environments."
+    }, {
+        option: "force",
+        type: "Boolean",
+        description: "Allow linting of otherwise ignored files."
+    }, {
+        option: "global",
+        type: "[String]",
+        description: "Define global variables."
+    },{
+        option: "rule",
+        type: "Object",
+        description: "Specify rules."
+    }]
 });