Refactor: Extract shared utility functions and improve JSDoc access

Co-authored-by: johnsoncodehk <[email protected]>

Author: Copilot

packages/component-meta/README.md

@@ -42,6 +42,33 @@ const meta = checker.getComponentMeta(componentPath);
 
 This meta contains really useful stuff like component props, slots, events and more. You can refer to its [type definition](https://github.com/vuejs/language-tools/blob/master/packages/component-meta/lib/types.ts) for more details.
 
+### Extracting component name and description
+
+The component meta also includes `name` and `description` fields at the root level:
+
+- **`name`**: Extracted from the `name` property in the component options (for Options API components)
+- **`description`**: Extracted from JSDoc comments above the component export (for TypeScript/JavaScript files)
+
+```ts
+/**
+ * My awesome component description
+ */
+export default defineComponent({
+  name: 'MyComponent',
+  // ... component definition
+})
+```
+
+When you extract the component meta, you'll get:
+```ts
+meta.name // 'MyComponent'
+meta.description // 'My awesome component description'
+```
+
+> **Note**
+>
+> JSDoc comments on `export default` statements in Vue SFCs (`.vue` files) are not currently supported due to limitations in how TypeScript processes the virtual files generated from SFCs.
+
 ### Extracting prop meta
 
 `vue-component-meta` will automatically extract the prop details like its name, default value, is required or not, etc. Additionally, you can even write prop description in source code via [JSDoc](https://jsdoc.app/) comment for that prop.

packages/component-meta/lib/base.ts

@@ -18,6 +18,63 @@ export * from './types';
 
 const windowsPathReg = /\\/g;
 
+// Utility function to get the component node from an AST
+function getComponentNodeFromAst(
+	ast: ts.SourceFile,
+	exportName: string,
+	ts: typeof import('typescript'),
+): ts.Node | undefined {
+	let result: ts.Node | undefined;
+
+	if (exportName === 'default') {
+		ast.forEachChild(child => {
+			if (ts.isExportAssignment(child)) {
+				result = child.expression;
+			}
+		});
+	}
+	else {
+		ast.forEachChild(child => {
+			if (
+				ts.isVariableStatement(child)
+				&& child.modifiers?.some(mod => mod.kind === ts.SyntaxKind.ExportKeyword)
+			) {
+				for (const dec of child.declarationList.declarations) {
+					if (dec.name.getText(ast) === exportName) {
+						result = dec.initializer;
+					}
+				}
+			}
+		});
+	}
+
+	return result;
+}
+
+// Utility function to get the component options node from a component node
+function getComponentOptionsNodeFromComponent(
+	component: ts.Node | undefined,
+	ts: typeof import('typescript'),
+): ts.ObjectLiteralExpression | undefined {
+	if (component) {
+		// export default { ... }
+		if (ts.isObjectLiteralExpression(component)) {
+			return component;
+		}
+		// export default defineComponent({ ... })
+		else if (ts.isCallExpression(component)) {
+			if (component.arguments.length) {
+				const arg = component.arguments[0]!;
+				if (ts.isObjectLiteralExpression(arg)) {
+					return arg;
+				}
+			}
+		}
+	}
+
+	return undefined;
+}
+
 export function createCheckerByJsonConfigBase(
 	ts: typeof import('typescript'),
 	rootDir: string,
@@ -934,51 +991,12 @@ function readTsComponentDefaultProps(
 	return {};
 
 	function getComponentNode() {
-		let result: ts.Node | undefined;
-
-		if (exportName === 'default') {
-			ast.forEachChild(child => {
-				if (ts.isExportAssignment(child)) {
-					result = child.expression;
-				}
-			});
-		}
-		else {
-			ast.forEachChild(child => {
-				if (
-					ts.isVariableStatement(child)
-					&& child.modifiers?.some(mod => mod.kind === ts.SyntaxKind.ExportKeyword)
-				) {
-					for (const dec of child.declarationList.declarations) {
-						if (dec.name.getText(ast) === exportName) {
-							result = dec.initializer;
-						}
-					}
-				}
-			});
-		}
-
-		return result;
+		return getComponentNodeFromAst(ast, exportName, ts);
 	}
 
 	function getComponentOptionsNode() {
 		const component = getComponentNode();
-
-		if (component) {
-			// export default { ... }
-			if (ts.isObjectLiteralExpression(component)) {
-				return component;
-			}
-			// export default defineComponent({ ... })
-			else if (ts.isCallExpression(component)) {
-				if (component.arguments.length) {
-					const arg = component.arguments[0]!;
-					if (ts.isObjectLiteralExpression(arg)) {
-						return arg;
-					}
-				}
-			}
-		}
+		return getComponentOptionsNodeFromComponent(component, ts);
 	}
 
 	function getPropsNode() {
@@ -1074,7 +1092,8 @@ function readComponentName(
 	exportName: string,
 	ts: typeof import('typescript'),
 ): string | undefined {
-	const optionsNode = getComponentOptionsNode();
+	const componentNode = getComponentNodeFromAst(ast, exportName, ts);
+	const optionsNode = getComponentOptionsNodeFromComponent(componentNode, ts);
 
 	if (optionsNode) {
 		const nameProp = optionsNode.properties.find(
@@ -1087,56 +1106,6 @@ function readComponentName(
 	}
 
 	return undefined;
-
-	function getComponentNode() {
-		let result: ts.Node | undefined;
-
-		if (exportName === 'default') {
-			ast.forEachChild(child => {
-				if (ts.isExportAssignment(child)) {
-					result = child.expression;
-				}
-			});
-		}
-		else {
-			ast.forEachChild(child => {
-				if (
-					ts.isVariableStatement(child)
-					&& child.modifiers?.some(mod => mod.kind === ts.SyntaxKind.ExportKeyword)
-				) {
-					for (const dec of child.declarationList.declarations) {
-						if (dec.name.getText(ast) === exportName) {
-							result = dec.initializer;
-						}
-					}
-				}
-			});
-		}
-
-		return result;
-	}
-
-	function getComponentOptionsNode() {
-		const component = getComponentNode();
-
-		if (component) {
-			// export default { ... }
-			if (ts.isObjectLiteralExpression(component)) {
-				return component;
-			}
-			// export default defineComponent({ ... })
-			else if (ts.isCallExpression(component)) {
-				if (component.arguments.length) {
-					const arg = component.arguments[0]!;
-					if (ts.isObjectLiteralExpression(arg)) {
-						return arg;
-					}
-				}
-			}
-		}
-
-		return undefined;
-	}
 }
 
 function readComponentDescription(
@@ -1148,17 +1117,16 @@ function readComponentDescription(
 	const exportNode = getExportNode();
 
 	if (exportNode) {
-		// Try to get JSDoc comments from the node
-		const jsDocTags = (exportNode as any).jsDoc;
-		if (jsDocTags && jsDocTags.length > 0) {
-			const jsDoc = jsDocTags[0];
-			if (jsDoc.comment) {
+		// Try to get JSDoc comments from the node using TypeScript API
+		const jsDocComments = ts.getJSDocCommentsAndTags(exportNode);
+		for (const jsDoc of jsDocComments) {
+			if (ts.isJSDoc(jsDoc) && jsDoc.comment) {
 				// Handle both string and array of comment parts
 				if (typeof jsDoc.comment === 'string') {
 					return jsDoc.comment;
 				}
 				else if (Array.isArray(jsDoc.comment)) {
-					return jsDoc.comment.map((part: any) => part.text || '').join('');
+					return jsDoc.comment.map(part => (part as any).text || '').join('');
 				}
 			}
 		}