feat(component-meta): make schema.ignore accept functions (#2232)

vuejs · Dec 19, 2022 · f979b75 · f979b75
1 parent 7f050a1
commit f979b75
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 4 deletions.
diff --git a/vue-language-tools/vue-component-meta/src/index.ts b/vue-language-tools/vue-component-meta/src/index.ts
@@ -427,16 +427,27 @@ function createSchemaResolvers(
 	const ignore = typeof options === 'object' ? [...options?.ignore ?? []] : [];
 
 	function shouldIgnore(subtype: ts.Type) {
-		const type = typeChecker.typeToString(subtype);
-		if (type === 'any') {
+		const name = typeChecker.typeToString(subtype);
+		if (name === 'any') {
 			return true;
 		}
 
 		if (ignore.length === 0) {
 			return false;
 		}
 
-		return ignore.includes(type);
+		for (const item of ignore) {
+			if (typeof item === 'function') {
+				const result = item(name, subtype, typeChecker);
+				if (result != null)
+					return result
+			}
+			else if (name === item) {
+				return true;
+			}
+		}
+
+		return false;
 	}
 
 	function setVisited(subtype: ts.Type) {

diff --git a/vue-language-tools/vue-component-meta/src/types.ts b/vue-language-tools/vue-component-meta/src/types.ts
@@ -46,8 +46,13 @@ export type PropertyMetaSchema = string
 	| { kind: 'object', type: string, schema?: Record<string, PropertyMeta>; };
 
 export type MetaCheckerSchemaOptions = boolean | {
-	ignore?: string[];
+	/**
+	 * A list of type names to be ignored in expending in schema.
+	 * Can be functions to ignore types dynamically.
+	 */
+	ignore?: (string | ((name: string, type: ts.Type, typeChecker: ts.TypeChecker) => boolean | void | undefined | null))[];
 };
+
 export interface MetaCheckerOptions {
 	schema?: MetaCheckerSchemaOptions;
 	forceUseTs?: boolean;