feat(vue-component-meta): expose more infos (#1674)

Co-authored-by: johnsoncodehk <johnsoncodehk@gmail.com>
vuejs · Aug 6, 2022 · b4220d4 · b4220d4
1 parent d7af2ee
commit b4220d4
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 6 deletions.
diff --git a/packages/vue-component-meta/src/index.ts b/packages/vue-component-meta/src/index.ts
@@ -102,6 +102,11 @@ export function createComponentMetaChecker(tsconfigPath: string, checkerOptions:
 	return {
 		getExportNames,
 		getComponentMeta,
+		__internal__: {
+			program,
+			tsLs,
+			typeChecker,
+		},
 	};
 
 	function getMetaFileName(fileName: string) {
@@ -152,7 +157,7 @@ export function createComponentMetaChecker(tsconfigPath: string, checkerOptions:
 					.map((prop) => {
 						const {
 							resolveNestedProperties,
-						} = createSchemaResolvers(typeChecker, symbolNode!, checkerOptions.schema);
+						} = createSchemaResolvers(typeChecker, symbolNode!, checkerOptions);
 
 						return resolveNestedProperties(prop);
 					})
@@ -210,7 +215,7 @@ export function createComponentMetaChecker(tsconfigPath: string, checkerOptions:
 
 					const {
 						resolveEventSignature,
-					} = createSchemaResolvers(typeChecker, symbolNode!, checkerOptions.schema);
+					} = createSchemaResolvers(typeChecker, symbolNode!, checkerOptions);
 
 					return resolveEventSignature(call);
 				}).filter(event => event.name);
@@ -231,7 +236,7 @@ export function createComponentMetaChecker(tsconfigPath: string, checkerOptions:
 				return properties.map((prop) => {
 					const {
 						resolveSlotProperties,
-					} = createSchemaResolvers(typeChecker, symbolNode!, checkerOptions.schema);
+					} = createSchemaResolvers(typeChecker, symbolNode!, checkerOptions);
 
 					return resolveSlotProperties(prop);
 				});
@@ -251,7 +256,7 @@ export function createComponentMetaChecker(tsconfigPath: string, checkerOptions:
 				return exposed.map((prop) => {
 					const {
 						resolveExposedProperties,
-					} = createSchemaResolvers(typeChecker, symbolNode!, checkerOptions.schema);
+					} = createSchemaResolvers(typeChecker, symbolNode!, checkerOptions);
 
 					return resolveExposedProperties(prop);
 				});
@@ -300,7 +305,7 @@ export function createComponentMetaChecker(tsconfigPath: string, checkerOptions:
 	}
 }
 
-function createSchemaResolvers(typeChecker: ts.TypeChecker, symbolNode: ts.Expression, options: MetaCheckerSchemaOptions = false) {
+function createSchemaResolvers(typeChecker: ts.TypeChecker, symbolNode: ts.Expression, { rawType, schema: options }: MetaCheckerOptions) {
 	const enabled = !!options;
 	const ignore = typeof options === 'object' ? [...options?.ignore ?? []] : [];
 
@@ -341,6 +346,7 @@ function createSchemaResolvers(typeChecker: ts.TypeChecker, symbolNode: ts.Expre
 			})),
 			required: !Boolean((prop.declarations?.[0] as ts.ParameterDeclaration)?.questionToken ?? false),
 			type: typeChecker.typeToString(subtype),
+			rawType: rawType ? subtype : undefined,
 			schema,
 		};
 	}
@@ -351,6 +357,7 @@ function createSchemaResolvers(typeChecker: ts.TypeChecker, symbolNode: ts.Expre
 		return {
 			name: prop.getName(),
 			type: typeChecker.typeToString(subtype),
+			rawType: rawType ? subtype : undefined,
 			description: ts.displayPartsToString(prop.getDocumentationComment(typeChecker)),
 			schema,
 		};
@@ -362,6 +369,7 @@ function createSchemaResolvers(typeChecker: ts.TypeChecker, symbolNode: ts.Expre
 		return {
 			name: expose.getName(),
 			type: typeChecker.typeToString(subtype),
+			rawType: rawType ? subtype : undefined,
 			description: ts.displayPartsToString(expose.getDocumentationComment(typeChecker)),
 			schema,
 		};
@@ -375,6 +383,7 @@ function createSchemaResolvers(typeChecker: ts.TypeChecker, symbolNode: ts.Expre
 		return {
 			name: (typeChecker.getTypeOfSymbolAtLocation(call.parameters[0], symbolNode!) as ts.StringLiteralType).value,
 			type: typeChecker.typeToString(subtype),
+			rawType: rawType ? subtype : undefined,
 			signature: typeChecker.signatureToString(call),
 			schema,
 		};

diff --git a/packages/vue-component-meta/src/types.ts b/packages/vue-component-meta/src/types.ts
@@ -13,25 +13,29 @@ export interface PropertyMeta {
 	global: boolean;
 	required: boolean;
 	type: string;
+	rawType?: ts.Type;
 	tags: { name: string, text?: string; }[];
 	schema?: PropertyMetaSchema;
 };
 export interface EventMeta {
 	name: string;
 	type: string;
+	rawType?: ts.Type;
 	signature: string;
 	schema?: PropertyMetaSchema[];
 }
 export interface SlotMeta {
 	name: string;
 	type: string;
+	rawType?: ts.Type;
 	description: string;
 	schema?: PropertyMetaSchema;
 }
 export interface ExposeMeta {
 	name: string;
 	description: string;
 	type: string;
+	rawType?: ts.Type;
 	schema?: PropertyMetaSchema;
 }
 
@@ -43,9 +47,10 @@ export type PropertyMetaSchema = string
 
 export type MetaCheckerSchemaOptions = boolean | {
 	ignore?: string[];
-}
+};
 export interface MetaCheckerOptions {
 	schema?: MetaCheckerSchemaOptions;
 	forceUseTs?: boolean;
 	printer?: import('typescript').PrinterOptions;
+	rawType?: boolean;
 }