Breaking: Update no-missing-placeholders rule to also apply to suggestion messages

Author: bmish

lib/rules/no-missing-placeholders.js

@@ -45,33 +45,52 @@ module.exports = {
           node.callee.property.type === 'Identifier' && node.callee.property.name === 'report'
         ) {
           const reportInfo = utils.getReportInfo(node.arguments, context);
-          if (!reportInfo || !reportInfo.message) {
+          if (!reportInfo) {
             return;
           }
 
-          const messageStaticValue = getStaticValue(reportInfo.message, context.getScope());
-          if (
-            (
-              (reportInfo.message.type === 'Literal' && typeof reportInfo.message.value === 'string') ||
-              (messageStaticValue && typeof messageStaticValue.value === 'string')
-            ) &&
-            (!reportInfo.data || reportInfo.data.type === 'ObjectExpression')
-          ) {
-            // Same regex as the one ESLint uses
-            // https://github.com/eslint/eslint/blob/e5446449d93668ccbdb79d78cc69f165ce4fde07/lib/eslint.js#L990
-            const PLACEHOLDER_MATCHER = /{{\s*([^{}]+?)\s*}}/g;
-            let match;
+          // Collect all violation/suggestion message nodes into a standardized array.
+          const messagesAndDataArray = [
+            // Violation message
+            { message: reportInfo.message, data: reportInfo.data },
+            // Suggestion messages
+            ...((reportInfo.suggest && reportInfo.suggest.elements) || [])
+              .map(suggestObjNode => {
+                const propertyNodeDesc = suggestObjNode.properties.find(prop => prop.key.type === 'Identifier' && prop.key.name === 'desc');
+                const propertyNodeData = suggestObjNode.properties.find(prop => prop.key.type === 'Identifier' && prop.key.name === 'data');
+                return {
+                  message: propertyNodeDesc ? propertyNodeDesc.value : undefined,
+                  data: propertyNodeData ? propertyNodeData.value : undefined,
+                };
+              }
+              ),
+          ].filter(obj => obj.message);
+
+          for (const { message, data } of messagesAndDataArray) {
+            const messageStaticValue = getStaticValue(message, context.getScope());
+            if (
+              (
+                (message.type === 'Literal' && typeof message.value === 'string') ||
+                (messageStaticValue && typeof messageStaticValue.value === 'string')
+              ) &&
+              (!data || data.type === 'ObjectExpression')
+            ) {
+              // Same regex as the one ESLint uses
+              // https://github.com/eslint/eslint/blob/e5446449d93668ccbdb79d78cc69f165ce4fde07/lib/eslint.js#L990
+              const PLACEHOLDER_MATCHER = /{{\s*([^{}]+?)\s*}}/g;
+              let match;
 
-            while ((match = PLACEHOLDER_MATCHER.exec(reportInfo.message.value || messageStaticValue.value))) { // eslint-disable-line no-extra-parens
-              const matchingProperty = reportInfo.data &&
-                reportInfo.data.properties.find(prop => utils.getKeyName(prop) === match[1]);
+              while ((match = PLACEHOLDER_MATCHER.exec(message.value || messageStaticValue.value))) { // eslint-disable-line no-extra-parens
+                const matchingProperty = data &&
+                  data.properties.find(prop => utils.getKeyName(prop) === match[1]);
 
-              if (!matchingProperty) {
-                context.report({
-                  node: reportInfo.message,
-                  messageId: 'placeholderDoesNotExist',
-                  data: { missingKey: match[1] },
-                });
+                if (!matchingProperty) {
+                  context.report({
+                    node: message,
+                    messageId: 'placeholderDoesNotExist',
+                    data: { missingKey: match[1] },
+                  });
+                }
               }
             }
           }

tests/lib/rules/no-missing-placeholders.js

@@ -128,6 +128,24 @@ ruleTester.run('no-missing-placeholders', rule, {
         context.report(node, MESSAGE, { baz: 'qux' });
       };
     `,
+    // Suggestion with placeholder
+    `
+      module.exports = {
+        create(context) {
+          context.report({
+            node,
+            suggest: [
+              {
+                desc: 'Remove {{functionName}}',
+                data: {
+                  functionName: 'foo'
+                }
+              }
+            ]
+          });
+        }
+      };
+    `,
   ],
 
   invalid: [
@@ -212,5 +230,45 @@ ruleTester.run('no-missing-placeholders', rule, {
       `,
       errors: [error('bar')],
     },
+
+    {
+      // Suggestion (no `data`)
+      code: `
+        module.exports = {
+          create(context) {
+            context.report({
+              node,
+              suggest: [
+                {
+                  desc: 'Remove {{bar}}'
+                }
+              ]
+            });
+          }
+        };
+      `,
+      errors: [error('bar')],
+    },
+    {
+      // Suggestion (`data` but missing placeholder)
+      code: `
+        module.exports = {
+          create(context) {
+            context.report({
+              node,
+              suggest: [
+                {
+                  desc: 'Remove {{bar}}',
+                  data: {
+                    notBar: 'abc'
+                  }
+                }
+              ]
+            });
+          }
+        };
+      `,
+      errors: [error('bar')],
+    },
   ],
 });