fix: add variable resolution in event doc

* test: add immediately resolved event name

* extract resolve identifier

* fix: add variable resolution in event doc
#113

Author: elevatebart

src/script-handlers/__tests__/eventHandler.ts

@@ -1,3 +1,4 @@
+import * as bt from '@babel/types'
 import { NodePath } from 'ast-types'
 import babylon from '../../babel-parser'
 import { Documentation, EventDescriptor } from '../../Documentation'
@@ -6,9 +7,9 @@ import eventHandler from '../eventHandler'
 
 jest.mock('../../Documentation')
 
-function parse(src: string): NodePath | undefined {
+function parse(src: string): { component: NodePath | undefined; ast: bt.File } {
   const ast = babylon().parse(src)
-  return resolveExportedComponent(ast).get('default')
+  return { component: resolveExportedComponent(ast).get('default'), ast }
 }
 
 describe('eventHandler', () => {
@@ -38,8 +39,8 @@ describe('eventHandler', () => {
     }
     `
     const def = parse(src)
-    if (def) {
-      eventHandler(documentation, def)
+    if (def.component) {
+      eventHandler(documentation, def.component, def.ast)
     }
     const eventComp: EventDescriptor = {
       description: 'Describe the event',
@@ -73,8 +74,8 @@ describe('eventHandler', () => {
     }
     `
     const def = parse(src)
-    if (def) {
-      eventHandler(documentation, def)
+    if (def.component) {
+      eventHandler(documentation, def.component, def.ast)
     }
     const eventComp: EventDescriptor = {
       description: '',
@@ -93,4 +94,22 @@ describe('eventHandler', () => {
     expect(documentation.getEventDescriptor).toHaveBeenCalledWith('success')
     expect(mockEventDescriptor).toMatchObject(eventComp)
   })
+
+  it('should find events names stored in variables', () => {
+    const src = `
+    const successEventName = 'success';
+    export default {
+      methods: {
+        testEmit() {
+            this.$emit(successEventName, 1, 2)
+        }
+      }
+    }
+    `
+    const def = parse(src)
+    if (def.component) {
+      eventHandler(documentation, def.component, def.ast)
+    }
+    expect(documentation.getEventDescriptor).toHaveBeenCalledWith('success')
+  })
 })

src/script-handlers/eventHandler.ts

@@ -11,12 +11,17 @@ import {
 } from '../Documentation'
 import getDocblock from '../utils/getDocblock'
 import getDoclets from '../utils/getDoclets'
+import resolveIdentifier from '../utils/resolveIdentifier'
 
 export interface TypedParamTag extends ParamTag {
   type: ParamType
 }
 
-export default function eventHandler(documentation: Documentation, path: NodePath) {
+export default function eventHandler(
+  documentation: Documentation,
+  path: NodePath,
+  astPath: bt.File,
+) {
   recast.visit(path.node, {
     visitCallExpression(pathExpression) {
       if (
@@ -30,12 +35,16 @@ export default function eventHandler(documentation: Documentation, path: NodePat
           return false
         }
 
-        const firstArg = args[0]
-        if (!bt.isStringLiteral(firstArg)) {
+        let firstArg = pathExpression.get('arguments', 0)
+        if (bt.isIdentifier(firstArg.node)) {
+          firstArg = resolveIdentifier(astPath, firstArg)
+        }
+
+        if (!bt.isStringLiteral(firstArg.node)) {
           return false
         }
 
-        const eventName = firstArg.value
+        const eventName = firstArg.node.value
 
         // if this event is documented somewhere else leave it alone
         const evtDescriptor = documentation.getEventDescriptor(eventName)

src/utils/resolveExportedComponent.ts

@@ -4,6 +4,7 @@ import recast from 'recast'
 import Map from 'ts-map'
 import isExportedAssignment from './isExportedAssignment'
 import resolveExportDeclaration from './resolveExportDeclaration'
+import resolveIdentifier from './resolveIdentifier'
 
 function ignore(): boolean {
   return false
@@ -128,50 +129,3 @@ function normalizeComponentPath(path: NodePath): NodePath {
   }
   return path
 }
-
-function resolveIdentifier(ast: bt.File, path: NodePath): NodePath | null {
-  if (!bt.isIdentifier(path.node)) {
-    return path
-  }
-
-  const varName = path.node.name
-  let comp: NodePath | null = null
-
-  recast.visit(ast.program, {
-    // to look only at the root we ignore all traversing
-    visitFunctionDeclaration: ignore,
-    visitFunctionExpression: ignore,
-    visitClassExpression: ignore,
-    visitIfStatement: ignore,
-    visitWithStatement: ignore,
-    visitSwitchStatement: ignore,
-    visitWhileStatement: ignore,
-    visitDoWhileStatement: ignore,
-    visitForStatement: ignore,
-    visitForInStatement: ignore,
-
-    visitVariableDeclaration(variablePath) {
-      if (!bt.isVariableDeclaration(variablePath.node)) {
-        return false
-      }
-      const varID = variablePath.node.declarations[0].id
-      if (!varID || !bt.isIdentifier(varID) || varID.name !== varName) {
-        return false
-      }
-
-      comp = variablePath.get('declarations', 0).get('init')
-      return false
-    },
-
-    visitClassDeclaration(classPath) {
-      const classID = classPath.node.id
-      if (!classID || !bt.isIdentifier(classID) || classID.name !== varName) {
-        return false
-      }
-
-      comp = classPath
-      return false
-    },
-  })
-  return comp
-}

src/utils/resolveIdentifier.ts

@@ -0,0 +1,54 @@
+import * as bt from '@babel/types'
+import { NodePath } from 'ast-types'
+import recast from 'recast'
+
+function ignore(): boolean {
+  return false
+}
+
+export default function resolveIdentifier(ast: bt.File, path: NodePath): NodePath | null {
+  if (!bt.isIdentifier(path.node)) {
+    return path
+  }
+
+  const varName = path.node.name
+  let comp: NodePath | null = null
+
+  recast.visit(ast.program, {
+    // to look only at the root we ignore all traversing
+    visitFunctionDeclaration: ignore,
+    visitFunctionExpression: ignore,
+    visitClassExpression: ignore,
+    visitIfStatement: ignore,
+    visitWithStatement: ignore,
+    visitSwitchStatement: ignore,
+    visitWhileStatement: ignore,
+    visitDoWhileStatement: ignore,
+    visitForStatement: ignore,
+    visitForInStatement: ignore,
+
+    visitVariableDeclaration(variablePath) {
+      if (!bt.isVariableDeclaration(variablePath.node)) {
+        return false
+      }
+      const varID = variablePath.node.declarations[0].id
+      if (!varID || !bt.isIdentifier(varID) || varID.name !== varName) {
+        return false
+      }
+
+      comp = variablePath.get('declarations', 0).get('init')
+      return false
+    },
+
+    visitClassDeclaration(classPath) {
+      const classID = classPath.node.id
+      if (!classID || !bt.isIdentifier(classID) || classID.name !== varName) {
+        return false
+      }
+
+      comp = classPath
+      return false
+    },
+  })
+  return comp
+}