Fix prop-types to ignore validation when Flow indexers are used

Fixes #2330
jsx-eslint · Jun 26, 2019 · bc67d42 · bc67d42
1 parent 8432e5e
commit bc67d42
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 2 deletions.
diff --git a/lib/rules/prop-types.js b/lib/rules/prop-types.js
@@ -103,7 +103,7 @@ module.exports = {
           return true;
         }
         // Consider every children as declared
-        if (propType.children === true || propType.containsSpread) {
+        if (propType.children === true || propType.containsSpread || propType.containsIndexers) {
           return true;
         }
         if (propType.acceptedProperties) {

diff --git a/lib/util/propTypes.js b/lib/util/propTypes.js
@@ -122,6 +122,7 @@ module.exports = function propTypesInstructions(context, components, utils) {
 
     ObjectTypeAnnotation(annotation, parentName, seen) {
       let containsObjectTypeSpread = false;
+      const containsIndexers = Boolean(annotation.indexers && annotation.indexers.length);
       const shapeTypeDefinition = {
         type: 'shape',
         children: {}
@@ -140,9 +141,10 @@ module.exports = function propTypesInstructions(context, components, utils) {
         }
       });
 
-      // Mark if this shape has spread. We will know to consider all props from this shape as having propTypes,
+      // Mark if this shape has spread or an indexer. We will know to consider all props from this shape as having propTypes,
       // but still have the ability to detect unused children of this shape.
       shapeTypeDefinition.containsSpread = containsObjectTypeSpread;
+      shapeTypeDefinition.containsIndexers = containsIndexers;
 
       return shapeTypeDefinition;
     },

diff --git a/tests/lib/rules/prop-types.js b/tests/lib/rules/prop-types.js
@@ -2355,6 +2355,26 @@ ruleTester.run('prop-types', rule, {
       code: `
         for (const {result} of results) {}
       `
+    },
+    {
+      // issue #2330
+      code: `
+        type Props = {
+          user: {
+            [string]: string
+          }
+        };
+
+        export function Bar(props: Props) {
+          return (
+            <div>
+              {props.user}
+              {props.user.name}
+            </div>
+          );
+        }
+      `,
+      parser: parsers.BABEL_ESLINT
     }
   ],
 
@@ -4675,6 +4695,34 @@ ruleTester.run('prop-types', rule, {
       errors: [{
         message: '\'lastname\' is missing in props validation'
       }]
+    },
+    {
+      // issue #2330
+      code: `
+        type Props = {
+          user: {
+            name: {
+              firstname: string,
+              [string]: string
+            }
+          }
+        };
+
+        export function Bar(props: Props) {
+          return (
+            <div>
+              {props.user}
+              {props.user.name.firstname}
+              {props.user.name.lastname}
+              {props.user.age}
+            </div>
+          );
+        }
+      `,
+      parser: parsers.BABEL_ESLINT,
+      errors: [{
+        message: '\'user.age\' is missing in props validation'
+      }]
     }
   ]
 });