require-meta-docs-suggestion: improve reporting location and improve handling of empty suggest array

Author: bmish

lib/rules/require-meta-docs-suggestion.js

@@ -39,11 +39,17 @@ module.exports = {
           node.callee.property.name === 'report' &&
           (node.arguments.length > 4 || (
             node.arguments.length === 1 &&
-            node.arguments[0].type === 'ObjectExpression' &&
-            node.arguments[0].properties.some(prop => utils.getKeyName(prop) === 'suggest')
+            node.arguments[0].type === 'ObjectExpression'
           ))
         ) {
-          ruleReportsSuggestions = true;
+          const suggestProp = node.arguments[0].properties.find(prop => utils.getKeyName(prop) === 'suggest');
+          if (suggestProp && (suggestProp.value.type !== 'ArrayExpression' || (suggestProp.value.type === 'ArrayExpression' && suggestProp.value.elements.length > 0))) {
+            // These are all considered reporting suggestions:
+            //   suggest: [{...}]
+            //   suggest: getSuggestions()
+            //   suggest: MY_SUGGESTIONS
+            ruleReportsSuggestions = true;
+          }
         }
       },
       'Program:exit' () {
@@ -58,7 +64,7 @@ module.exports = {
         if (ruleReportsSuggestions) {
           if (!suggestionProperty) {
             // Rule reports suggestions but is missing the `meta.docs.suggestion` property altogether.
-            context.report({ node: ruleInfo.create, messageId: 'shouldBeSuggestable' });
+            context.report({ node: docsNode ? docsNode.value : ruleInfo.meta ? ruleInfo.meta : ruleInfo.create, messageId: 'shouldBeSuggestable' });
           } else if (suggestionPropertyValue !== true) {
             // Rule reports suggestions but does not have `meta.docs.suggestion` property enabled.
             context.report({ node: suggestionProperty.value, messageId: 'shouldBeSuggestable' });

tests/lib/rules/require-meta-docs-suggestion.js

@@ -15,6 +15,12 @@ const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 6 } });
 ruleTester.run('require-meta-docs-suggestion', rule, {
   valid: [
     'module.exports = context => {};',
+    // No suggestions reported, no violations reported, no meta object.
+    `
+      module.exports = {
+        create(context) {}
+      };
+    `,
     // No suggestions reported, no violations reported, no docs object.
     `
       module.exports = {
@@ -49,6 +55,15 @@ ruleTester.run('require-meta-docs-suggestion', rule, {
       }
     };
     `,
+    // No suggestions reported (empty suggest array), no suggestion property.
+    `
+    module.exports = {
+      meta: { docs: {} },
+      create(context) {
+        context.report({node, message, suggest:[]});
+      }
+    };
+    `,
     // No suggestions reported, suggestion property set to false.
     `
     module.exports = {
@@ -63,7 +78,16 @@ ruleTester.run('require-meta-docs-suggestion', rule, {
       module.exports = {
         meta: { docs: { suggestion: true } },
         create(context) {
-          context.report({node, message, suggest: []});
+          context.report({node, message, suggest: [{}]});
+        }
+      };
+    `,
+    // Provides *dynamic* suggestions, has suggestion property.
+    `
+      module.exports = {
+        meta: { docs: { suggestion: true } },
+        create(context) {
+          context.report({node, message, suggest: getSuggestions()});
         }
       };
     `,
@@ -85,44 +109,53 @@ ruleTester.run('require-meta-docs-suggestion', rule, {
 
   invalid: [
     {
-      // Reports suggestions, no suggestion property, no docs object.
+      // Reports suggestions, no meta object, violation should be on create function.
+      code: `
+        module.exports = {
+          create(context) { context.report({node, message, suggest: [{}]}); }
+        };
+      `,
+      errors: [{ messageId: 'shouldBeSuggestable', type: 'FunctionExpression', line: 3, column: 17, endLine: 3, endColumn: 78 }],
+    },
+    {
+      // Reports suggestions, no docs object, violation should be on meta object.
       code: `
         module.exports = {
           meta: {},
-          create(context) { context.report({node, message, suggest: []}); }
+          create(context) { context.report({node, message, suggest: [{}]}); }
         };
       `,
-      errors: [{ messageId: 'shouldBeSuggestable', type: 'FunctionExpression' }],
+      errors: [{ messageId: 'shouldBeSuggestable', type: 'ObjectExpression', line: 3, column: 17, endLine: 3, endColumn: 19 }],
     },
     {
-      // Reports suggestions, no suggestion property, with docs object.
+      // Reports suggestions, no suggestion property, violation should be on docs object
       code: `
         module.exports = {
           meta: { docs: {} },
-          create(context) { context.report({node, loc, message, data, suggest: []}); }
+          create(context) { context.report({node, loc, message, data, suggest: [{}]}); }
         };
       `,
-      errors: [{ messageId: 'shouldBeSuggestable', type: 'FunctionExpression' }],
+      errors: [{ messageId: 'shouldBeSuggestable', type: 'ObjectExpression', line: 3, column: 25, endLine: 3, endColumn: 27 }],
     },
     {
-      // Reports suggestions, suggestion property set to false.
+      // Reports suggestions, suggestion property set to false, violation should be on `false`
       code: `
         module.exports = {
           meta: { docs: { suggestion: false } },
-          create(context) { context.report({node, message, suggest: []}); }
+          create(context) { context.report({node, message, suggest: [{}]}); }
         };
       `,
-      errors: [{ messageId: 'shouldBeSuggestable', type: 'Literal' }],
+      errors: [{ messageId: 'shouldBeSuggestable', type: 'Literal', line: 3, column: 39, endLine: 3, endColumn: 44 }],
     },
     {
-      // Does not report suggestions, suggestion property set to true.
+      // Does not report suggestions, suggestion property set to true, violation should be on `true`
       code: `
         module.exports = {
           meta: { docs: { suggestion: true } },
           create(context) { context.report({node, message}); }
         };
       `,
-      errors: [{ messageId: 'shouldNotBeSuggestable', type: 'Literal' }],
+      errors: [{ messageId: 'shouldNotBeSuggestable', type: 'Literal', line: 3, column: 39, endLine: 3, endColumn: 43 }],
     },
   ],
 });