Chore: use ids for messages

lib/rules/no-invalid-regexp.js

@@ -39,9 +39,11 @@ module.exports = {
                 }
             },
             additionalProperties: false
-        }]
+        }],
 
-        // no messages, because the error text comes directly from the regexpp module
+        messages: {
+            regexMessage: "{{message}}."
+        }
     },
 
     create(context) {
@@ -118,7 +120,7 @@ module.exports = {
                 if (message) {
                     context.report({
                         node,
-                        message: "{{message}}.",
+                        messageId: "regexMessage",
                         data: { message }
                     });
                 }

lib/rules/no-native-reassign.js

@@ -37,7 +37,11 @@ module.exports = {
                 },
                 additionalProperties: false
             }
-        ]
+        ],
+
+        messages: {
+            nativeReassign: "Read-only global '{{name}}' should not be modified."
+        }
     },
 
     create(context) {
@@ -65,7 +69,7 @@ module.exports = {
             ) {
                 context.report({
                     node: identifier,
-                    message: "Read-only global '{{name}}' should not be modified.",
+                    messageId: "nativeReassign",
                     data: identifier
                 });
             }

lib/rules/no-negated-in-lhs.js

@@ -24,7 +24,11 @@ module.exports = {
         replacedBy: ["no-unsafe-negation"],
 
         deprecated: true,
-        schema: []
+        schema: [],
+
+        messages: {
+            negatedLHS: "The 'in' expression's left operand is negated."
+        }
     },
 
     create(context) {
@@ -33,7 +37,7 @@ module.exports = {
 
             BinaryExpression(node) {
                 if (node.operator === "in" && node.left.type === "UnaryExpression" && node.left.operator === "!") {
-                    context.report({ node, message: "The 'in' expression's left operand is negated." });
+                    context.report({ node, messageId: "negatedLHS" });
                 }
             }
         };

lib/rules/no-process-env.js

@@ -19,7 +19,11 @@ module.exports = {
             url: "https://eslint.org/docs/rules/no-process-env"
         },
 
-        schema: []
+        schema: [],
+
+        messages: {
+            unexpectedProcessEnv: "Unexpected use of process.env."
+        }
     },
 
     create(context) {
@@ -31,7 +35,7 @@ module.exports = {
                     propertyName = node.property.name;
 
                 if (objectName === "process" && !node.computed && propertyName && propertyName === "env") {
-                    context.report({ node, message: "Unexpected use of process.env." });
+                    context.report({ node, messageId: "unexpectedProcessEnv" });
                 }
 
             }

lib/rules/no-process-exit.js

@@ -19,7 +19,11 @@ module.exports = {
             url: "https://eslint.org/docs/rules/no-process-exit"
         },
 
-        schema: []
+        schema: [],
+
+        messages: {
+            noProcessExit: "Don't use process.exit(); throw an error instead."
+        }
     },
 
     create(context) {
@@ -30,7 +34,7 @@ module.exports = {
 
         return {
             "CallExpression > MemberExpression.callee[object.name = 'process'][property.name = 'exit']"(node) {
-                context.report({ node: node.parent, message: "Don't use process.exit(); throw an error instead." });
+                context.report({ node: node.parent, messageId: "noProcessExit" });
             }
         };
 

lib/rules/no-proto.js

@@ -26,7 +26,11 @@ module.exports = {
             url: "https://eslint.org/docs/rules/no-proto"
         },
 
-        schema: []
+        schema: [],
+
+        messages: {
+            unexpectedProto: "The '__proto__' property is deprecated."
+        }
     },
 
     create(context) {
@@ -35,7 +39,7 @@ module.exports = {
 
             MemberExpression(node) {
                 if (getStaticPropertyName(node) === "__proto__") {
-                    context.report({ node, message: "The '__proto__' property is deprecated." });
+                    context.report({ node, messageId: "unexpectedProto" });
                 }
             }
         };

lib/rules/no-prototype-builtins.js

@@ -19,7 +19,11 @@ module.exports = {
             url: "https://eslint.org/docs/rules/no-prototype-builtins"
         },
 
-        schema: []
+        schema: [],
+
+        messages: {
+            prototypeBuildIn: "Do not access Object.prototype method '{{prop}}' from target object."
+        }
     },
 
     create(context) {
@@ -42,7 +46,7 @@ module.exports = {
 
             if (DISALLOWED_PROPS.indexOf(propName) > -1) {
                 context.report({
-                    message: "Do not access Object.prototype method '{{prop}}' from target object.",
+                    messageId: "prototypeBuildIn",
                     loc: node.callee.property.loc.start,
                     data: { prop: propName },
                     node

lib/rules/no-regex-spaces.js

@@ -45,7 +45,11 @@ module.exports = {
         },
 
         schema: [],
-        fixable: "code"
+        fixable: "code",
+
+        messages: {
+            multipleSpaces: "Spaces are hard to count. Use {{{length}}}."
+        }
     },
 
     create(context) {
@@ -96,7 +100,7 @@ module.exports = {
                 ) {
                     context.report({
                         node: nodeToReport,
-                        message: "Spaces are hard to count. Use {{{length}}}.",
+                        messageId: "multipleSpaces",
                         data: { length },
                         fix(fixer) {
                             if (pattern !== rawPattern) {

lib/rules/no-restricted-modules.js

@@ -4,13 +4,6 @@
  */
 "use strict";
 
-//------------------------------------------------------------------------------
-// Helpers
-//------------------------------------------------------------------------------
-
-const DEFAULT_MESSAGE_TEMPLATE = "'{{moduleName}}' module is restricted from being used.";
-const CUSTOM_MESSAGE_TEMPLATE = "'{{moduleName}}' module is restricted from being used. {{customMessage}}";
-
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -72,6 +65,13 @@ module.exports = {
                     additionalItems: false
                 }
             ]
+        },
+
+        messages: {
+            defaultMessage: "'{{name}}' module is restricted from being used.",
+            // eslint-disable-next-line eslint-plugin/report-message-format
+            customMessage: "'{{name}}' module is restricted from being used. {{customMessage}}",
+            patternMessage: "'{{name}}' module is restricted from being used by a pattern."
         }
     },
 
@@ -126,17 +126,17 @@ module.exports = {
          * @private
          */
         function reportPath(node) {
-            const moduleName = node.arguments[0].value.trim();
-            const customMessage = restrictedPathMessages[moduleName];
-            const message = customMessage
-                ? CUSTOM_MESSAGE_TEMPLATE
-                : DEFAULT_MESSAGE_TEMPLATE;
+            const name = node.arguments[0].value.trim();
+            const customMessage = restrictedPathMessages[name];
+            const messageId = customMessage
+                ? "customMessage"
+                : "defaultMessage";
 
             context.report({
                 node,
-                message,
+                messageId,
                 data: {
-                    moduleName,
+                    name,
                     customMessage
                 }
             });
@@ -158,18 +158,18 @@ module.exports = {
 
                     // node has arguments and first argument is string
                     if (node.arguments.length && isString(node.arguments[0])) {
-                        const moduleName = node.arguments[0].value.trim();
+                        const name = node.arguments[0].value.trim();
 
                         // check if argument value is in restricted modules array
-                        if (isRestrictedPath(moduleName)) {
+                        if (isRestrictedPath(name)) {
                             reportPath(node);
                         }
 
-                        if (restrictedPatterns.length > 0 && ig.ignores(moduleName)) {
+                        if (restrictedPatterns.length > 0 && ig.ignores(name)) {
                             context.report({
                                 node,
-                                message: "'{{moduleName}}' module is restricted from being used by a pattern.",
-                                data: { moduleName }
+                                messageId: "patternMessage",
+                                data: { name }
                             });
                         }
                     }

lib/rules/no-restricted-properties.js

@@ -61,6 +61,13 @@ module.exports = {
                 ]
             },
             uniqueItems: true
+        },
+
+        messages: {
+            // eslint-disable-next-line eslint-plugin/report-message-format
+            restrictedObjectProperty: "'{{objectName}}.{{propertyName}}' is restricted from being used.{{message}}",
+            // eslint-disable-next-line eslint-plugin/report-message-format
+            restrictedProperty: "'{{propertyName}}' is restricted from being used.{{message}}"
         }
     },
 
@@ -114,8 +121,7 @@ module.exports = {
 
                 context.report({
                     node,
-                    // eslint-disable-next-line eslint-plugin/report-message-format
-                    message: "'{{objectName}}.{{propertyName}}' is restricted from being used.{{message}}",
+                    messageId: "restrictedObjectProperty",
                     data: {
                         objectName,
                         propertyName,
@@ -127,8 +133,7 @@ module.exports = {
 
                 context.report({
                     node,
-                    // eslint-disable-next-line eslint-plugin/report-message-format
-                    message: "'{{propertyName}}' is restricted from being used.{{message}}",
+                    messageId: "restrictedProperty",
                     data: {
                         propertyName,
                         message

lib/rules/no-restricted-syntax.js

@@ -39,6 +39,11 @@ module.exports = {
             },
             uniqueItems: true,
             minItems: 0
+        },
+
+        messages: {
+            // eslint-disable-next-line eslint-plugin/report-message-format
+            restrictedSyntax: "{{message}}"
         }
     },
 
@@ -48,14 +53,14 @@ module.exports = {
             const hasCustomMessage = !isStringFormat && Boolean(selectorOrObject.message);
 
             const selector = isStringFormat ? selectorOrObject : selectorOrObject.selector;
-            const message = hasCustomMessage ? selectorOrObject.message : "Using '{{selector}}' is not allowed.";
+            const message = hasCustomMessage ? selectorOrObject.message : `Using '${selector}' is not allowed.`;
 
             return Object.assign(result, {
                 [selector](node) {
                     context.report({
                         node,
-                        message,
-                        data: hasCustomMessage ? {} : { selector }
+                        messageId: "restrictedSyntax",
+                        data: { message }
                     });
                 }
             });

lib/rules/no-return-assign.js

@@ -35,7 +35,12 @@ module.exports = {
             {
                 enum: ["except-parens", "always"]
             }
-        ]
+        ],
+
+        messages: {
+            returnAssignment: "Return statement should not contain assignment.",
+            arrowAssignment: "Arrow function should not return assignment."
+        }
     },
 
     create(context) {
@@ -61,12 +66,12 @@ module.exports = {
                 if (parent && parent.type === "ReturnStatement") {
                     context.report({
                         node: parent,
-                        message: "Return statement should not contain assignment."
+                        messageId: "returnAssignment"
                     });
                 } else if (parent && parent.type === "ArrowFunctionExpression" && parent.body === currentChild) {
                     context.report({
                         node: parent,
-                        message: "Arrow function should not return assignment."
+                        messageId: "arrowAssignment"
                     });
                 }
             }

lib/rules/no-return-await.js

@@ -10,8 +10,6 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
-const message = "Redundant use of `await` on a return value.";
-
 module.exports = {
     meta: {
         type: "suggestion",
@@ -28,7 +26,11 @@ module.exports = {
         fixable: null,
 
         schema: [
-        ]
+        ],
+
+        messages: {
+            redundantUseOfAwait: "Redundant use of `await` on a return value."
+        }
     },
 
     create(context) {
@@ -42,7 +44,7 @@ module.exports = {
             context.report({
                 node: context.getSourceCode().getFirstToken(node),
                 loc: node.loc,
-                message
+                messageId: "redundantUseOfAwait"
             });
         }
 

lib/rules/no-script-url.js

@@ -22,7 +22,11 @@ module.exports = {
             url: "https://eslint.org/docs/rules/no-script-url"
         },
 
-        schema: []
+        schema: [],
+
+        messages: {
+            unexpectedScriptURL: "Script URL is a form of eval."
+        }
     },
 
     create(context) {
@@ -34,7 +38,7 @@ module.exports = {
                     const value = node.value.toLowerCase();
 
                     if (value.indexOf("javascript:") === 0) {
-                        context.report({ node, message: "Script URL is a form of eval." });
+                        context.report({ node, messageId: "unexpectedScriptURL" });
                     }
                 }
             }