Breaking: Update report-message-format to also apply to suggestion …

…messages (#195)
eslint-community · Sep 27, 2021 · 720cfc2 · 720cfc2
1 parent d85c446
commit 720cfc2
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 3 deletions.
diff --git a/lib/rules/report-message-format.js b/lib/rules/report-message-format.js
@@ -83,12 +83,19 @@ module.exports = {
         ) {
           const reportInfo = utils.getReportInfo(node.arguments, context);
           const message = reportInfo && reportInfo.message;
+          const suggest = reportInfo && reportInfo.suggest;
 
-          if (!message) {
-            return;
+          if (message) {
+            processMessageNode(message);
           }
 
-          processMessageNode(message);
+          if (suggest && suggest.type === 'ArrayExpression') {
+            suggest.elements
+              .flatMap(obj => obj.properties)
+              .filter(prop => prop.type === 'Property' && prop.key.type === 'Identifier' && prop.key.name === 'message')
+              .map(prop => prop.value)
+              .forEach(processMessageNode);
+          }
         }
       },
     };

diff --git a/tests/lib/rules/report-message-format.js b/tests/lib/rules/report-message-format.js
@@ -109,6 +109,28 @@ ruleTester.run('report-message-format', rule, {
       `,
       options: ['^foo$'],
     },
+    {
+      // Suggestion message
+      code: `
+        module.exports = {
+          create(context) {
+            context.report({node, suggest: [{message: 'foo'}]});
+          }
+        };
+      `,
+      options: ['^foo$'],
+    },
+    {
+      // Suggestion message with ternary expression
+      code: `
+        module.exports = {
+          create(context) {
+            context.report({node, suggest: foo ? []: [{}]});
+          }
+        };
+      `,
+      options: ['^foo$'],
+    },
     {
       code: `
         module.exports = {
@@ -250,6 +272,17 @@ ruleTester.run('report-message-format', rule, {
       `,
       options: ['foo'],
     },
+    {
+      // Suggestion message
+      code: `
+        module.exports = {
+          create(context) {
+            context.report({node, suggest: [{message: 'FOO'}]});
+          }
+        };
+      `,
+      options: ['foo'],
+    },
     {
       code: `
         module.exports = {