fix: handle meta properties in spread syntax

Author: bmish

lib/rules/require-meta-fixable.js

@@ -48,6 +48,7 @@ module.exports = {
       context.options[0] && context.options[0].catchNoFixerButFixableProperty;
 
     const sourceCode = context.getSourceCode();
+    const { scopeManager } = sourceCode;
     const ruleInfo = utils.getRuleInfo(sourceCode);
     let contextIdentifiers;
     let usesFixFunctions;
@@ -62,10 +63,7 @@ module.exports = {
 
     return {
       Program(ast) {
-        contextIdentifiers = utils.getContextIdentifiers(
-          sourceCode.scopeManager,
-          ast
-        );
+        contextIdentifiers = utils.getContextIdentifiers(scopeManager, ast);
       },
       CallExpression(node) {
         if (
@@ -86,11 +84,9 @@ module.exports = {
       'Program:exit'() {
         const metaFixableProp =
           ruleInfo &&
-          ruleInfo.meta &&
-          ruleInfo.meta.type === 'ObjectExpression' &&
-          ruleInfo.meta.properties.find(
-            (prop) => utils.getKeyName(prop) === 'fixable'
-          );
+          utils
+            .evaluateObjectProperties(ruleInfo.meta, scopeManager)
+            .find((prop) => utils.getKeyName(prop) === 'fixable');
 
         if (metaFixableProp) {
           const staticValue = getStaticValue(

lib/rules/require-meta-has-suggestions.js

@@ -30,16 +30,14 @@ module.exports = {
 
   create(context) {
     const sourceCode = context.getSourceCode();
+    const { scopeManager } = sourceCode;
     const ruleInfo = utils.getRuleInfo(sourceCode);
     let contextIdentifiers;
     let ruleReportsSuggestions;
 
     return {
       Program(ast) {
-        contextIdentifiers = utils.getContextIdentifiers(
-          sourceCode.scopeManager,
-          ast
-        );
+        contextIdentifiers = utils.getContextIdentifiers(scopeManager, ast);
       },
       CallExpression(node) {
         if (
@@ -78,12 +76,9 @@ module.exports = {
       },
       'Program:exit'() {
         const metaNode = ruleInfo && ruleInfo.meta;
-        const hasSuggestionsProperty =
-          metaNode && metaNode.type === 'ObjectExpression'
-            ? metaNode.properties.find(
-                (prop) => utils.getKeyName(prop) === 'hasSuggestions'
-              )
-            : undefined;
+        const hasSuggestionsProperty = utils
+          .evaluateObjectProperties(metaNode, scopeManager)
+          .find((prop) => utils.getKeyName(prop) === 'hasSuggestions');
         const hasSuggestionsStaticValue =
           hasSuggestionsProperty &&
           getStaticValue(hasSuggestionsProperty.value, context.getScope());

lib/rules/require-meta-schema.js

@@ -64,10 +64,9 @@ module.exports = {
       Program(ast) {
         contextIdentifiers = utils.getContextIdentifiers(scopeManager, ast);
 
-        schemaNode =
-          metaNode &&
-          metaNode.properties &&
-          metaNode.properties.find(
+        schemaNode = utils
+          .evaluateObjectProperties(metaNode, scopeManager)
+          .find(
             (p) => p.type === 'Property' && utils.getKeyName(p) === 'schema'
           );
 

lib/rules/require-meta-type.js

@@ -41,19 +41,17 @@ module.exports = {
     return {
       Program() {
         const sourceCode = context.getSourceCode();
+        const { scopeManager } = sourceCode;
         const info = utils.getRuleInfo(sourceCode);
 
         if (info === null) {
           return;
         }
 
         const metaNode = info.meta;
-        const typeNode =
-          metaNode &&
-          metaNode.properties &&
-          metaNode.properties.find(
-            (p) => p.type === 'Property' && utils.getKeyName(p) === 'type'
-          );
+        const typeNode = utils
+          .evaluateObjectProperties(metaNode, scopeManager)
+          .find((p) => p.type === 'Property' && utils.getKeyName(p) === 'type');
 
         if (!typeNode) {
           context.report({

lib/utils.js

@@ -738,4 +738,32 @@ module.exports = {
       ).suggest === parent.parent.parent
     );
   },
+
+  /**
+   * List all properties contained in an object.
+   * Evaluates and includes any properties that may be behind spreads.
+   * @param {Node} objectNode
+   * @param {ScopeManager} scopeManager
+   * @returns {Node[]} the list of all properties that could be found
+   */
+  evaluateObjectProperties(objectNode, scopeManager) {
+    if (!objectNode) {
+      return [];
+    }
+
+    const spreadElements = objectNode.properties.filter(
+      (prop) => prop.type === 'SpreadElement'
+    );
+    const spreadElementNodes = spreadElements.map((spreadElement) =>
+      findVariableValue(spreadElement.argument, scopeManager)
+    );
+    const spreadElementObjectNodes = spreadElementNodes.filter(
+      (node) => node && node.type === 'ObjectExpression'
+    );
+    const spreadElementObjectNodeProperties = spreadElementObjectNodes.flatMap(
+      (node) => node.properties
+    );
+
+    return [...objectNode.properties, ...spreadElementObjectNodeProperties];
+  },
 };

tests/lib/rules/require-meta-fixable.js

@@ -16,7 +16,7 @@ const RuleTester = require('eslint').RuleTester;
 // Tests
 // ------------------------------------------------------------------------------
 
-const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 6 } });
+const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 9 } });
 ruleTester.run('require-meta-fixable', rule, {
   valid: [
     // No `meta`.
@@ -189,6 +189,16 @@ ruleTester.run('require-meta-fixable', rule, {
       `,
       options: [{ catchNoFixerButFixableProperty: true }],
     },
+    // Spread.
+    `
+      const extra = { 'fixable': 'code' };
+      module.exports = {
+        meta: { ...extra },
+        create(context) {
+          context.report({node, message, fix: foo});
+        }
+      };
+    `,
   ],
 
   invalid: [

tests/lib/rules/require-meta-has-suggestions.js

@@ -11,7 +11,7 @@ const RuleTester = require('eslint').RuleTester;
 // Tests
 // ------------------------------------------------------------------------------
 
-const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 6 } });
+const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 9 } });
 ruleTester.run('require-meta-has-suggestions', rule, {
   valid: [
     'module.exports = context => { return {}; };',
@@ -171,7 +171,7 @@ ruleTester.run('require-meta-has-suggestions', rule, {
         }
       };
     `,
-    // Spread syntax.
+    // Unrelated spread syntax.
     {
       code: `
         const extra = {};
@@ -185,6 +185,16 @@ ruleTester.run('require-meta-has-suggestions', rule, {
         ecmaVersion: 9,
       },
     },
+    // Related spread.
+    `
+      const extra = { hasSuggestions: true };
+      module.exports = {
+        meta: { ...extra },
+        create(context) {
+          context.report({node, message, suggest: [{}]});
+        }
+      };
+    `,
   ],
 
   invalid: [

tests/lib/rules/require-meta-schema.js

@@ -11,7 +11,7 @@ const RuleTester = require('eslint').RuleTester;
 // Tests
 // ------------------------------------------------------------------------------
 
-const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 6 } });
+const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 9 } });
 ruleTester.run('require-meta-schema', rule, {
   valid: [
     `
@@ -109,6 +109,14 @@ ruleTester.run('require-meta-schema', rule, {
       code: 'module.exports = { create(context) {} };',
       options: [{ requireSchemaPropertyWhenOptionless: false }],
     },
+    // Spread.
+    `
+      const extra = { schema: [] };
+      module.exports = {
+        meta: { ...extra },
+        create(context) {}
+      };
+    `,
   ],
 
   invalid: [

tests/lib/rules/require-meta-type.js

@@ -16,7 +16,7 @@ const RuleTester = require('eslint').RuleTester;
 // Tests
 // ------------------------------------------------------------------------------
 
-const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 6 } });
+const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 9 } });
 ruleTester.run('require-meta-type', rule, {
   valid: [
     `
@@ -76,6 +76,14 @@ ruleTester.run('require-meta-type', rule, {
       `,
       errors: [{ messageId: 'missing' }],
     },
+    // Spread.
+    `
+      const extra = { type: 'problem' };
+      module.exports = {
+        meta: { ...extra },
+        create(context) {}
+      };
+    `,
   ],
 
   invalid: [