fix: allow documenting of propTypes and vueTypes props (#90)

vue-styleguidist · Jan 28, 2019 · 7801fdf · 7801fdf
1 parent 14ad5f5
commit 7801fdf
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/src/script-handlers/__tests__/propHandler.ts b/src/script-handlers/__tests__/propHandler.ts
@@ -152,6 +152,39 @@ describe('propHandler', () => {
         type: { name: 'boolean' },
       })
     })
+
+    it('should still return props with vue-types', () => {
+      const src = [
+        'export default {',
+        '  props:{',
+        '    test: VueTypes.shape({',
+        '       line1: String,',
+        '       line2: String,',
+        '    })',
+        '  }',
+        '}',
+      ].join('\n')
+      tester(src, {
+        type: {
+          func: true,
+        },
+      })
+    })
+
+    it('should still return props with prop-types', () => {
+      const src = [
+        'export default {',
+        '  props:{',
+        "    test: PropTypes.oneOf(['News', 'Photos'])",
+        '  }',
+        '}',
+      ].join('\n')
+      tester(src, {
+        type: {
+          func: true,
+        },
+      })
+    })
   })
 
   describe('required', () => {

diff --git a/src/script-handlers/propHandler.ts b/src/script-handlers/propHandler.ts
@@ -70,6 +70,11 @@ export default function propHandler(documentation: Documentation, path: NodePath
         } else if (bt.isIdentifier(propValuePath.node)) {
           // contents of the prop is it's type
           propDescriptor.type = getTypeFromTypePath(propValuePath)
+        } else {
+          propDescriptor.type = {
+            name: recast.print(prop.get('value')).code,
+            func: true,
+          }
         }
       })
     } else if (bt.isArrayExpression(propsValuePath.node)) {