feat(core, plugin-help)!: rename types and functions

Author: so1ve

docs/official-plugins/plugin-help.md

@@ -186,7 +186,7 @@ const cli = Clerc.create()
 			banner: "Welcome to My CLI application!", // Custom banner
 			formatters: {
 				// Custom type formatting functions
-				formatFlagType: (type: FlagType) => {
+				formatTypeValue: (type) => {
 					if (typeof type === "function") {
 						return type.name;
 					}

docs/zh/official-plugins/plugin-help.md

@@ -183,7 +183,7 @@ const cli = Clerc.create()
 			banner: "欢迎使用 My CLI 应用程序！", // 自定义横幅
 			formatters: {
 				// 自定义类型格式化函数
-				formatFlagType: (type: FlagType) => {
+				formatTypeValue: (type) => {
 					if (typeof type === "function") {
 						return type.name;
 					}

packages/core/src/types/flag.ts

@@ -1,11 +1,11 @@
-import type { FlagOptions, FlagType } from "@clerc/parser";
+import type { FlagOptions, TypeValue } from "@clerc/parser";
 
 export declare interface FlagCustomOptions {}
 
 export type ClercFlagOptions = FlagOptions & {
 	description?: string;
 } & FlagCustomOptions;
 
-export type ClercFlagDefinitionValue = ClercFlagOptions | FlagType;
+export type ClercFlagDefinitionValue = ClercFlagOptions | TypeValue;
 
 export type ClercFlagsDefinition = Record<string, ClercFlagDefinitionValue>;

packages/parser/src/types.ts

@@ -36,11 +36,11 @@ export type IgnoreFunction = (
 	arg: string,
 ) => boolean;
 
-export type FlagType<T = unknown> =
+export type TypeValue<T = unknown> =
 	| TypeFunction<T>
 	| readonly [TypeFunction<T>];
 
-export interface BaseFlagOptions<T extends FlagType = FlagType> {
+export interface BaseFlagOptions<T extends TypeValue = TypeValue> {
 	/**
 	 * The type constructor or a function to convert the string value.
 	 * To support multiple occurrences of a flag (e.g., --file a --file b), wrap the type in an array: [String], [Number].
@@ -68,7 +68,7 @@ export type FlagOptions =
 	| (BaseFlagOptions & {
 			negatable?: never;
 	  });
-export type FlagDefinitionValue = FlagOptions | FlagType;
+export type FlagDefinitionValue = FlagOptions | TypeValue;
 export type FlagsDefinition = Record<string, FlagDefinitionValue>;
 
 /**
@@ -148,10 +148,10 @@ type _InferFlags<T extends FlagsDefinition> = {
 			: T[K] extends ObjectConstructor | { type: ObjectConstructor }
 				? ObjectInputType | InferFlagDefault<T[K], never>
 				: T[K] extends
-							| readonly [FlagType<infer U>]
-							| { type: readonly [FlagType<infer U>] }
+							| readonly [TypeValue<infer U>]
+							| { type: readonly [TypeValue<infer U>] }
 					? U[] | InferFlagDefault<T[K], never>
-					: T[K] extends FlagType<infer U> | { type: FlagType<infer U> }
+					: T[K] extends TypeValue<infer U> | { type: TypeValue<infer U> }
 						?
 								| U
 								| InferFlagDefault<

packages/plugin-help/src/formatters.ts

@@ -1,7 +1,7 @@
 import type { Formatters } from "./types";
-import { formatFlagDefault, formatFlagType } from "./utils";
+import { formatFlagDefault, formatTypeValue } from "./utils";
 
 export const defaultFormatters: Formatters = {
-	formatFlagType,
+	formatTypeValue,
 	formatFlagDefault,
 };

packages/plugin-help/src/renderer.ts

@@ -208,7 +208,7 @@ export class HelpRenderer {
 
 			return [
 				yc.bold(key),
-				type ? this._formatters.formatFlagType(type) : "string",
+				type ? this._formatters.formatTypeValue(type) : "string",
 				description,
 			].filter(isTruthy);
 		});
@@ -374,7 +374,7 @@ export class HelpRenderer {
 		)
 			.map(formatFlagName)
 			.join(", ");
-		const type = this._formatters.formatFlagType(flag.type);
+		const type = this._formatters.formatTypeValue(flag.type);
 
 		return [
 			yc.bold([flagName, aliases].filter(Boolean).join(", ")),

packages/plugin-help/src/types.ts

@@ -1,7 +1,7 @@
-import type { FlagDefaultValue, FlagType } from "@clerc/parser";
+import type { FlagDefaultValue, TypeValue } from "@clerc/parser";
 
 export interface Formatters {
-	formatFlagType: (type: FlagType) => string;
+	formatTypeValue: (type: TypeValue) => string;
 	formatFlagDefault: <T>(value: FlagDefaultValue<T>) => string;
 }
 

packages/plugin-help/src/utils.ts

@@ -1,6 +1,6 @@
-import type { FlagDefaultValue, FlagType } from "@clerc/parser";
+import type { FlagDefaultValue, TypeValue } from "@clerc/parser";
 
-export function formatFlagType(type: FlagType): string {
+export function formatTypeValue(type: TypeValue): string {
 	if (typeof type === "function") {
 		return type.display ?? type.name;
 	}