fix: correctly read description of inner types in arrayOf/objectOf (#281)

Author: danez

src/utils/__tests__/getPropType-test.js

@@ -266,6 +266,44 @@ describe('getPropType', () => {
     });
   });
 
+  it('detects descriptions on nested types in arrayOf', () => {
+    expect(
+      getPropType(
+        expression(`arrayOf(
+      /**
+       * test2
+       */
+      string
+    )`),
+      ),
+    ).toEqual({
+      name: 'arrayOf',
+      description: 'test2',
+      value: {
+        name: 'string',
+      },
+    });
+  });
+
+  it('detects descriptions on nested types in objectOf', () => {
+    expect(
+      getPropType(
+        expression(`objectOf(
+      /**
+       * test2
+       */
+      string
+    )`),
+      ),
+    ).toEqual({
+      name: 'objectOf',
+      description: 'test2',
+      value: {
+        name: 'string',
+      },
+    });
+  });
+
   it('detects descriptions on nested types in shapes', () => {
     expect(
       getPropType(

src/utils/getPropType.js

@@ -86,6 +86,12 @@ function getPropTypeOneOfType(argumentPath) {
 
 function getPropTypeArrayOf(argumentPath) {
   const type: PropTypeDescriptor = { name: 'arrayOf' };
+
+  const docs = getDocblock(argumentPath);
+  if (docs) {
+    type.description = docs;
+  }
+
   const subType = getPropType(argumentPath);
 
   if (subType.name === 'unknown') {
@@ -99,6 +105,12 @@ function getPropTypeArrayOf(argumentPath) {
 
 function getPropTypeObjectOf(argumentPath) {
   const type: PropTypeDescriptor = { name: 'objectOf' };
+
+  const docs = getDocblock(argumentPath);
+  if (docs) {
+    type.description = docs;
+  }
+
   const subType = getPropType(argumentPath);
 
   if (subType.name === 'unknown') {