fix(docgen): resolve exported displayname

closes #1220
vue-styleguidist · Nov 21, 2021 · d414c4a · d414c4a
1 parent 2f2fd17
commit d414c4a
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 5 deletions.
diff --git a/packages/vue-docgen-api/src/script-handlers/__tests__/displayNameHandler.ts b/packages/vue-docgen-api/src/script-handlers/__tests__/displayNameHandler.ts
@@ -50,4 +50,21 @@ describe('displayNameHandler', () => {
 		}
 		expect(documentation.set).toHaveBeenCalledWith('displayName', 'name-123')
 	})
+
+	it('should return the right component name as a constant when it is exported', () => {
+		const src = `
+    export const NAME = 'name-123';
+    export default {
+      name: NAME,
+      components: {
+        testComp: {}
+      }
+    }
+    `
+		const def = parse(src)
+		if (def) {
+			displayNameHandler(documentation, def)
+		}
+		expect(documentation.set).toHaveBeenCalledWith('displayName', 'name-123')
+	})
 })
diff --git a/packages/vue-docgen-api/src/script-handlers/displayNameHandler.ts b/packages/vue-docgen-api/src/script-handlers/displayNameHandler.ts
@@ -45,11 +45,18 @@ function getDeclaredConstantValue(prog: NodePath<bt.Program>, nameConstId: strin
 	const globalVariableDeclarations = body.filter((node: bt.Node) =>
 		bt.isVariableDeclaration(node)
 	) as bt.VariableDeclaration[]
-	const declarators = globalVariableDeclarations.reduce(
-		(a: bt.VariableDeclarator[], declPath) => a.concat(declPath.declarations),
-		[]
-	)
-	const nodeDeclaratorArray = declarators.filter(
+
+	const globalVariableExports = body
+		.filter(
+			(node: bt.Node) =>
+				bt.isExportNamedDeclaration(node) && bt.isVariableDeclaration(node.declaration)
+		)
+		.map((node: bt.ExportNamedDeclaration) => node.declaration) as bt.VariableDeclaration[]
+
+	const declarations = globalVariableDeclarations
+		.concat(globalVariableExports)
+		.reduce((a: bt.VariableDeclarator[], declPath) => a.concat(declPath.declarations), [])
+	const nodeDeclaratorArray = declarations.filter(
 		d => bt.isIdentifier(d.id) && d.id.name === nameConstId
 	)
 	const nodeDeclarator = nodeDeclaratorArray.length ? nodeDeclaratorArray[0] : undefined