Chore: Refactor to use messageId in a number of rules (#12715)

* Chore: Refactor to use messageId in a number of rules * Chore: use variable for customMessage in no-restricted-global test
eslint · Jan 7, 2020 · 9dfc850 · 9dfc850
1 parent 1118fce
commit 9dfc850
Show file tree

Hide file tree

Showing 79 changed files with 3,611 additions and 709 deletions.
diff --git a/lib/rules/no-func-assign.js b/lib/rules/no-func-assign.js
@@ -22,7 +22,11 @@ module.exports = {
             url: "https://eslint.org/docs/rules/no-func-assign"
         },
 
-        schema: []
+        schema: [],
+
+        messages: {
+            isAFunction: "'{{name}}' is a function."
+        }
     },
 
     create(context) {
@@ -34,7 +38,13 @@ module.exports = {
          */
         function checkReference(references) {
             astUtils.getModifyingReferences(references).forEach(reference => {
-                context.report({ node: reference.identifier, message: "'{{name}}' is a function.", data: { name: reference.identifier.name } });
+                context.report({
+                    node: reference.identifier,
+                    messageId: "isAFunction",
+                    data: {
+                        name: reference.identifier.name
+                    }
+                });
             });
         }
 

diff --git a/lib/rules/no-global-assign.js b/lib/rules/no-global-assign.js
@@ -32,7 +32,11 @@ module.exports = {
                 },
                 additionalProperties: false
             }
-        ]
+        ],
+
+        messages: {
+            globalShouldNotBeModified: "Read-only global '{{name}}' should not be modified."
+        }
     },
 
     create(context) {
@@ -60,8 +64,10 @@ module.exports = {
             ) {
                 context.report({
                     node: identifier,
-                    message: "Read-only global '{{name}}' should not be modified.",
-                    data: identifier
+                    messageId: "globalShouldNotBeModified",
+                    data: {
+                        name: identifier.name
+                    }
                 });
             }
         }

diff --git a/lib/rules/no-implicit-coercion.js b/lib/rules/no-implicit-coercion.js
@@ -187,7 +187,11 @@ module.exports = {
                 }
             },
             additionalProperties: false
-        }]
+        }],
+
+        messages: {
+            useRecommendation: "use `{{recommendation}}` instead."
+        }
     },
 
     create(context) {
@@ -204,7 +208,7 @@ module.exports = {
         function report(node, recommendation, shouldFix) {
             context.report({
                 node,
-                message: "use `{{recommendation}}` instead.",
+                messageId: "useRecommendation",
                 data: {
                     recommendation
                 },

diff --git a/lib/rules/no-implied-eval.js b/lib/rules/no-implied-eval.js
@@ -20,7 +20,11 @@ module.exports = {
             url: "https://eslint.org/docs/rules/no-implied-eval"
         },
 
-        schema: []
+        schema: [],
+
+        messages: {
+            impliedEval: "Implied eval. Consider passing a function instead of a string."
+        }
     },
 
     create(context) {
@@ -107,7 +111,10 @@ module.exports = {
                 // remove the entire substack, to avoid duplicate reports
                 const substack = impliedEvalAncestorsStack.pop();
 
-                context.report({ node: substack[0], message: "Implied eval. Consider passing a function instead of a string." });
+                context.report({
+                    node: substack[0],
+                    messageId: "impliedEval"
+                });
             }
         }
 

diff --git a/lib/rules/no-inline-comments.js b/lib/rules/no-inline-comments.js
@@ -21,7 +21,11 @@ module.exports = {
             url: "https://eslint.org/docs/rules/no-inline-comments"
         },
 
-        schema: []
+        schema: [],
+
+        messages: {
+            unexpectedInlineComment: "Unexpected comment inline with code."
+        }
     },
 
     create(context) {
@@ -64,7 +68,10 @@ module.exports = {
                 return;
             }
 
-            context.report({ node, message: "Unexpected comment inline with code." });
+            context.report({
+                node,
+                messageId: "unexpectedInlineComment"
+            });
         }
 
         //--------------------------------------------------------------------------

diff --git a/lib/rules/no-inner-declarations.js b/lib/rules/no-inner-declarations.js
@@ -24,7 +24,11 @@ module.exports = {
             {
                 enum: ["functions", "both"]
             }
-        ]
+        ],
+
+        messages: {
+            moveDeclToRoot: "Move {{type}} declaration to {{body}} root."
+        }
     },
 
     create(context) {
@@ -68,7 +72,7 @@ module.exports = {
             if (!valid) {
                 context.report({
                     node,
-                    message: "Move {{type}} declaration to {{body}} root.",
+                    messageId: "moveDeclToRoot",
                     data: {
                         type: (node.type === "FunctionDeclaration" ? "function" : "variable"),
                         body: (body.type === "Program" ? "program" : "function body")

diff --git a/lib/rules/no-invalid-regexp.js b/lib/rules/no-invalid-regexp.js
@@ -40,6 +40,8 @@ module.exports = {
             },
             additionalProperties: false
         }]
+
+        // no messages, because the error text comes directly from the regexpp module
     },
 
     create(context) {

diff --git a/lib/rules/no-invalid-this.js b/lib/rules/no-invalid-this.js
@@ -37,7 +37,11 @@ module.exports = {
                 },
                 additionalProperties: false
             }
-        ]
+        ],
+
+        messages: {
+            unexpectedThis: "Unexpected 'this'."
+        }
     },
 
     create(context) {
@@ -130,7 +134,10 @@ module.exports = {
                 const current = stack.getCurrent();
 
                 if (current && !current.valid) {
-                    context.report({ node, message: "Unexpected 'this'." });
+                    context.report({
+                        node,
+                        messageId: "unexpectedThis"
+                    });
                 }
             }
         };

diff --git a/lib/rules/no-irregular-whitespace.js b/lib/rules/no-irregular-whitespace.js
@@ -59,7 +59,11 @@ module.exports = {
                 },
                 additionalProperties: false
             }
-        ]
+        ],
+
+        messages: {
+            noIrregularWhitespace: "Irregular whitespace not allowed."
+        }
     },
 
     create(context) {
@@ -161,7 +165,11 @@ module.exports = {
                         column: match.index
                     };
 
-                    errors.push({ node, message: "Irregular whitespace not allowed.", loc: location });
+                    errors.push({
+                        node,
+                        messageId: "noIrregularWhitespace",
+                        loc: location
+                    });
                 }
             });
         }
@@ -186,7 +194,11 @@ module.exports = {
                     column: sourceLines[lineIndex].length
                 };
 
-                errors.push({ node, message: "Irregular whitespace not allowed.", loc: location });
+                errors.push({
+                    node,
+                    messageId: "noIrregularWhitespace",
+                    loc: location
+                });
                 lastLineIndex = lineIndex;
             }
         }

diff --git a/lib/rules/no-iterator.js b/lib/rules/no-iterator.js
@@ -20,7 +20,11 @@ module.exports = {
             url: "https://eslint.org/docs/rules/no-iterator"
         },
 
-        schema: []
+        schema: [],
+
+        messages: {
+            noIterator: "Reserved name '__iterator__'."
+        }
     },
 
     create(context) {
@@ -32,7 +36,10 @@ module.exports = {
                 if (node.property &&
                         (node.property.type === "Identifier" && node.property.name === "__iterator__" && !node.computed) ||
                         (node.property.type === "Literal" && node.property.value === "__iterator__")) {
-                    context.report({ node, message: "Reserved name '__iterator__'." });
+                    context.report({
+                        node,
+                        messageId: "noIterator"
+                    });
                 }
             }
         };

diff --git a/lib/rules/no-label-var.js b/lib/rules/no-label-var.js
@@ -26,7 +26,11 @@ module.exports = {
             url: "https://eslint.org/docs/rules/no-label-var"
         },
 
-        schema: []
+        schema: [],
+
+        messages: {
+            identifierClashWithLabel: "Found identifier with same name as label."
+        }
     },
 
     create(context) {
@@ -62,7 +66,10 @@ module.exports = {
                  * with the innermost scope.
                  */
                 if (findIdentifier(scope, node.label.name)) {
-                    context.report({ node, message: "Found identifier with same name as label." });
+                    context.report({
+                        node,
+                        messageId: "identifierClashWithLabel"
+                    });
                 }
             }
 

diff --git a/lib/rules/no-labels.js b/lib/rules/no-labels.js
@@ -40,7 +40,13 @@ module.exports = {
                 },
                 additionalProperties: false
             }
-        ]
+        ],
+
+        messages: {
+            unexpectedLabel: "Unexpected labeled statement.",
+            unexpectedLabelInBreak: "Unexpected label in break statement.",
+            unexpectedLabelInContinue: "Unexpected label in continue statement."
+        }
     },
 
     create(context) {
@@ -113,7 +119,7 @@ module.exports = {
                 if (!isAllowed(scopeInfo.kind)) {
                     context.report({
                         node,
-                        message: "Unexpected labeled statement."
+                        messageId: "unexpectedLabel"
                     });
                 }
 
@@ -124,7 +130,7 @@ module.exports = {
                 if (node.label && !isAllowed(getKind(node.label.name))) {
                     context.report({
                         node,
-                        message: "Unexpected label in break statement."
+                        messageId: "unexpectedLabelInBreak"
                     });
                 }
             },
@@ -133,7 +139,7 @@ module.exports = {
                 if (node.label && !isAllowed(getKind(node.label.name))) {
                     context.report({
                         node,
-                        message: "Unexpected label in continue statement."
+                        messageId: "unexpectedLabelInContinue"
                     });
                 }
             }

diff --git a/lib/rules/no-lone-blocks.js b/lib/rules/no-lone-blocks.js
@@ -20,7 +20,12 @@ module.exports = {
             url: "https://eslint.org/docs/rules/no-lone-blocks"
         },
 
-        schema: []
+        schema: [],
+
+        messages: {
+            redundantBlock: "Block is redundant.",
+            redundantNestedBlock: "Nested block is redundant."
+        }
     },
 
     create(context) {
@@ -35,9 +40,12 @@ module.exports = {
          * @returns {void}
          */
         function report(node) {
-            const message = node.parent.type === "BlockStatement" ? "Nested block is redundant." : "Block is redundant.";
+            const messageId = node.parent.type === "BlockStatement" ? "redundantNestedBlock" : "redundantBlock";
 
-            context.report({ node, message });
+            context.report({
+                node,
+                messageId
+            });
         }
 
         /**

diff --git a/lib/rules/no-lonely-if.js b/lib/rules/no-lonely-if.js
@@ -20,7 +20,11 @@ module.exports = {
         },
 
         schema: [],
-        fixable: "code"
+        fixable: "code",
+
+        messages: {
+            unexpectedLonelyIf: "Unexpected if as the only statement in an else block."
+        }
     },
 
     create(context) {
@@ -38,7 +42,7 @@ module.exports = {
                         parent === grandparent.alternate) {
                     context.report({
                         node,
-                        message: "Unexpected if as the only statement in an else block.",
+                        messageId: "unexpectedLonelyIf",
                         fix(fixer) {
                             const openingElseCurly = sourceCode.getFirstToken(parent);
                             const closingElseCurly = sourceCode.getLastToken(parent);