eslint 2.11.0 → 2.13.1

package/lib/rules/no-mixed-operators.js

@@ -0,0 +1,212 @@
+/**
+ * @fileoverview Rule to disallow mixed binary operators.
+ * @author Toru Nagashima
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+var astUtils = require("../ast-utils.js");
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+var ARITHMETIC_OPERATORS = ["+", "-", "*", "/", "%", "**"];
+var BITWISE_OPERATORS = ["&", "|", "^", "~", "<<", ">>", ">>>"];
+var COMPARISON_OPERATORS = ["==", "!=", "===", "!==", ">", ">=", "<", "<="];
+var LOGICAL_OPERATORS = ["&&", "||"];
+var RELATIONAL_OPERATORS = ["in", "instanceof"];
+var ALL_OPERATORS = [].concat(
+    ARITHMETIC_OPERATORS,
+    BITWISE_OPERATORS,
+    COMPARISON_OPERATORS,
+    LOGICAL_OPERATORS,
+    RELATIONAL_OPERATORS
+);
+var DEFAULT_GROUPS = [
+    ARITHMETIC_OPERATORS,
+    BITWISE_OPERATORS,
+    COMPARISON_OPERATORS,
+    LOGICAL_OPERATORS,
+    RELATIONAL_OPERATORS
+];
+var TARGET_NODE_TYPE = /^(?:Binary|Logical)Expression$/;
+
+/**
+ * Normalizes options.
+ *
+ * @param {object|undefined} options - A options object to normalize.
+ * @returns {object} Normalized option object.
+ */
+function normalizeOptions(options) {
+    var hasGroups = (options && options.groups && options.groups.length > 0);
+    var groups = hasGroups ? options.groups : DEFAULT_GROUPS;
+    var allowSamePrecedence = (options && options.allowSamePrecedence) !== false;
+
+    return {
+        groups: groups,
+        allowSamePrecedence: allowSamePrecedence
+    };
+}
+
+/**
+ * Checks whether any group which includes both given operator exists or not.
+ *
+ * @param {Array.<string[]>} groups - A list of groups to check.
+ * @param {string} left - An operator.
+ * @param {string} right - Another operator.
+ * @returns {boolean} `true` if such group existed.
+ */
+function includesBothInAGroup(groups, left, right) {
+    return groups.some(function(group) {
+        return group.indexOf(left) !== -1 && group.indexOf(right) !== -1;
+    });
+}
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+module.exports = {
+    meta: {
+        docs: {
+            description: "disallow mixed binary operators",
+            category: "Stylistic Issues",
+            recommended: false
+        },
+        schema: [
+            {
+                type: "object",
+                properties: {
+                    groups: {
+                        type: "array",
+                        items: {
+                            type: "array",
+                            items: {enum: ALL_OPERATORS},
+                            minItems: 2,
+                            uniqueItems: true
+                        },
+                        uniqueItems: true
+                    },
+                    allowSamePrecedence: {
+                        type: "boolean"
+                    }
+                },
+                additionalProperties: false
+            }
+        ]
+    },
+
+    create: function(context) {
+        var sourceCode = context.getSourceCode();
+        var options = normalizeOptions(context.options[0]);
+
+        /**
+         * Checks whether a given node should be ignored by options or not.
+         *
+         * @param {ASTNode} node - A node to check. This is a BinaryExpression
+         *      node or a LogicalExpression node. This parent node is one of
+         *      them, too.
+         * @returns {boolean} `true` if the node should be ignored.
+         */
+        function shouldIgnore(node) {
+            var a = node;
+            var b = node.parent;
+
+            return (
+                !includesBothInAGroup(options.groups, a.operator, b.operator) ||
+                (
+                    options.allowSamePrecedence &&
+                    astUtils.getPrecedence(a) === astUtils.getPrecedence(b)
+                )
+            );
+        }
+
+        /**
+         * Checks whether the operator of a given node is mixed with parent
+         * node's operator or not.
+         *
+         * @param {ASTNode} node - A node to check. This is a BinaryExpression
+         *      node or a LogicalExpression node. This parent node is one of
+         *      them, too.
+         * @returns {boolean} `true` if the node was mixed.
+         */
+        function isMixedWithParent(node) {
+            return (
+                node.operator !== node.parent.operator &&
+                !astUtils.isParenthesised(sourceCode, node)
+            );
+        }
+
+        /**
+         * Gets the operator token of a given node.
+         *
+         * @param {ASTNode} node - A node to check. This is a BinaryExpression
+         *      node or a LogicalExpression node.
+         * @returns {Token} The operator token of the node.
+         */
+        function getOperatorToken(node) {
+            var token = sourceCode.getTokenAfter(node.left);
+
+            while (token.value === ")") {
+                token = sourceCode.getTokenAfter(token);
+            }
+
+            return token;
+        }
+
+        /**
+         * Reports both the operator of a given node and the operator of the
+         * parent node.
+         *
+         * @param {ASTNode} node - A node to check. This is a BinaryExpression
+         *      node or a LogicalExpression node. This parent node is one of
+         *      them, too.
+         * @returns {void}
+         */
+        function reportBothOperators(node) {
+            var parent = node.parent;
+            var left = (parent.left === node) ? node : parent;
+            var right = (parent.left !== node) ? node : parent;
+            var message =
+                "Unexpected mix of '" + left.operator + "' and '" +
+                right.operator + "'.";
+
+            context.report({
+                node: left,
+                loc: getOperatorToken(left).loc.start,
+                message: message
+            });
+            context.report({
+                node: right,
+                loc: getOperatorToken(right).loc.start,
+                message: message
+            });
+        }
+
+        /**
+         * Checks between the operator of this node and the operator of the
+         * parent node.
+         *
+         * @param {ASTNode} node - A node to check.
+         * @returns {void}
+         */
+        function check(node) {
+            if (TARGET_NODE_TYPE.test(node.parent.type) &&
+                isMixedWithParent(node) &&
+                !shouldIgnore(node)
+            ) {
+                reportBothOperators(node);
+            }
+        }
+
+        return {
+            BinaryExpression: check,
+            LogicalExpression: check
+        };
+    }
+};

package/lib/rules/no-multiple-empty-lines.js

@@ -17,6 +17,8 @@ module.exports = {
             recommended: false
         },
 
+        fixable: "whitespace",
+
         schema: [
             {
                 type: "object",
@@ -76,21 +78,34 @@ module.exports = {
 
             "Program:exit": function checkBlankLines(node) {
                 var lines = sourceCode.lines,
-                    currentLocation = -1,
-                    lastLocation,
+                    fullLines = sourceCode.text.match(/.*(\r\n|\r|\n|\u2028|\u2029)/g) || [],
+                    firstNonBlankLine = -1,
+                    trimmedLines = [],
+                    linesRangeStart = [],
                     blankCounter = 0,
+                    currentLocation,
+                    lastLocation,
                     location,
                     firstOfEndingBlankLines,
-                    firstNonBlankLine = -1,
-                    trimmedLines = [];
+                    diff,
+                    fix,
+                    rangeStart,
+                    rangeEnd;
+
+                fix = function(fixer) {
+                    return fixer.removeRange([rangeStart, rangeEnd]);
+                };
 
+                linesRangeStart.push(0);
                 lines.forEach(function(str, i) {
-                    var trimmed = str.trim();
+                    var length = i < fullLines.length ? fullLines[i].length : 0,
+                        trimmed = str.trim();
 
                     if ((firstNonBlankLine === -1) && (trimmed !== "")) {
                         firstNonBlankLine = i;
                     }
 
+                    linesRangeStart.push(linesRangeStart[linesRangeStart.length - 1] + length);
                     trimmedLines.push(trimmed);
                 });
 
@@ -122,8 +137,15 @@ module.exports = {
 
                 // Aggregate and count blank lines
                 if (firstNonBlankLine > maxBOF) {
-                    context.report(node, 0,
-                            "Too many blank lines at the beginning of file. Max of " + maxBOF + " allowed.");
+                    diff = firstNonBlankLine - maxBOF;
+                    rangeStart = linesRangeStart[firstNonBlankLine - diff];
+                    rangeEnd = linesRangeStart[firstNonBlankLine];
+                    context.report({
+                        node: node,
+                        loc: node.loc.start,
+                        message: "Too many blank lines at the beginning of file. Max of " + maxBOF + " allowed.",
+                        fix: fix
+                    });
                 }
                 currentLocation = firstNonBlankLine - 1;
 
@@ -144,20 +166,29 @@ module.exports = {
 
                             // within the file, not at the end
                             if (blankCounter >= max) {
+                                diff = blankCounter - max + 1;
+                                rangeStart = linesRangeStart[location.line - diff];
+                                rangeEnd = linesRangeStart[location.line];
+
                                 context.report({
                                     node: node,
                                     loc: location,
-                                    message: "More than " + max + " blank " + (max === 1 ? "line" : "lines") + " not allowed."
+                                    message: "More than " + max + " blank " + (max === 1 ? "line" : "lines") + " not allowed.",
+                                    fix: fix
                                 });
                             }
                         } else {
 
                             // inside the last blank lines
                             if (blankCounter > maxEOF) {
+                                diff = blankCounter - maxEOF + 1;
+                                rangeStart = linesRangeStart[location.line - diff];
+                                rangeEnd = linesRangeStart[location.line - 1];
                                 context.report({
                                     node: node,
                                     loc: location,
-                                    message: "Too many blank lines at the end of file. Max of " + maxEOF + " allowed."
+                                    message: "Too many blank lines at the end of file. Max of " + maxEOF + " allowed.",
+                                    fix: fix
                                 });
                             }
                         }

package/lib/rules/no-prototype-builtins.js

@@ -11,7 +11,7 @@
 module.exports = {
     meta: {
         docs: {
-            description: "disallow calling some Object.prototype methods directly on objects",
+            description: "disallow calling some `Object.prototype` methods directly on objects",
             category: "Possible Errors",
             recommended: false
         }

package/lib/rules/no-script-url.js

@@ -14,7 +14,7 @@
 module.exports = {
     meta: {
         docs: {
-            description: "disallow `javascript",
+            description: "disallow `javascript:` urls",
             category: "Best Practices",
             recommended: false
         },

package/lib/rules/no-unsafe-finally.js

@@ -21,7 +21,7 @@ var SENTINEL_NODE_TYPE_CONTINUE = /^(?:Program|(?:Function|Class)(?:Declaration|
 module.exports = {
     meta: {
         docs: {
-            description: "disallow control flow statements in finally blocks",
+            description: "disallow control flow statements in `finally` blocks",
             category: "Possible Errors",
             recommended: false
         }

package/lib/rules/no-useless-rename.js

@@ -87,7 +87,13 @@ module.exports = {
                     return;
                 }
 
-                if (properties[i].computed) {
+                /**
+                 * If an ObjectPattern property is computed, we have no idea
+                 * if a rename is useless or not. If an ObjectPattern property
+                 * lacks a key, it is likely an ExperimentalRestProperty and
+                 * so there is no "renaming" occurring here.
+                 */
+                if (properties[i].computed || !properties[i].key) {
                     return;
                 }
 
@@ -108,7 +114,8 @@ module.exports = {
                 return;
             }
 
-            if (node.imported.name === node.local.name) {
+            if (node.imported.name === node.local.name &&
+                    node.imported.range[0] !== node.local.range[0]) {
                 reportError(node, node.imported, node.local, "Import");
             }
         }
@@ -123,7 +130,8 @@ module.exports = {
                 return;
             }
 
-            if (node.local.name === node.exported.name) {
+            if (node.local.name === node.exported.name &&
+                    node.local.range[0] !== node.exported.range[0]) {
                 reportError(node, node.local, node.exported, "Export");
             }
 

package/lib/rules/object-curly-newline.js

@@ -0,0 +1,209 @@
+/**
+ * @fileoverview Rule to require or disallow line breaks inside braces.
+ * @author Toru Nagashima
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+var astUtils = require("../ast-utils");
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+// Schema objects.
+var OPTION_VALUE = {
+    oneOf: [
+        {
+            enum: ["always", "never"]
+        },
+        {
+            type: "object",
+            properties: {
+                multiline: {
+                    type: "boolean"
+                },
+                minProperties: {
+                    type: "integer",
+                    minimum: 0
+                }
+            },
+            additionalProperties: false,
+            minProperties: 1
+        }
+    ]
+};
+
+/**
+ * Normalizes a given option value.
+ *
+ * @param {string|object|undefined} value - An option value to parse.
+ * @returns {{multiline: boolean, minProperties: number}} Normalized option object.
+ */
+function normalizeOptionValue(value) {
+    var multiline = false;
+    var minProperties = Number.POSITIVE_INFINITY;
+
+    if (value) {
+        if (value === "always") {
+            minProperties = 0;
+        } else if (value === "never") {
+            minProperties = Number.POSITIVE_INFINITY;
+        } else {
+            multiline = Boolean(value.multiline);
+            minProperties = value.minProperties || Number.POSITIVE_INFINITY;
+        }
+    } else {
+        multiline = true;
+    }
+
+    return {multiline: multiline, minProperties: minProperties};
+}
+
+/**
+ * Normalizes a given option value.
+ *
+ * @param {string|object|undefined} options - An option value to parse.
+ * @returns {{ObjectExpression: {multiline: boolean, minProperties: number}, ObjectPattern: {multiline: boolean, minProperties: number}}} Normalized option object.
+ */
+function normalizeOptions(options) {
+    if (options && (options.ObjectExpression || options.ObjectPattern)) {
+        return {
+            ObjectExpression: normalizeOptionValue(options.ObjectExpression),
+            ObjectPattern: normalizeOptionValue(options.ObjectPattern)
+        };
+    }
+
+    var value = normalizeOptionValue(options);
+
+    return {ObjectExpression: value, ObjectPattern: value};
+}
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+module.exports = {
+    meta: {
+        docs: {
+            description: "enforce consistent line breaks inside braces",
+            category: "Stylistic Issues",
+            recommended: false
+        },
+        fixable: "whitespace",
+        schema: [
+            {
+                oneOf: [
+                    OPTION_VALUE,
+                    {
+                        type: "object",
+                        properties: {
+                            ObjectExpression: OPTION_VALUE,
+                            ObjectPattern: OPTION_VALUE
+                        },
+                        additionalProperties: false,
+                        minProperties: 1
+                    }
+                ]
+            }
+        ]
+    },
+
+    create: function(context) {
+        var sourceCode = context.getSourceCode();
+        var normalizedOptions = normalizeOptions(context.options[0]);
+
+        /**
+         * Reports a given node if it violated this rule.
+         *
+         * @param {ASTNode} node - A node to check. This is an ObjectExpression node or an ObjectPattern node.
+         * @param {{multiline: boolean, minProperties: number}} options - An option object.
+         * @returns {void}
+         */
+        function check(node) {
+            var options = normalizedOptions[node.type];
+            var openBrace = sourceCode.getFirstToken(node);
+            var closeBrace = sourceCode.getLastToken(node);
+            var first = sourceCode.getTokenOrCommentAfter(openBrace);
+            var last = sourceCode.getTokenOrCommentBefore(closeBrace);
+            var needsLinebreaks = (
+                node.properties.length >= options.minProperties ||
+                (
+                    options.multiline &&
+                    node.properties.length > 0 &&
+                    first.loc.start.line !== last.loc.end.line
+                )
+            );
+
+            /*
+             * Use tokens or comments to check multiline or not.
+             * But use only tokens to check whether line breaks are needed.
+             * This allows:
+             *     var obj = { // eslint-disable-line foo
+             *         a: 1
+             *     }
+             */
+            first = sourceCode.getTokenAfter(openBrace);
+            last = sourceCode.getTokenBefore(closeBrace);
+
+            if (needsLinebreaks) {
+                if (astUtils.isTokenOnSameLine(openBrace, first)) {
+                    context.report({
+                        message: "Expected a line break after this open brace.",
+                        node: node,
+                        loc: openBrace.loc.start,
+                        fix: function(fixer) {
+                            return fixer.insertTextAfter(openBrace, "\n");
+                        }
+                    });
+                }
+                if (astUtils.isTokenOnSameLine(last, closeBrace)) {
+                    context.report({
+                        message: "Expected a line break before this close brace.",
+                        node: node,
+                        loc: closeBrace.loc.start,
+                        fix: function(fixer) {
+                            return fixer.insertTextBefore(closeBrace, "\n");
+                        }
+                    });
+                }
+            } else {
+                if (!astUtils.isTokenOnSameLine(openBrace, first)) {
+                    context.report({
+                        message: "Unexpected a line break after this open brace.",
+                        node: node,
+                        loc: openBrace.loc.start,
+                        fix: function(fixer) {
+                            return fixer.removeRange([
+                                openBrace.range[1],
+                                first.range[0]
+                            ]);
+                        }
+                    });
+                }
+                if (!astUtils.isTokenOnSameLine(last, closeBrace)) {
+                    context.report({
+                        message: "Unexpected a line break before this close brace.",
+                        node: node,
+                        loc: closeBrace.loc.start,
+                        fix: function(fixer) {
+                            return fixer.removeRange([
+                                last.range[1],
+                                closeBrace.range[0]
+                            ]);
+                        }
+                    });
+                }
+            }
+        }
+
+        return {
+            ObjectExpression: check,
+            ObjectPattern: check
+        };
+    }
+};