eslint 5.8.0 → 5.9.0

package/lib/rules/curly.js

@@ -16,6 +16,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce consistent brace style for all control statements",
             category: "Best Practices",

package/lib/rules/default-case.js

@@ -12,6 +12,8 @@ const DEFAULT_COMMENT_PATTERN = /^no default$/i;
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require `default` cases in `switch` statements",
             category: "Best Practices",

package/lib/rules/dot-location.js

@@ -13,6 +13,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent newlines before and after dots",
             category: "Best Practices",

package/lib/rules/dot-notation.js

@@ -19,6 +19,8 @@ const keywords = require("../util/keywords");
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce dot notation whenever possible",
             category: "Best Practices",

package/lib/rules/eol-last.js

@@ -16,18 +16,23 @@ const lodash = require("lodash");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require or disallow newline at the end of files",
             category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/eol-last"
         },
+
         fixable: "whitespace",
+
         schema: [
             {
                 enum: ["always", "never", "unix", "windows"]
             }
         ],
+
         messages: {
             missing: "Newline required at end of file but not found.",
             unexpected: "Newline not allowed at end of file."

package/lib/rules/eqeqeq.js

@@ -17,6 +17,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require the use of `===` and `!==`",
             category: "Best Practices",

package/lib/rules/for-direction.js

@@ -11,14 +11,18 @@
 
 module.exports = {
     meta: {
+        type: "problem",
+
         docs: {
             description: "enforce \"for\" loop update clause moving the counter in the right direction.",
             category: "Possible Errors",
             recommended: true,
             url: "https://eslint.org/docs/rules/for-direction"
         },
+
         fixable: null,
         schema: [],
+
         messages: {
             incorrectDirection: "The update clause in this loop moves the variable in the wrong direction."
         }

package/lib/rules/func-call-spacing.js

@@ -17,6 +17,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require or disallow spacing between function identifiers and their invocations",
             category: "Stylistic Issues",
@@ -25,6 +27,7 @@ module.exports = {
         },
 
         fixable: "whitespace",
+
         schema: {
             anyOf: [
                 {
@@ -58,6 +61,7 @@ module.exports = {
                 }
             ]
         },
+
         messages: {
             unexpected: "Unexpected newline between function name and paren.",
             missing: "Missing space between function name and paren."

package/lib/rules/func-name-matching.js

@@ -70,6 +70,8 @@ const optionsObject = {
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require function names to match the name of the variable or property to which they are assigned",
             category: "Stylistic Issues",
@@ -88,6 +90,7 @@ module.exports = {
                 items: [optionsObject]
             }]
         },
+
         messages: {
             matchProperty: "Function name `{{funcName}}` should match property name `{{name}}`",
             matchVariable: "Function name `{{funcName}}` should match variable name `{{name}}`",

package/lib/rules/func-names.js

@@ -26,6 +26,8 @@ function isFunctionName(variable) {
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require or disallow named `function` expressions",
             category: "Stylistic Issues",
@@ -58,6 +60,7 @@ module.exports = {
                 }
             ]
         },
+
         messages: {
             unnamed: "Unexpected unnamed {{name}}.",
             named: "Unexpected named {{name}}."

package/lib/rules/func-style.js

@@ -10,6 +10,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce the consistent use of either `function` declarations or expressions",
             category: "Stylistic Issues",
@@ -31,6 +33,7 @@ module.exports = {
                 additionalProperties: false
             }
         ],
+
         messages: {
             expression: "Expected a function expression.",
             declaration: "Expected a function declaration."

package/lib/rules/function-paren-newline.js

@@ -16,13 +16,17 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent line breaks inside function parentheses",
             category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/function-paren-newline"
         },
+
         fixable: "whitespace",
+
         schema: [
             {
                 oneOf: [
@@ -42,6 +46,7 @@ module.exports = {
                 ]
             }
         ],
+
         messages: {
             expectedBefore: "Expected newline before ')'.",
             expectedAfter: "Expected newline after '('.",

package/lib/rules/generator-star-spacing.js

@@ -27,6 +27,8 @@ const OVERRIDE_SCHEMA = {
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent spacing around `*` operators in generator functions",
             category: "ECMAScript 6",
@@ -56,6 +58,7 @@ module.exports = {
                 ]
             }
         ],
+
         messages: {
             missingBefore: "Missing space before *.",
             missingAfter: "Missing space after *.",

package/lib/rules/getter-return.js

@@ -44,13 +44,17 @@ function getId(node) {
 
 module.exports = {
     meta: {
+        type: "problem",
+
         docs: {
             description: "enforce `return` statements in getters",
             category: "Possible Errors",
             recommended: true,
             url: "https://eslint.org/docs/rules/getter-return"
         },
+
         fixable: null,
+
         schema: [
             {
                 type: "object",
@@ -62,6 +66,7 @@ module.exports = {
                 additionalProperties: false
             }
         ],
+
         messages: {
             expected: "Expected to return a value in {{name}}.",
             expectedAlways: "Expected {{name}} to always return a value."

package/lib/rules/global-require.js

@@ -48,6 +48,8 @@ function isShadowed(scope, node) {
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require `require()` calls to be placed at top-level module scope",
             category: "Node.js and CommonJS",

package/lib/rules/guard-for-in.js

@@ -11,6 +11,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require `for-in` loops to include an `if` statement",
             category: "Best Practices",

package/lib/rules/handle-callback-err.js

@@ -11,6 +11,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require error handling in callbacks",
             category: "Node.js and CommonJS",

package/lib/rules/id-blacklist.js

@@ -12,6 +12,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "disallow specified identifiers",
             category: "Stylistic Issues",

package/lib/rules/id-length.js

@@ -12,6 +12,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "enforce minimum and maximum identifier lengths",
             category: "Stylistic Issues",

package/lib/rules/id-match.js

@@ -11,6 +11,8 @@
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require identifiers to match a specified regular expression",
             category: "Stylistic Issues",
@@ -27,6 +29,12 @@ module.exports = {
                 properties: {
                     properties: {
                         type: "boolean"
+                    },
+                    onlyDeclarations: {
+                        type: "boolean"
+                    },
+                    ignoreDestructuring: {
+                        type: "boolean"
                     }
                 }
             }
@@ -36,15 +44,25 @@ module.exports = {
     create(context) {
 
         //--------------------------------------------------------------------------
-        // Helpers
+        // Options
         //--------------------------------------------------------------------------
-
         const pattern = context.options[0] || "^.+$",
             regexp = new RegExp(pattern);
 
         const options = context.options[1] || {},
             properties = !!options.properties,
-            onlyDeclarations = !!options.onlyDeclarations;
+            onlyDeclarations = !!options.onlyDeclarations,
+            ignoreDestructuring = !!options.ignoreDestructuring;
+
+        //--------------------------------------------------------------------------
+        // Helpers
+        //--------------------------------------------------------------------------
+
+        // contains reported nodes to avoid reporting twice on destructuring with shorthand notation
+        const reported = new Map();
+        const ALLOWED_PARENT_TYPES = new Set(["CallExpression", "NewExpression"]);
+        const DECLARATION_TYPES = new Set(["FunctionDeclaration", "VariableDeclarator"]);
+        const IMPORT_TYPES = new Set(["ImportSpecifier", "ImportNamespaceSpecifier", "ImportDefaultSpecifier"]);
 
         /**
          * Checks if a string matches the provided pattern
@@ -56,6 +74,26 @@ module.exports = {
             return !regexp.test(name);
         }
 
+        /**
+         * Checks if a parent of a node is an ObjectPattern.
+         * @param {ASTNode} node The node to check.
+         * @returns {boolean} if the node is inside an ObjectPattern
+         * @private
+         */
+        function isInsideObjectPattern(node) {
+            let { parent } = node;
+
+            while (parent) {
+                if (parent.type === "ObjectPattern") {
+                    return true;
+                }
+
+                parent = parent.parent;
+            }
+
+            return false;
+        }
+
         /**
          * Verifies if we should report an error or not based on the effective
          * parent node and the identifier name.
@@ -64,9 +102,8 @@ module.exports = {
          * @returns {boolean} whether an error should be reported or not
          */
         function shouldReport(effectiveParent, name) {
-            return effectiveParent.type !== "CallExpression" &&
-                effectiveParent.type !== "NewExpression" &&
-                isInvalid(name);
+            return (!onlyDeclarations || DECLARATION_TYPES.has(effectiveParent.type)) &&
+                !ALLOWED_PARENT_TYPES.has(effectiveParent.type) && isInvalid(name);
         }
 
         /**
@@ -76,14 +113,17 @@ module.exports = {
          * @private
          */
         function report(node) {
-            context.report({
-                node,
-                message: "Identifier '{{name}}' does not match the pattern '{{pattern}}'.",
-                data: {
-                    name: node.name,
-                    pattern
-                }
-            });
+            if (!reported.has(node)) {
+                context.report({
+                    node,
+                    message: "Identifier '{{name}}' does not match the pattern '{{pattern}}'.",
+                    data: {
+                        name: node.name,
+                        pattern
+                    }
+                });
+                reported.set(node, true);
+            }
         }
 
         return {
@@ -106,36 +146,70 @@ module.exports = {
                             report(node);
                         }
 
-                    // Report AssignmentExpressions only if they are the left side of the assignment
+                    // Report AssignmentExpressions left side's assigned variable id
                     } else if (effectiveParent.type === "AssignmentExpression" &&
-                        (effectiveParent.right.type !== "MemberExpression" ||
                         effectiveParent.left.type === "MemberExpression" &&
-                        effectiveParent.left.property.name === name)) {
+                        effectiveParent.left.property.name === node.name) {
+                        if (isInvalid(name)) {
+                            report(node);
+                        }
+
+                    // Report AssignmentExpressions only if they are the left side of the assignment
+                    } else if (effectiveParent.type === "AssignmentExpression" && effectiveParent.right.type !== "MemberExpression") {
                         if (isInvalid(name)) {
                             report(node);
                         }
                     }
 
-                } else if (parent.type === "Property") {
+                /*
+                 * Properties have their own rules, and
+                 * AssignmentPattern nodes can be treated like Properties:
+                 * e.g.: const { no_camelcased = false } = bar;
+                 */
+                } else if (parent.type === "Property" || parent.type === "AssignmentPattern") {
+
+                    if (parent.parent && parent.parent.type === "ObjectPattern") {
+                        if (parent.shorthand && parent.value.left && isInvalid(name)) {
+
+                            report(node);
+                        }
+
+                        const assignmentKeyEqualsValue = parent.key.name === parent.value.name;
 
-                    if (!properties || parent.key.name !== name) {
+                        // prevent checking righthand side of destructured object
+                        if (!assignmentKeyEqualsValue && parent.key === node) {
+                            return;
+                        }
+
+                        const valueIsInvalid = parent.value.name && isInvalid(name);
+
+                        // ignore destructuring if the option is set, unless a new identifier is created
+                        if (valueIsInvalid && !(assignmentKeyEqualsValue && ignoreDestructuring)) {
+                            report(node);
+                        }
+                    }
+
+                    // never check properties or always ignore destructuring
+                    if (!properties || (ignoreDestructuring && isInsideObjectPattern(node))) {
                         return;
                     }
 
-                    if (shouldReport(effectiveParent, name)) {
+                    // don't check right hand side of AssignmentExpression to prevent duplicate warnings
+                    if (parent.right !== node && shouldReport(effectiveParent, name)) {
                         report(node);
                     }
 
-                } else {
-                    const isDeclaration = effectiveParent.type === "FunctionDeclaration" || effectiveParent.type === "VariableDeclarator";
+                // Check if it's an import specifier
+                } else if (IMPORT_TYPES.has(parent.type)) {
 
-                    if (onlyDeclarations && !isDeclaration) {
-                        return;
-                    }
-
-                    if (shouldReport(effectiveParent, name)) {
+                    // Report only if the local imported identifier is invalid
+                    if (parent.local && parent.local.name === node.name && isInvalid(name)) {
                         report(node);
                     }
+
+                // Report anything that is invalid that isn't a CallExpression
+                } else if (shouldReport(effectiveParent, name)) {
+                    report(node);
                 }
             }
 

package/lib/rules/implicit-arrow-linebreak.js

@@ -9,13 +9,17 @@
 //------------------------------------------------------------------------------
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce the location of arrow function bodies",
             category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/implicit-arrow-linebreak"
         },
+
         fixable: "whitespace",
+
         schema: [
             {
                 enum: ["beside", "below"]

package/lib/rules/indent-legacy.js

@@ -21,16 +21,19 @@ const astUtils = require("../util/ast-utils");
 /* istanbul ignore next: this rule has known coverage issues, but it's deprecated and shouldn't be updated in the future anyway. */
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent indentation",
             category: "Stylistic Issues",
             recommended: false,
-            replacedBy: ["indent"],
             url: "https://eslint.org/docs/rules/indent-legacy"
         },
 
         deprecated: true,
 
+        replacedBy: ["indent"],
+
         fixable: "whitespace",
 
         schema: [

package/lib/rules/indent.js

@@ -490,6 +490,8 @@ const ELEMENT_LIST_SCHEMA = {
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent indentation",
             category: "Stylistic Issues",

package/lib/rules/init-declarations.js

@@ -44,6 +44,8 @@ function isInitialized(node) {
 
 module.exports = {
     meta: {
+        type: "suggestion",
+
         docs: {
             description: "require or disallow initialization in variable declarations",
             category: "Variables",

package/lib/rules/jsx-quotes.js

@@ -38,6 +38,8 @@ const QUOTE_SETTINGS = {
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce the consistent use of either double or single quotes in JSX attributes",
             category: "Stylistic Issues",

package/lib/rules/key-spacing.js

@@ -128,6 +128,8 @@ const messages = {
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent spacing between keys and values in object literal properties",
             category: "Stylistic Issues",
@@ -360,10 +362,9 @@ module.exports = {
          */
         function isKeyValueProperty(property) {
             return !(
-                property.method ||
+                (property.method ||
                 property.shorthand ||
-                property.kind !== "init" ||
-                property.type !== "Property" // Could be "ExperimentalSpreadProperty" or "SpreadElement"
+                property.kind !== "init" || property.type !== "Property") // Could be "ExperimentalSpreadProperty" or "SpreadElement"
             );
         }
 

package/lib/rules/keyword-spacing.js

@@ -65,6 +65,8 @@ function isCloseParenOfTemplate(token) {
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent spacing before and after keywords",
             category: "Stylistic Issues",

package/lib/rules/line-comment-position.js

@@ -12,6 +12,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce position of line comments",
             category: "Stylistic Issues",

package/lib/rules/linebreak-style.js

@@ -17,6 +17,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "enforce consistent linebreak style",
             category: "Stylistic Issues",

package/lib/rules/lines-around-comment.js

@@ -52,6 +52,8 @@ function getCommentLineNums(comments) {
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require empty lines around comments",
             category: "Stylistic Issues",

package/lib/rules/lines-around-directive.js

@@ -14,13 +14,15 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require or disallow newlines around directives",
             category: "Stylistic Issues",
             recommended: false,
-            replacedBy: ["padding-line-between-statements"],
             url: "https://eslint.org/docs/rules/lines-around-directive"
         },
+
         schema: [{
             oneOf: [
                 {
@@ -41,8 +43,10 @@ module.exports = {
                 }
             ]
         }],
+
         fixable: "whitespace",
-        deprecated: true
+        deprecated: true,
+        replacedBy: ["padding-line-between-statements"]
     },
 
     create(context) {

package/lib/rules/lines-between-class-members.js

@@ -12,6 +12,8 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
+        type: "layout",
+
         docs: {
             description: "require or disallow an empty line between class members",
             category: "Stylistic Issues",