eslint 4.16.0 → 4.18.2

package/lib/rules/comma-dangle.js

@@ -124,14 +124,17 @@ module.exports = {
                     ]
                 }
             ]
+        },
+
+        messages: {
+            unexpected: "Unexpected trailing comma.",
+            missing: "Missing trailing comma."
         }
     },
 
     create(context) {
         const options = normalizeOptions(context.options[0]);
         const sourceCode = context.getSourceCode();
-        const UNEXPECTED_MESSAGE = "Unexpected trailing comma.";
-        const MISSING_MESSAGE = "Missing trailing comma.";
 
         /**
          * Gets the last item of the given node.
@@ -230,7 +233,7 @@ module.exports = {
                 context.report({
                     node: lastItem,
                     loc: trailingToken.loc.start,
-                    message: UNEXPECTED_MESSAGE,
+                    messageId: "unexpected",
                     fix(fixer) {
                         return fixer.remove(trailingToken);
                     }
@@ -267,7 +270,7 @@ module.exports = {
                 context.report({
                     node: lastItem,
                     loc: trailingToken.loc.end,
-                    message: MISSING_MESSAGE,
+                    messageId: "missing",
                     fix(fixer) {
                         return fixer.insertTextAfter(trailingToken, ",");
                     }

package/lib/rules/comma-spacing.js

@@ -34,7 +34,12 @@ module.exports = {
                 },
                 additionalProperties: false
             }
-        ]
+        ],
+
+        messages: {
+            missing: "A space is required {{loc}} ','.",
+            unexpected: "There should be no space {{loc}} ','."
+        }
     },
 
     create(context) {
@@ -57,17 +62,17 @@ module.exports = {
         /**
          * Reports a spacing error with an appropriate message.
          * @param {ASTNode} node The binary expression node to report.
-         * @param {string} dir Is the error "before" or "after" the comma?
+         * @param {string} loc Is the error "before" or "after" the comma?
          * @param {ASTNode} otherNode The node at the left or right of `node`
          * @returns {void}
          * @private
          */
-        function report(node, dir, otherNode) {
+        function report(node, loc, otherNode) {
             context.report({
                 node,
                 fix(fixer) {
-                    if (options[dir]) {
-                        if (dir === "before") {
+                    if (options[loc]) {
+                        if (loc === "before") {
                             return fixer.insertTextBefore(node, " ");
                         }
                         return fixer.insertTextAfter(node, " ");
@@ -76,7 +81,7 @@ module.exports = {
                     let start, end;
                     const newText = "";
 
-                    if (dir === "before") {
+                    if (loc === "before") {
                         start = otherNode.range[1];
                         end = node.range[0];
                     } else {
@@ -87,11 +92,9 @@ module.exports = {
                     return fixer.replaceTextRange([start, end], newText);
 
                 },
-                message: options[dir]
-                    ? "A space is required {{dir}} ','."
-                    : "There should be no space {{dir}} ','.",
+                messageId: options[loc] ? "missing" : "unexpected",
                 data: {
-                    dir
+                    loc
                 }
             });
         }

package/lib/rules/comma-style.js

@@ -36,7 +36,12 @@ module.exports = {
                 },
                 additionalProperties: false
             }
-        ]
+        ],
+        messages: {
+            unexpectedLineBeforeAndAfterComma: "Bad line breaking before and after ','.",
+            expectedCommaFirst: "',' should be placed first.",
+            expectedCommaLast: "',' should be placed last."
+        }
     },
 
     create(context) {
@@ -135,7 +140,7 @@ module.exports = {
                         line: commaToken.loc.end.line,
                         column: commaToken.loc.start.column
                     },
-                    message: "Bad line breaking before and after ','.",
+                    messageId: "unexpectedLineBeforeAndAfterComma",
                     fix: getFixerFunction("between", previousItemToken, commaToken, currentItemToken)
                 });
 
@@ -143,7 +148,7 @@ module.exports = {
 
                 context.report({
                     node: reportItem,
-                    message: "',' should be placed first.",
+                    messageId: "expectedCommaFirst",
                     fix: getFixerFunction(style, previousItemToken, commaToken, currentItemToken)
                 });
 
@@ -155,7 +160,7 @@ module.exports = {
                         line: commaToken.loc.end.line,
                         column: commaToken.loc.end.column
                     },
-                    message: "',' should be placed last.",
+                    messageId: "expectedCommaLast",
                     fix: getFixerFunction(style, previousItemToken, commaToken, currentItemToken)
                 });
             }

package/lib/rules/complexity.js

@@ -50,7 +50,11 @@ module.exports = {
                     }
                 ]
             }
-        ]
+        ],
+
+        messages: {
+            complex: "{{name}} has a complexity of {{complexity}}."
+        }
     },
 
     create(context) {
@@ -96,7 +100,7 @@ module.exports = {
             if (complexity > THRESHOLD) {
                 context.report({
                     node,
-                    message: "{{name}} has a complexity of {{complexity}}.",
+                    messageId: "complex",
                     data: { name, complexity }
                 });
             }

package/lib/rules/computed-property-spacing.js

@@ -25,7 +25,15 @@ module.exports = {
             {
                 enum: ["always", "never"]
             }
-        ]
+        ],
+
+        messages: {
+            unexpectedSpaceBefore: "There should be no space before '{{tokenValue}}'.",
+            unexpectedSpaceAfter: "There should be no space after '{{tokenValue}}'.",
+
+            missingSpaceBefore: "A space is required before '{{tokenValue}}'.",
+            missingSpaceAfter: "A space is required after '{{tokenValue}}'."
+        }
     },
 
     create(context) {
@@ -47,7 +55,7 @@ module.exports = {
             context.report({
                 node,
                 loc: token.loc.start,
-                message: "There should be no space after '{{tokenValue}}'.",
+                messageId: "unexpectedSpaceAfter",
                 data: {
                     tokenValue: token.value
                 },
@@ -68,7 +76,7 @@ module.exports = {
             context.report({
                 node,
                 loc: token.loc.start,
-                message: "There should be no space before '{{tokenValue}}'.",
+                messageId: "unexpectedSpaceBefore",
                 data: {
                     tokenValue: token.value
                 },
@@ -88,7 +96,7 @@ module.exports = {
             context.report({
                 node,
                 loc: token.loc.start,
-                message: "A space is required after '{{tokenValue}}'.",
+                messageId: "missingSpaceAfter",
                 data: {
                     tokenValue: token.value
                 },
@@ -108,7 +116,7 @@ module.exports = {
             context.report({
                 node,
                 loc: token.loc.start,
-                message: "A space is required before '{{tokenValue}}'.",
+                messageId: "missingSpaceBefore",
                 data: {
                     tokenValue: token.value
                 },

package/lib/rules/consistent-return.js

@@ -68,7 +68,13 @@ module.exports = {
                 }
             },
             additionalProperties: false
-        }]
+        }],
+
+        messages: {
+            missingReturn: "Expected to return a value at the end of {{name}}.",
+            missingReturnValue: "{{name}} expected a return value.",
+            unexpectedReturnValue: "{{name}} expected no return value."
+        }
     },
 
     create(context) {
@@ -129,7 +135,7 @@ module.exports = {
             context.report({
                 node,
                 loc,
-                message: "Expected to return a value at the end of {{name}}.",
+                messageId: "missingReturn",
                 data: { name }
             });
         }
@@ -143,7 +149,7 @@ module.exports = {
                     codePath,
                     hasReturn: false,
                     hasReturnValue: false,
-                    message: "",
+                    messageId: "",
                     node
                 };
             },
@@ -163,17 +169,16 @@ module.exports = {
                 if (!funcInfo.hasReturn) {
                     funcInfo.hasReturn = true;
                     funcInfo.hasReturnValue = hasReturnValue;
-                    funcInfo.message = "{{name}} expected {{which}} return value.";
+                    funcInfo.messageId = hasReturnValue ? "missingReturnValue" : "unexpectedReturnValue";
                     funcInfo.data = {
                         name: funcInfo.node.type === "Program"
                             ? "Program"
-                            : lodash.upperFirst(astUtils.getFunctionNameWithKind(funcInfo.node)),
-                        which: hasReturnValue ? "a" : "no"
+                            : lodash.upperFirst(astUtils.getFunctionNameWithKind(funcInfo.node))
                     };
                 } else if (funcInfo.hasReturnValue !== hasReturnValue) {
                     context.report({
                         node,
-                        message: funcInfo.message,
+                        messageId: funcInfo.messageId,
                         data: funcInfo.data
                     });
                 }

package/lib/rules/consistent-this.js

@@ -24,6 +24,11 @@ module.exports = {
                 minLength: 1
             },
             uniqueItems: true
+        },
+
+        messages: {
+            aliasNotAssignedToThis: "Designated alias '{{name}}' is not assigned to 'this'.",
+            unexpectedAlias: "Unexpected alias '{{name}}' for 'this'."
         }
     },
 
@@ -40,11 +45,11 @@ module.exports = {
          * Reports that a variable declarator or assignment expression is assigning
          * a non-'this' value to the specified alias.
          * @param {ASTNode} node - The assigning node.
-         * @param {string} alias - the name of the alias that was incorrectly used.
+         * @param {string}  name - the name of the alias that was incorrectly used.
          * @returns {void}
          */
-        function reportBadAssignment(node, alias) {
-            context.report({ node, message: "Designated alias '{{alias}}' is not assigned to 'this'.", data: { alias } });
+        function reportBadAssignment(node, name) {
+            context.report({ node, messageId: "aliasNotAssignedToThis", data: { name } });
         }
 
         /**
@@ -63,7 +68,7 @@ module.exports = {
                     reportBadAssignment(node, name);
                 }
             } else if (isThis) {
-                context.report({ node, message: "Unexpected alias '{{name}}' for 'this'.", data: { name } });
+                context.report({ node, messageId: "unexpectedAlias", data: { name } });
             }
         }
 

package/lib/rules/constructor-super.js

@@ -99,7 +99,16 @@ module.exports = {
             url: "https://eslint.org/docs/rules/constructor-super"
         },
 
-        schema: []
+        schema: [],
+
+        messages: {
+            missingSome: "Lacked a call of 'super()' in some code paths.",
+            missingAll: "Expected to call 'super()'.",
+
+            duplicate: "Unexpected duplicate 'super()'.",
+            badSuper: "Unexpected 'super()' because 'super' is not a constructor.",
+            unexpected: "Unexpected 'super()'."
+        }
     },
 
     create(context) {
@@ -210,9 +219,9 @@ module.exports = {
 
                 if (!calledInEveryPaths) {
                     context.report({
-                        message: calledInSomePaths
-                            ? "Lacked a call of 'super()' in some code paths."
-                            : "Expected to call 'super()'.",
+                        messageId: calledInSomePaths
+                            ? "missingSome"
+                            : "missingAll",
                         node: node.parent
                     });
                 }
@@ -281,7 +290,7 @@ module.exports = {
                                 const node = nodes[i];
 
                                 context.report({
-                                    message: "Unexpected duplicate 'super()'.",
+                                    messageId: "duplicate",
                                     node
                                 });
                             }
@@ -325,12 +334,12 @@ module.exports = {
                     if (info) {
                         if (duplicate) {
                             context.report({
-                                message: "Unexpected duplicate 'super()'.",
+                                messageId: "duplicate",
                                 node
                             });
                         } else if (!funcInfo.superIsConstructor) {
                             context.report({
-                                message: "Unexpected 'super()' because 'super' is not a constructor.",
+                                messageId: "badSuper",
                                 node
                             });
                         } else {
@@ -339,7 +348,7 @@ module.exports = {
                     }
                 } else if (funcInfo.codePath.currentSegments.some(isReachable)) {
                     context.report({
-                        message: "Unexpected 'super()'.",
+                        messageId: "unexpected",
                         node
                     });
                 }

package/lib/rules/curly.js

@@ -51,7 +51,14 @@ module.exports = {
             ]
         },
 
-        fixable: "code"
+        fixable: "code",
+
+        messages: {
+            missingCurlyAfter: "Expected { after '{{name}}'.",
+            missingCurlyAfterCondition: "Expected { after '{{name}}' condition.",
+            unexpectedCurlyAfter: "Unnecessary { after '{{name}}'.",
+            unexpectedCurlyAfterCondition: "Unnecessary { after '{{name}}' condition."
+        }
     },
 
     create(context) {
@@ -142,28 +149,6 @@ module.exports = {
             return false;
         }
 
-        /**
-         * Reports "Expected { after ..." error
-         * @param {ASTNode} node The node to report.
-         * @param {ASTNode} bodyNode The body node that is incorrectly missing curly brackets
-         * @param {string} name The name to report.
-         * @param {string} suffix Additional string to add to the end of a report.
-         * @returns {void}
-         * @private
-         */
-        function reportExpectedBraceError(node, bodyNode, name, suffix) {
-            context.report({
-                node,
-                loc: (name !== "else" ? node : getElseKeyword(node)).loc.start,
-                message: "Expected { after '{{name}}'{{suffix}}.",
-                data: {
-                    name,
-                    suffix: (suffix ? ` ${suffix}` : "")
-                },
-                fix: fixer => fixer.replaceText(bodyNode, `{${sourceCode.getText(bodyNode)}}`)
-            });
-        }
-
         /**
          * Determines if a semicolon needs to be inserted after removing a set of curly brackets, in order to avoid a SyntaxError.
          * @param {Token} closingBracket The } token
@@ -218,62 +203,12 @@ module.exports = {
             return false;
         }
 
-        /**
-         * Reports "Unnecessary { after ..." error
-         * @param {ASTNode} node The node to report.
-         * @param {ASTNode} bodyNode The block statement that is incorrectly surrounded by parens
-         * @param {string} name The name to report.
-         * @param {string} suffix Additional string to add to the end of a report.
-         * @returns {void}
-         * @private
-         */
-        function reportUnnecessaryBraceError(node, bodyNode, name, suffix) {
-            context.report({
-                node,
-                loc: (name !== "else" ? node : getElseKeyword(node)).loc.start,
-                message: "Unnecessary { after '{{name}}'{{suffix}}.",
-                data: {
-                    name,
-                    suffix: (suffix ? ` ${suffix}` : "")
-                },
-                fix(fixer) {
-
-                    /*
-                     * `do while` expressions sometimes need a space to be inserted after `do`.
-                     * e.g. `do{foo()} while (bar)` should be corrected to `do foo() while (bar)`
-                     */
-                    const needsPrecedingSpace = node.type === "DoWhileStatement" &&
-                        sourceCode.getTokenBefore(bodyNode).range[1] === bodyNode.range[0] &&
-                        !astUtils.canTokensBeAdjacent("do", sourceCode.getFirstToken(bodyNode, { skip: 1 }));
-
-                    const openingBracket = sourceCode.getFirstToken(bodyNode);
-                    const closingBracket = sourceCode.getLastToken(bodyNode);
-                    const lastTokenInBlock = sourceCode.getTokenBefore(closingBracket);
-
-                    if (needsSemicolon(closingBracket)) {
-
-                        /*
-                         * If removing braces would cause a SyntaxError due to multiple statements on the same line (or
-                         * change the semantics of the code due to ASI), don't perform a fix.
-                         */
-                        return null;
-                    }
-
-                    const resultingBodyText = sourceCode.getText().slice(openingBracket.range[1], lastTokenInBlock.range[0]) +
-                        sourceCode.getText(lastTokenInBlock) +
-                        sourceCode.getText().slice(lastTokenInBlock.range[1], closingBracket.range[0]);
-
-                    return fixer.replaceText(bodyNode, (needsPrecedingSpace ? " " : "") + resultingBodyText);
-                }
-            });
-        }
-
         /**
          * Prepares to check the body of a node to see if it's a block statement.
          * @param {ASTNode} node The node to report if there's a problem.
          * @param {ASTNode} body The body node to check for blocks.
          * @param {string} name The name to report if there's a problem.
-         * @param {string} suffix Additional string to add to the end of a report.
+         * @param {{ condition: boolean }} opts Options to pass to the report functions
          * @returns {Object} a prepared check object, with "actual", "expected", "check" properties.
          *   "actual" will be `true` or `false` whether the body is already a block statement.
          *   "expected" will be `true` or `false` if the body should be a block statement or not, or
@@ -282,7 +217,7 @@ module.exports = {
          *   "check" will be a function reporting appropriate problems depending on the other
          *   properties.
          */
-        function prepareCheck(node, body, name, suffix) {
+        function prepareCheck(node, body, name, opts) {
             const hasBlock = (body.type === "BlockStatement");
             let expected = null;
 
@@ -314,9 +249,53 @@ module.exports = {
                 check() {
                     if (this.expected !== null && this.expected !== this.actual) {
                         if (this.expected) {
-                            reportExpectedBraceError(node, body, name, suffix);
+                            context.report({
+                                node,
+                                loc: (name !== "else" ? node : getElseKeyword(node)).loc.start,
+                                messageId: opts && opts.condition ? "missingCurlyAfterCondition" : "missingCurlyAfter",
+                                data: {
+                                    name
+                                },
+                                fix: fixer => fixer.replaceText(body, `{${sourceCode.getText(body)}}`)
+                            });
                         } else {
-                            reportUnnecessaryBraceError(node, body, name, suffix);
+                            context.report({
+                                node,
+                                loc: (name !== "else" ? node : getElseKeyword(node)).loc.start,
+                                messageId: opts && opts.condition ? "unexpectedCurlyAfterCondition" : "unexpectedCurlyAfter",
+                                data: {
+                                    name
+                                },
+                                fix(fixer) {
+
+                                    /*
+                                     * `do while` expressions sometimes need a space to be inserted after `do`.
+                                     * e.g. `do{foo()} while (bar)` should be corrected to `do foo() while (bar)`
+                                     */
+                                    const needsPrecedingSpace = node.type === "DoWhileStatement" &&
+                                        sourceCode.getTokenBefore(body).range[1] === body.range[0] &&
+                                        !astUtils.canTokensBeAdjacent("do", sourceCode.getFirstToken(body, { skip: 1 }));
+
+                                    const openingBracket = sourceCode.getFirstToken(body);
+                                    const closingBracket = sourceCode.getLastToken(body);
+                                    const lastTokenInBlock = sourceCode.getTokenBefore(closingBracket);
+
+                                    if (needsSemicolon(closingBracket)) {
+
+                                        /*
+                                         * If removing braces would cause a SyntaxError due to multiple statements on the same line (or
+                                         * change the semantics of the code due to ASI), don't perform a fix.
+                                         */
+                                        return null;
+                                    }
+
+                                    const resultingBodyText = sourceCode.getText().slice(openingBracket.range[1], lastTokenInBlock.range[0]) +
+                                        sourceCode.getText(lastTokenInBlock) +
+                                        sourceCode.getText().slice(lastTokenInBlock.range[1], closingBracket.range[0]);
+
+                                    return fixer.replaceText(body, (needsPrecedingSpace ? " " : "") + resultingBodyText);
+                                }
+                            });
                         }
                     }
                 }
@@ -333,7 +312,7 @@ module.exports = {
             const preparedChecks = [];
 
             do {
-                preparedChecks.push(prepareCheck(node, node.consequent, "if", "condition"));
+                preparedChecks.push(prepareCheck(node, node.consequent, "if", { condition: true }));
                 if (node.alternate && node.alternate.type !== "IfStatement") {
                     preparedChecks.push(prepareCheck(node, node.alternate, "else"));
                     break;
@@ -377,7 +356,7 @@ module.exports = {
             },
 
             WhileStatement(node) {
-                prepareCheck(node, node.body, "while", "condition").check();
+                prepareCheck(node, node.body, "while", { condition: true }).check();
             },
 
             DoWhileStatement(node) {
@@ -385,7 +364,7 @@ module.exports = {
             },
 
             ForStatement(node) {
-                prepareCheck(node, node.body, "for", "condition").check();
+                prepareCheck(node, node.body, "for", { condition: true }).check();
             },
 
             ForInStatement(node) {

package/lib/rules/default-case.js

@@ -27,7 +27,11 @@ module.exports = {
                 }
             },
             additionalProperties: false
-        }]
+        }],
+
+        messages: {
+            missingDefaultCase: "Expected a default case."
+        }
     },
 
     create(context) {
@@ -82,7 +86,7 @@ module.exports = {
                     }
 
                     if (!comment || !commentPattern.test(comment.value.trim())) {
-                        context.report({ node, message: "Expected a default case." });
+                        context.report({ node, messageId: "missingDefaultCase" });
                     }
                 }
             }

package/lib/rules/dot-location.js

@@ -26,7 +26,12 @@ module.exports = {
             }
         ],
 
-        fixable: "code"
+        fixable: "code",
+
+        messages: {
+            expectedDotAfterObject: "Expected dot to be on same line as object.",
+            expectedDotBeforeProperty: "Expected dot to be on same line as property."
+        }
     },
 
     create(context) {
@@ -58,7 +63,7 @@ module.exports = {
                         context.report({
                             node,
                             loc: dot.loc.start,
-                            message: "Expected dot to be on same line as object.",
+                            messageId: "expectedDotAfterObject",
                             fix: fixer => fixer.replaceTextRange([obj.range[1], prop.range[0]], `${neededTextAfterObj}.${textBeforeDot}${textAfterDot}`)
                         });
                     }
@@ -66,7 +71,7 @@ module.exports = {
                     context.report({
                         node,
                         loc: dot.loc.start,
-                        message: "Expected dot to be on same line as property.",
+                        messageId: "expectedDotBeforeProperty",
                         fix: fixer => fixer.replaceTextRange([obj.range[1], prop.range[0]], `${textBeforeDot}${textAfterDot}.`)
                     });
                 }

package/lib/rules/dot-notation.js

@@ -41,7 +41,12 @@ module.exports = {
             }
         ],
 
-        fixable: "code"
+        fixable: "code",
+
+        messages: {
+            useDot: "[{{key}}] is better written in dot notation.",
+            useBrackets: ".{{key}} is a syntax error."
+        }
     },
 
     create(context) {
@@ -71,9 +76,9 @@ module.exports = {
 
                 context.report({
                     node: node.property,
-                    message: "[{{propertyValue}}] is better written in dot notation.",
+                    messageId: "useDot",
                     data: {
-                        propertyValue: formattedValue
+                        key: formattedValue
                     },
                     fix(fixer) {
                         const leftBracket = sourceCode.getTokenAfter(node.object, astUtils.isOpeningBracketToken);
@@ -124,9 +129,9 @@ module.exports = {
                 ) {
                     context.report({
                         node: node.property,
-                        message: ".{{propertyName}} is a syntax error.",
+                        messageId: "useBrackets",
                         data: {
-                            propertyName: node.property.name
+                            key: node.property.name
                         },
                         fix(fixer) {
                             const dot = sourceCode.getTokenBefore(node.property);