feat: add functional flag export

closes #85

Author: elevatebart

src/Documentation.ts

@@ -147,6 +147,7 @@ export class Documentation {
     })
 
     return {
+      ...obj,
       // initialize non null params
       description: obj.description || '',
       tags: obj.tags || {},

src/parse-template.ts

@@ -31,9 +31,14 @@ export default function parseTemplate(
       rootLeadingCommentArray && rootLeadingCommentArray.length > 1
         ? rootLeadingCommentArray[1].trim()
         : ''
+
+    const functional = !!tpl.attrs.functional
+    if (functional) {
+      documentation.set('functional', functional)
+    }
     if (ast) {
       traverse(ast, documentation, handlers, {
-        functional: !!tpl.attrs.functional,
+        functional,
         rootLeadingComment,
       })
     }

src/script-handlers/__tests__/componentHandler.ts

@@ -76,4 +76,17 @@ describe('componentHandler', () => {
       version: [{ description: '12.5.7', title: 'version' }],
     })
   })
+
+  it('should detect functional flags', () => {
+    const src = `
+    export default {
+      functional:true
+    }
+    `
+    const def = parse(src).get('default')
+    if (def) {
+      componentHandler(documentation, def)
+    }
+    expect(documentation.set).toHaveBeenCalledWith('functional', true)
+  })
 })

src/script-handlers/componentHandler.ts

@@ -6,6 +6,20 @@ import getDoclets from '../utils/getDoclets'
 import transformTagsIntoObject from '../utils/transformTagsIntoObject'
 
 export default function propHandler(documentation: Documentation, path: NodePath) {
+  // deal with functional flag
+  if (bt.isObjectExpression(path.node)) {
+    const functionalPath = path
+      .get('properties')
+      .filter((p: NodePath) => bt.isObjectProperty(p.node) && p.node.key.name === 'functional')
+
+    if (functionalPath.length) {
+      const functionalValue = functionalPath[0].get('value').node
+      if (bt.isBooleanLiteral(functionalValue)) {
+        documentation.set('functional', functionalValue.value)
+      }
+    }
+  }
+
   let componentCommentedPath = path.parentPath
   // in case of Vue.extend() structure
   if (bt.isCallExpression(componentCommentedPath.node)) {

tests/components/button-functional/__snapshots__/button-functional.test.ts.snap

@@ -5,6 +5,7 @@ Object {
   "description": "",
   "displayName": "MyButton",
   "events": Object {},
+  "functional": true,
   "methods": Array [],
   "props": Object {
     "default": Object {