feat(component-meta): support JSDoc tags for events

vuejs · May 10, 2024 · 62c65ae · 62c65ae
1 parent 1462f5e
commit 62c65ae
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/packages/component-meta/lib/base.ts b/packages/component-meta/lib/base.ts
@@ -567,6 +567,10 @@ function createSchemaResolvers(
  return {
  name: (typeChecker.getTypeOfSymbolAtLocation(call.parameters[0], symbolNode) as ts.StringLiteralType).value,
  description: ts.displayPartsToString(call.getDocumentationComment(typeChecker)),
+ tags: call.getJsDocTags().map(tag => ({
+ name: tag.name,
+ text: tag.text !== undefined ? ts.displayPartsToString(tag.text) : undefined,
+ })),
  type: typeChecker.typeToString(subtype),
  rawType: rawType ? subtype : undefined,
  signature: typeChecker.signatureToString(call),

diff --git a/packages/component-meta/lib/types.ts b/packages/component-meta/lib/types.ts
@@ -40,6 +40,7 @@ export interface EventMeta {
  type: string;
  rawType?: ts.Type;
  signature: string;
+ tags: { name: string, text?: string; }[];
  declarations: Declaration[];
  schema: PropertyMetaSchema[];
 }