Aadd support also for no-unused-prop-types

jsx-eslint · Sep 6, 2017 · 3e4d184 · 3e4d184
1 parent 19a2911
commit 3e4d184
Show file tree

Hide file tree

Showing 3 changed files with 85 additions and 44 deletions.
diff --git a/lib/rules/no-unused-prop-types.js b/lib/rules/no-unused-prop-types.js
@@ -725,49 +725,69 @@ module.exports = {
     }
 
     /**
-     * Marks all props found inside IntersectionTypeAnnotation as declared.
-     * Since InterSectionTypeAnnotations can be nested, this handles recursively. 
+     * Marks all props found inside ObjectTypeAnnotaiton as declared.
      * 
-     * Modifies the declaredPropTypes object
+     * Modifies the declaredProperties object
      * @param {ASTNode} propTypes 
      * @param {Object} declaredPropTypes 
      * @returns {Boolean} True if propTypes should be ignored (e.g. when a type can't be resolved, when it is imported)
      */
-    function declarePropTypesForIntersectionTypeAnnotation(propTypes, declaredPropTypes) {
+    function declarePropTypesForObjectTypeAnnotation(propTypes, declaredPropTypes) {
       let ignorePropsValidation = false;
 
-      propTypes.types.forEach(annotation => {
-        const typeNode = typeScope(annotation.id.name);
-
-        if (!typeNode) {
+      iterateProperties(propTypes.properties, (key, value) => {
+        if (!value) {
           ignorePropsValidation = true;
           return;
         }
 
-        if (typeNode.type === 'IntersectionTypeAnnotation') {
-          ignorePropsValidation = declarePropTypesForIntersectionTypeAnnotation(typeNode, declaredPropTypes);
-        } else {
-          iterateProperties(typeNode.properties, (key, value) => {
-            if (!value) {
-              ignorePropsValidation = true;
-              return;
-            }
-
-            let types = buildTypeAnnotationDeclarationTypes(value, key);
-            if (types === true) {
-              types = {};
-            }
-            types.fullName = key;
-            types.name = key;
-            types.node = value;
-            declaredPropTypes.push(types);
-          });
+        let types = buildTypeAnnotationDeclarationTypes(value, key);
+        if (types === true) {
+          types = {};
         }
+        types.fullName = key;
+        types.name = key;
+        types.node = value;
+        declaredPropTypes.push(types);
       });
 
       return ignorePropsValidation;
     }
 
+    /**
+     * Marks all props found inside IntersectionTypeAnnotation as declared.
+     * Since InterSectionTypeAnnotations can be nested, this handles recursively. 
+     * 
+     * Modifies the declaredPropTypes object
+     * @param {ASTNode} propTypes 
+     * @param {Object} declaredPropTypes 
+     * @returns {Boolean} True if propTypes should be ignored (e.g. when a type can't be resolved, when it is imported)
+     */
+    function declarePropTypesForIntersectionTypeAnnotation(propTypes, declaredPropTypes) {
+      return propTypes.types.reduce((ignorePropsValidation, annotation) => {
+        // If we already decided to skip props validation then we don't have to continue processing anything else
+        if (ignorePropsValidation) {
+          return ignorePropsValidation;
+        }
+
+        if (annotation.type === 'ObjectTypeAnnotation') {
+          ignorePropsValidation = declarePropTypesForObjectTypeAnnotation(annotation, declaredPropTypes);
+        } else {
+          const typeNode = typeScope(annotation.id.name);
+
+          if (!typeNode) {
+            ignorePropsValidation = true;
+          } else if (typeNode.type === 'IntersectionTypeAnnotation') {
+            ignorePropsValidation = declarePropTypesForIntersectionTypeAnnotation(typeNode, declaredPropTypes);
+          } else {
+            ignorePropsValidation = declarePropTypesForObjectTypeAnnotation(typeNode, declaredPropTypes);
+          }
+        }
+
+        return ignorePropsValidation;
+      }, false);
+    }
+
     /**
      * Mark a prop type as declared
      * @param {ASTNode} node The AST node being checked.
@@ -780,20 +800,7 @@ module.exports = {
 
       switch (propTypes && propTypes.type) {
         case 'ObjectTypeAnnotation':
-          iterateProperties(propTypes.properties, (key, value) => {
-            if (!value) {
-              ignorePropsValidation = true;
-              return;
-            }
-            let types = buildTypeAnnotationDeclarationTypes(value, key);
-            if (types === true) {
-              types = {};
-            }
-            types.fullName = key;
-            types.name = key;
-            types.node = value;
-            declaredPropTypes.push(types);
-          });
+          ignorePropsValidation = declarePropTypesForObjectTypeAnnotation(propTypes, declaredPropTypes);
           break;
         case 'ObjectExpression':
           iterateProperties(propTypes.properties, (key, value) => {

diff --git a/lib/rules/prop-types.js b/lib/rules/prop-types.js
@@ -762,10 +762,7 @@ module.exports = {
           }
         }
 
-        // Return early if we have to ignore props validation. No point to continue processing.
-        if (ignorePropsValidation) {
-          return ignorePropsValidation;
-        }
+        return ignorePropsValidation;
       }, false);
     }
 

diff --git a/tests/lib/rules/no-unused-prop-types.js b/tests/lib/rules/no-unused-prop-types.js
@@ -871,6 +871,23 @@ ruleTester.run('no-unused-prop-types', rule, {
         }
       `,
       parser: 'babel-eslint'
+    }, {
+      code: `
+        type PropsB = { foo: string };
+        type PropsC = { bar: string };
+        type Props = PropsB & {
+          zap: string 
+        };
+
+        class Bar extends React.Component {
+          props: Props & PropsC;
+          
+          render() {
+            return <div>{this.props.foo} - {this.props.bar} - {this.props.zap}</div>
+          }
+        }
+      `,
+      parser: 'babel-eslint'
     }, {
       code: [
         'import type Props from "fake";',
@@ -2794,6 +2811,26 @@ ruleTester.run('no-unused-prop-types', rule, {
       errors: [
         {message: '\'zap\' PropType is defined but prop is never used'}
       ]
+    }, {
+      code: `
+        type PropsB = { foo: string };
+        type PropsC = { bar: string };
+        type Props = PropsB & {
+          zap: string 
+        };
+
+        class Bar extends React.Component {
+          props: Props & PropsC;
+          
+          render() {
+            return <div>{this.props.foo} - {this.props.bar}</div>
+          }
+        }
+      `,
+      errors: [
+        {message: '\'zap\' PropType is defined but prop is never used'}
+      ],
+      parser: 'babel-eslint'
     }, {
       code: [
         'class Hello extends React.Component {',