eslint 4.16.0 → 4.18.2

package/lib/rules/accessor-pairs.js

@@ -89,7 +89,11 @@ module.exports = {
                 }
             },
             additionalProperties: false
-        }]
+        }],
+        messages: {
+            getter: "Getter is not present.",
+            setter: "Setter is not present."
+        }
     },
     create(context) {
         const config = context.options[0] || {};
@@ -140,9 +144,9 @@ module.exports = {
             }
 
             if (checkSetWithoutGet && isSetPresent && !isGetPresent) {
-                context.report({ node, message: "Getter is not present." });
+                context.report({ node, messageId: "getter" });
             } else if (checkGetWithoutSet && isGetPresent && !isSetPresent) {
-                context.report({ node, message: "Setter is not present." });
+                context.report({ node, messageId: "setter" });
             }
         }
 

package/lib/rules/array-bracket-newline.js

@@ -41,7 +41,13 @@ module.exports = {
                     }
                 ]
             }
-        ]
+        ],
+        messages: {
+            unexpectedOpeningLinebreak: "There should be no linebreak after '['.",
+            unexpectedClosingLinebreak: "There should be no linebreak before ']'.",
+            missingOpeningLinebreak: "A linebreak is required after '['.",
+            missingClosingLinebreak: "A linebreak is required before ']'."
+        }
     },
 
     create(context) {
@@ -106,7 +112,7 @@ module.exports = {
             context.report({
                 node,
                 loc: token.loc,
-                message: "There should be no linebreak after '['.",
+                messageId: "unexpectedOpeningLinebreak",
                 fix(fixer) {
                     const nextToken = sourceCode.getTokenAfter(token, { includeComments: true });
 
@@ -129,7 +135,7 @@ module.exports = {
             context.report({
                 node,
                 loc: token.loc,
-                message: "There should be no linebreak before ']'.",
+                messageId: "unexpectedClosingLinebreak",
                 fix(fixer) {
                     const previousToken = sourceCode.getTokenBefore(token, { includeComments: true });
 
@@ -152,7 +158,7 @@ module.exports = {
             context.report({
                 node,
                 loc: token.loc,
-                message: "A linebreak is required after '['.",
+                messageId: "missingOpeningLinebreak",
                 fix(fixer) {
                     return fixer.insertTextAfter(token, "\n");
                 }
@@ -169,7 +175,7 @@ module.exports = {
             context.report({
                 node,
                 loc: token.loc,
-                message: "A linebreak is required before ']'.",
+                messageId: "missingClosingLinebreak",
                 fix(fixer) {
                     return fixer.insertTextBefore(token, "\n");
                 }

package/lib/rules/array-bracket-spacing.js

@@ -38,7 +38,13 @@ module.exports = {
                 },
                 additionalProperties: false
             }
-        ]
+        ],
+        messages: {
+            unexpectedSpaceAfter: "There should be no space after '{{tokenValue}}'.",
+            unexpectedSpaceBefore: "There should be no space before '{{tokenValue}}'.",
+            missingSpaceAfter: "A space is required after '{{tokenValue}}'.",
+            missingSpaceBefore: "A space is required before '{{tokenValue}}'."
+        }
     },
     create(context) {
         const spaced = context.options[0] === "always",
@@ -76,7 +82,7 @@ module.exports = {
             context.report({
                 node,
                 loc: token.loc.start,
-                message: "There should be no space after '{{tokenValue}}'.",
+                messageId: "unexpectedSpaceAfter",
                 data: {
                     tokenValue: token.value
                 },
@@ -98,7 +104,7 @@ module.exports = {
             context.report({
                 node,
                 loc: token.loc.start,
-                message: "There should be no space before '{{tokenValue}}'.",
+                messageId: "unexpectedSpaceBefore",
                 data: {
                     tokenValue: token.value
                 },
@@ -120,7 +126,7 @@ module.exports = {
             context.report({
                 node,
                 loc: token.loc.start,
-                message: "A space is required after '{{tokenValue}}'.",
+                messageId: "missingSpaceAfter",
                 data: {
                     tokenValue: token.value
                 },
@@ -140,7 +146,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/array-callback-return.js

@@ -156,7 +156,13 @@ module.exports = {
                 },
                 additionalProperties: false
             }
-        ]
+        ],
+
+        messages: {
+            expectedAtEnd: "Expected to return a value at the end of {{name}}.",
+            expectedInside: "Expected to return a value in {{name}}.",
+            expectedReturnValue: "{{name}} expected a return value."
+        }
     },
 
     create(context) {
@@ -188,9 +194,9 @@ module.exports = {
                 context.report({
                     node,
                     loc: getLocation(node, context.getSourceCode()).loc.start,
-                    message: funcInfo.hasReturn
-                        ? "Expected to return a value at the end of {{name}}."
-                        : "Expected to return a value in {{name}}.",
+                    messageId: funcInfo.hasReturn
+                        ? "expectedAtEnd"
+                        : "expectedInside",
                     data: {
                         name: astUtils.getFunctionNameWithKind(funcInfo.node)
                     }
@@ -230,7 +236,7 @@ module.exports = {
                     if (!options.allowImplicit && !node.argument) {
                         context.report({
                             node,
-                            message: "{{name}} expected a return value.",
+                            messageId: "expectedReturnValue",
                             data: {
                                 name: lodash.upperFirst(astUtils.getFunctionNameWithKind(funcInfo.node))
                             }

package/lib/rules/array-element-newline.js

@@ -41,7 +41,12 @@ module.exports = {
                     }
                 ]
             }
-        ]
+        ],
+
+        messages: {
+            unexpectedLineBreak: "There should be no linebreak here.",
+            missingLineBreak: "There should be a linebreak after this element."
+        }
     },
 
     create(context) {
@@ -100,7 +105,7 @@ module.exports = {
                     start: tokenBefore.loc.end,
                     end: token.loc.start
                 },
-                message: "There should be no linebreak here.",
+                messageId: "unexpectedLineBreak",
                 fix(fixer) {
                     if (astUtils.isCommentToken(tokenBefore)) {
                         return null;
@@ -149,7 +154,7 @@ module.exports = {
                     start: tokenBefore.loc.end,
                     end: token.loc.start
                 },
-                message: "There should be a linebreak after this element.",
+                messageId: "missingLineBreak",
                 fix(fixer) {
                     return fixer.replaceTextRange([tokenBefore.range[1], token.range[0]], "\n");
                 }

package/lib/rules/arrow-body-style.js

@@ -55,7 +55,15 @@ module.exports = {
             ]
         },
 
-        fixable: "code"
+        fixable: "code",
+
+        messages: {
+            unexpectedOtherBlock: "Unexpected block statement surrounding arrow body.",
+            unexpectedEmptyBlock: "Unexpected block statement surrounding arrow body; put a value of `undefined` immediately after the `=>`.",
+            unexpectedObjectBlock: "Unexpected block statement surrounding arrow body; parenthesize the returned value and move it immediately after the `=>`.",
+            unexpectedSingleBlock: "Unexpected block statement surrounding arrow body; move the returned value immediately after the `=>`.",
+            expectedBlock: "Expected block statement surrounding arrow body."
+        }
     },
 
     create(context) {
@@ -110,22 +118,22 @@ module.exports = {
                 }
 
                 if (never || asNeeded && blockBody[0].type === "ReturnStatement") {
-                    let message;
+                    let messageId;
 
                     if (blockBody.length === 0) {
-                        message = "Unexpected block statement surrounding arrow body; put a value of `undefined` immediately after the `=>`.";
+                        messageId = "unexpectedEmptyBlock";
                     } else if (blockBody.length > 1) {
-                        message = "Unexpected block statement surrounding arrow body.";
+                        messageId = "unexpectedOtherBlock";
                     } else if (astUtils.isOpeningBraceToken(sourceCode.getFirstToken(blockBody[0], { skip: 1 }))) {
-                        message = "Unexpected block statement surrounding arrow body; parenthesize the returned value and move it immediately after the `=>`.";
+                        messageId = "unexpectedObjectBlock";
                     } else {
-                        message = "Unexpected block statement surrounding arrow body; move the returned value immediately after the `=>`.";
+                        messageId = "unexpectedSingleBlock";
                     }
 
                     context.report({
                         node,
                         loc: arrowBody.loc.start,
-                        message,
+                        messageId,
                         fix(fixer) {
                             const fixes = [];
 
@@ -190,7 +198,7 @@ module.exports = {
                     context.report({
                         node,
                         loc: arrowBody.loc.start,
-                        message: "Expected block statement surrounding arrow body.",
+                        messageId: "expectedBlock",
                         fix(fixer) {
                             const fixes = [];
                             const arrowToken = sourceCode.getTokenBefore(arrowBody, astUtils.isArrowToken);

package/lib/rules/arrow-parens.js

@@ -38,15 +38,19 @@ module.exports = {
                 },
                 additionalProperties: false
             }
-        ]
+        ],
+
+        messages: {
+            unexpectedParens: "Unexpected parentheses around single function argument.",
+            expectedParens: "Expected parentheses around arrow function argument.",
+
+            unexpectedParensInline: "Unexpected parentheses around single function argument having a body with no curly braces.",
+            expectedParensBlock: "Expected parentheses around arrow function argument having a body with curly braces."
+        }
     },
 
     create(context) {
-        const message = "Expected parentheses around arrow function argument.";
-        const asNeededMessage = "Unexpected parentheses around single function argument.";
         const asNeeded = context.options[0] === "as-needed";
-        const requireForBlockBodyMessage = "Unexpected parentheses around single function argument having a body with no curly braces";
-        const requireForBlockBodyNoParensMessage = "Expected parentheses around arrow function argument having a body with curly braces.";
         const requireForBlockBody = asNeeded && context.options[1] && context.options[1].requireForBlockBody === true;
 
         const sourceCode = context.getSourceCode();
@@ -94,7 +98,7 @@ module.exports = {
                 if (astUtils.isOpeningParenToken(firstTokenOfParam)) {
                     context.report({
                         node,
-                        message: requireForBlockBodyMessage,
+                        messageId: "unexpectedParensInline",
                         fix: fixParamsWithParenthesis
                     });
                 }
@@ -108,7 +112,7 @@ module.exports = {
                 if (!astUtils.isOpeningParenToken(firstTokenOfParam)) {
                     context.report({
                         node,
-                        message: requireForBlockBodyNoParensMessage,
+                        messageId: "expectedParensBlock",
                         fix(fixer) {
                             return fixer.replaceText(firstTokenOfParam, `(${firstTokenOfParam.value})`);
                         }
@@ -127,7 +131,7 @@ module.exports = {
                 if (astUtils.isOpeningParenToken(firstTokenOfParam)) {
                     context.report({
                         node,
-                        message: asNeededMessage,
+                        messageId: "unexpectedParens",
                         fix: fixParamsWithParenthesis
                     });
                 }
@@ -141,7 +145,7 @@ module.exports = {
                 if (after.value !== ")") {
                     context.report({
                         node,
-                        message,
+                        messageId: "expectedParens",
                         fix(fixer) {
                             return fixer.replaceText(firstTokenOfParam, `(${firstTokenOfParam.value})`);
                         }

package/lib/rules/arrow-spacing.js

@@ -38,7 +38,15 @@ module.exports = {
                 },
                 additionalProperties: false
             }
-        ]
+        ],
+
+        messages: {
+            expectedBefore: "Missing space before =>.",
+            unexpectedBefore: "Unexpected space before =>.",
+
+            expectedAfter: "Missing space after =>.",
+            unexpectedAfter: "Unexpected space after =>."
+        }
     },
 
     create(context) {
@@ -96,7 +104,7 @@ module.exports = {
                 if (countSpace.before === 0) {
                     context.report({
                         node: tokens.before,
-                        message: "Missing space before =>.",
+                        messageId: "expectedBefore",
                         fix(fixer) {
                             return fixer.insertTextBefore(tokens.arrow, " ");
                         }
@@ -108,7 +116,7 @@ module.exports = {
                 if (countSpace.before > 0) {
                     context.report({
                         node: tokens.before,
-                        message: "Unexpected space before =>.",
+                        messageId: "unexpectedBefore",
                         fix(fixer) {
                             return fixer.removeRange([tokens.before.range[1], tokens.arrow.range[0]]);
                         }
@@ -122,7 +130,7 @@ module.exports = {
                 if (countSpace.after === 0) {
                     context.report({
                         node: tokens.after,
-                        message: "Missing space after =>.",
+                        messageId: "expectedAfter",
                         fix(fixer) {
                             return fixer.insertTextAfter(tokens.arrow, " ");
                         }
@@ -134,7 +142,7 @@ module.exports = {
                 if (countSpace.after > 0) {
                     context.report({
                         node: tokens.after,
-                        message: "Unexpected space after =>.",
+                        messageId: "unexpectedAfter",
                         fix(fixer) {
                             return fixer.removeRange([tokens.arrow.range[1], tokens.after.range[0]]);
                         }

package/lib/rules/block-scoped-var.js

@@ -17,7 +17,11 @@ module.exports = {
             url: "https://eslint.org/docs/rules/block-scoped-var"
         },
 
-        schema: []
+        schema: [],
+
+        messages: {
+            outOfScope: "'{{name}}' used outside of binding context."
+        }
     },
 
     create(context) {
@@ -48,7 +52,7 @@ module.exports = {
         function report(reference) {
             const identifier = reference.identifier;
 
-            context.report({ node: identifier, message: "'{{name}}' used outside of binding context.", data: { name: identifier.name } });
+            context.report({ node: identifier, messageId: "outOfScope", data: { name: identifier.name } });
         }
 
         /**

package/lib/rules/block-spacing.js

@@ -24,12 +24,17 @@ module.exports = {
 
         schema: [
             { enum: ["always", "never"] }
-        ]
+        ],
+
+        messages: {
+            missing: "Requires a space {{location}} '{{token}}'",
+            extra: "Unexpected space(s) {{location}} '{{token}}'"
+        }
     },
 
     create(context) {
         const always = (context.options[0] !== "never"),
-            message = always ? "Requires a space" : "Unexpected space(s)",
+            messageId = always ? "missing" : "extra",
             sourceCode = context.getSourceCode();
 
         /**
@@ -98,9 +103,10 @@ module.exports = {
                 context.report({
                     node,
                     loc: openBrace.loc.start,
-                    message: "{{message}} after '{'.",
+                    messageId,
                     data: {
-                        message
+                        location: "after",
+                        token: openBrace.value
                     },
                     fix(fixer) {
                         if (always) {
@@ -115,9 +121,10 @@ module.exports = {
                 context.report({
                     node,
                     loc: closeBrace.loc.start,
-                    message: "{{message}} before '}'.",
+                    messageId,
                     data: {
-                        message
+                        location: "before",
+                        token: closeBrace.value
                     },
                     fix(fixer) {
                         if (always) {

package/lib/rules/brace-style.js

@@ -35,7 +35,16 @@ module.exports = {
             }
         ],
 
-        fixable: "whitespace"
+        fixable: "whitespace",
+
+        messages: {
+            nextLineOpen: "Opening curly brace does not appear on the same line as controlling statement.",
+            sameLineOpen: "Opening curly brace appears on the same line as controlling statement.",
+            blockSameLine: "Statement inside of curly braces should be on next line.",
+            nextLineClose: "Closing curly brace does not appear on the same line as the subsequent block.",
+            singleLineClose: "Closing curly brace should be on the same line as opening curly brace or on the line after the previous block.",
+            sameLineClose: "Closing curly brace appears on the same line as the subsequent block."
+        }
     },
 
     create(context) {
@@ -43,13 +52,6 @@ module.exports = {
             params = context.options[1] || {},
             sourceCode = context.getSourceCode();
 
-        const OPEN_MESSAGE = "Opening curly brace does not appear on the same line as controlling statement.",
-            OPEN_MESSAGE_ALLMAN = "Opening curly brace appears on the same line as controlling statement.",
-            BODY_MESSAGE = "Statement inside of curly braces should be on next line.",
-            CLOSE_MESSAGE = "Closing curly brace does not appear on the same line as the subsequent block.",
-            CLOSE_MESSAGE_SINGLE = "Closing curly brace should be on the same line as opening curly brace or on the line after the previous block.",
-            CLOSE_MESSAGE_STROUSTRUP_ALLMAN = "Closing curly brace appears on the same line as the subsequent block.";
-
         //--------------------------------------------------------------------------
         // Helpers
         //--------------------------------------------------------------------------
@@ -86,7 +88,7 @@ module.exports = {
             if (style !== "allman" && !astUtils.isTokenOnSameLine(tokenBeforeOpeningCurly, openingCurly)) {
                 context.report({
                     node: openingCurly,
-                    message: OPEN_MESSAGE,
+                    messageId: "nextLineOpen",
                     fix: removeNewlineBetween(tokenBeforeOpeningCurly, openingCurly)
                 });
             }
@@ -94,7 +96,7 @@ module.exports = {
             if (style === "allman" && astUtils.isTokenOnSameLine(tokenBeforeOpeningCurly, openingCurly) && !singleLineException) {
                 context.report({
                     node: openingCurly,
-                    message: OPEN_MESSAGE_ALLMAN,
+                    messageId: "sameLineOpen",
                     fix: fixer => fixer.insertTextBefore(openingCurly, "\n")
                 });
             }
@@ -102,7 +104,7 @@ module.exports = {
             if (astUtils.isTokenOnSameLine(openingCurly, tokenAfterOpeningCurly) && tokenAfterOpeningCurly !== closingCurly && !singleLineException) {
                 context.report({
                     node: openingCurly,
-                    message: BODY_MESSAGE,
+                    messageId: "blockSameLine",
                     fix: fixer => fixer.insertTextAfter(openingCurly, "\n")
                 });
             }
@@ -110,7 +112,7 @@ module.exports = {
             if (tokenBeforeClosingCurly !== openingCurly && !singleLineException && astUtils.isTokenOnSameLine(tokenBeforeClosingCurly, closingCurly)) {
                 context.report({
                     node: closingCurly,
-                    message: CLOSE_MESSAGE_SINGLE,
+                    messageId: "singleLineClose",
                     fix: fixer => fixer.insertTextBefore(closingCurly, "\n")
                 });
             }
@@ -127,7 +129,7 @@ module.exports = {
             if (style === "1tbs" && !astUtils.isTokenOnSameLine(curlyToken, keywordToken)) {
                 context.report({
                     node: curlyToken,
-                    message: CLOSE_MESSAGE,
+                    messageId: "nextLineClose",
                     fix: removeNewlineBetween(curlyToken, keywordToken)
                 });
             }
@@ -135,7 +137,7 @@ module.exports = {
             if (style !== "1tbs" && astUtils.isTokenOnSameLine(curlyToken, keywordToken)) {
                 context.report({
                     node: curlyToken,
-                    message: CLOSE_MESSAGE_STROUSTRUP_ALLMAN,
+                    messageId: "sameLineClose",
                     fix: fixer => fixer.insertTextAfter(curlyToken, "\n")
                 });
             }

package/lib/rules/callback-return.js

@@ -20,7 +20,11 @@ module.exports = {
         schema: [{
             type: "array",
             items: { type: "string" }
-        }]
+        }],
+
+        messages: {
+            missingReturn: "Expected return with your callback function."
+        }
     },
 
     create(context) {
@@ -166,7 +170,7 @@ module.exports = {
 
                 // as long as you're the child of a function at this point you should be asked to return
                 if (findClosestParentOfType(node, ["FunctionDeclaration", "FunctionExpression", "ArrowFunctionExpression"])) {
-                    context.report({ node, message: "Expected return with your callback function." });
+                    context.report({ node, messageId: "missingReturn" });
                 }
 
             }

package/lib/rules/camelcase.js

@@ -28,7 +28,11 @@ module.exports = {
                 },
                 additionalProperties: false
             }
-        ]
+        ],
+
+        messages: {
+            notCamelCase: "Identifier '{{name}}' is not in camel case."
+        }
     },
 
     create(context) {
@@ -62,7 +66,7 @@ module.exports = {
         function report(node) {
             if (reported.indexOf(node) < 0) {
                 reported.push(node);
-                context.report({ node, message: "Identifier '{{name}}' is not in camel case.", data: { name: node.name } });
+                context.report({ node, messageId: "notCamelCase", data: { name: node.name } });
             }
         }
 

package/lib/rules/capitalized-comments.js

@@ -15,9 +15,7 @@ const astUtils = require("../ast-utils");
 // Helpers
 //------------------------------------------------------------------------------
 
-const ALWAYS_MESSAGE = "Comments should not begin with a lowercase character",
-    NEVER_MESSAGE = "Comments should not begin with an uppercase character",
-    DEFAULT_IGNORE_PATTERN = astUtils.COMMENTS_IGNORE_PATTERN,
+const DEFAULT_IGNORE_PATTERN = astUtils.COMMENTS_IGNORE_PATTERN,
     WHITESPACE = /\s/g,
     MAYBE_URL = /^\s*[^:/?#\s]+:\/\/[^?#]/, // TODO: Combine w/ max-len pattern?
     DEFAULTS = {
@@ -132,7 +130,12 @@ module.exports = {
                     }
                 ]
             }
-        ]
+        ],
+
+        messages: {
+            unexpectedLowercaseComment: "Comments should not begin with a lowercase character",
+            unexpectedUppercaseComment: "Comments should not begin with an uppercase character"
+        }
     },
 
     create(context) {
@@ -267,14 +270,14 @@ module.exports = {
                 commentValid = isCommentValid(comment, options);
 
             if (!commentValid) {
-                const message = capitalize === "always"
-                    ? ALWAYS_MESSAGE
-                    : NEVER_MESSAGE;
+                const messageId = capitalize === "always"
+                    ? "unexpectedLowercaseComment"
+                    : "unexpectedUppercaseComment";
 
                 context.report({
                     node: null, // Intentionally using loc instead
                     loc: comment.loc,
-                    message,
+                    messageId,
                     fix(fixer) {
                         const match = comment.value.match(LETTER_PATTERN);
 

package/lib/rules/class-methods-use-this.js

@@ -28,7 +28,11 @@ module.exports = {
                 }
             },
             additionalProperties: false
-        }]
+        }],
+
+        messages: {
+            missingThis: "Expected 'this' to be used by class method '{{name}}'."
+        }
     },
     create(context) {
         const config = context.options[0] ? Object.assign({}, context.options[0]) : {};
@@ -80,9 +84,9 @@ module.exports = {
             if (isIncludedInstanceMethod(node.parent) && !methodUsesThis) {
                 context.report({
                     node,
-                    message: "Expected 'this' to be used by class method '{{classMethod}}'.",
+                    messageId: "missingThis",
                     data: {
-                        classMethod: node.parent.key.name
+                        name: node.parent.key.name
                     }
                 });
             }