Make buildTypeAnnotationDeclarationTypes always return an object instead of boolean or an object

Author: Joachim Seminck

lib/rules/no-unused-prop-types.js

@@ -474,7 +474,7 @@ module.exports = {
      * The representation is used to verify nested used properties.
      * @param {ASTNode} annotation Type annotation for the props class property.
      * @param {String} parentName Name of the parent prop node.
-     * @return {Object|Boolean} The representation of the declaration, true means
+     * @return {Object} The representation of the declaration, an empty object means
      *    the property is declared without the need for further analysis.
      */
     function buildTypeAnnotationDeclarationTypes(annotation, parentName) {
@@ -483,21 +483,18 @@ module.exports = {
           if (typeScope(annotation.id.name)) {
             return buildTypeAnnotationDeclarationTypes(typeScope(annotation.id.name), parentName);
           }
-          return true;
+          return {};
         case 'ObjectTypeAnnotation':
           if (skipShapeProps) {
-            return true;
+            return {};
           }
           const shapeTypeDefinition = {
             type: 'shape',
             children: []
           };
           iterateProperties(annotation.properties, (childKey, childValue) => {
             const fullName = [parentName, childKey].join('.');
-            let types = buildTypeAnnotationDeclarationTypes(childValue, fullName);
-            if (types === true) {
-              types = {};
-            }
+            const types = buildTypeAnnotationDeclarationTypes(childValue, fullName);
             types.fullName = fullName;
             types.name = childKey;
             types.node = childValue;
@@ -512,7 +509,7 @@ module.exports = {
           for (let i = 0, j = annotation.types.length; i < j; i++) {
             const type = buildTypeAnnotationDeclarationTypes(annotation.types[i], parentName);
             // keep only complex type
-            if (type !== true) {
+            if (Object.keys(type).length > 0) {
               if (type.children === true) {
                 // every child is accepted for one type, abort type analysis
                 unionTypeDefinition.children = true;
@@ -523,16 +520,13 @@ module.exports = {
             unionTypeDefinition.children.push(type);
           }
           if (unionTypeDefinition.children.length === 0) {
-            // no complex type found, simply accept everything
-            return true;
+            // no complex type found
+            return {};
           }
           return unionTypeDefinition;
         case 'ArrayTypeAnnotation':
           const fullName = [parentName, '*'].join('.');
-          let child = buildTypeAnnotationDeclarationTypes(annotation.elementType, fullName);
-          if (child === true) {
-            child = {};
-          }
+          const child = buildTypeAnnotationDeclarationTypes(annotation.elementType, fullName);
           child.fullName = fullName;
           child.name = '__ANY_KEY__';
           child.node = annotation;
@@ -542,7 +536,7 @@ module.exports = {
           };
         default:
           // Unknown or accepts everything.
-          return true;
+          return {};
       }
     }
 
@@ -741,10 +735,7 @@ module.exports = {
           return;
         }
 
-        let types = buildTypeAnnotationDeclarationTypes(value, key);
-        if (types === true) {
-          types = {};
-        }
+        const types = buildTypeAnnotationDeclarationTypes(value, key);
         types.fullName = key;
         types.name = key;
         types.node = value;

lib/rules/prop-types.js

@@ -249,6 +249,7 @@ module.exports = {
     function _isDeclaredInComponent(declaredPropTypes, keyList) {
       for (let i = 0, j = keyList.length; i < j; i++) {
         const key = keyList[i];
+
         const propType = (
           declaredPropTypes && (
             // Check if this key is declared
@@ -261,7 +262,7 @@ module.exports = {
           // If it's a computed property, we can't make any further analysis, but is valid
           return key === '__COMPUTED_PROP__';
         }
-        if (propType === true) {
+        if (propType === true || typeof propType === 'object' && Object.keys(propType).length === 0) {
           return true;
         }
         // Consider every children as declared
@@ -308,6 +309,7 @@ module.exports = {
     function isDeclaredInComponent(node, names) {
       while (node) {
         const component = components.get(node);
+
         const isDeclared =
           component && component.confidence === 2 &&
           _isDeclaredInComponent(component.declaredPropTypes || {}, names)
@@ -483,7 +485,7 @@ module.exports = {
      * Creates the representation of the React props type annotation for the component.
      * The representation is used to verify nested used properties.
      * @param {ASTNode} annotation Type annotation for the props class property.
-     * @return {Object|Boolean} The representation of the declaration, true means
+     * @return {Object} The representation of the declaration, empty object means
      *    the property is declared without the need for further analysis.
      */
     function buildTypeAnnotationDeclarationTypes(annotation) {
@@ -492,7 +494,7 @@ module.exports = {
           if (typeScope(annotation.id.name)) {
             return buildTypeAnnotationDeclarationTypes(typeScope(annotation.id.name));
           }
-          return true;
+          return {};
         case 'ObjectTypeAnnotation':
           let containsObjectTypeSpread = false;
           const shapeTypeDefinition = {
@@ -509,7 +511,7 @@ module.exports = {
 
           // nested object type spread means we need to ignore/accept everything in this object
           if (containsObjectTypeSpread) {
-            return true;
+            return {};
           }
           return shapeTypeDefinition;
         case 'UnionTypeAnnotation':
@@ -520,7 +522,7 @@ module.exports = {
           for (let i = 0, j = annotation.types.length; i < j; i++) {
             const type = buildTypeAnnotationDeclarationTypes(annotation.types[i]);
             // keep only complex type
-            if (type !== true) {
+            if (Object.keys(type).length > 0) {
               if (type.children === true) {
                 // every child is accepted for one type, abort type analysis
                 unionTypeDefinition.children = true;
@@ -532,7 +534,7 @@ module.exports = {
           }
           if (unionTypeDefinition.children.length === 0) {
             // no complex type found, simply accept everything
-            return true;
+            return {};
           }
           return unionTypeDefinition;
         case 'ArrayTypeAnnotation':
@@ -544,7 +546,7 @@ module.exports = {
           };
         default:
           // Unknown or accepts everything.
-          return true;
+          return {};
       }
     }
 
@@ -726,6 +728,7 @@ module.exports = {
           ignorePropsValidation = true;
           return;
         }
+
         declaredPropTypes[key] = buildTypeAnnotationDeclarationTypes(value);
       });