fix: render flag choices

Author: vladfrangu

src/entrypoints/_shared.ts

@@ -98,7 +98,7 @@ export async function runCLI(entrypoint: string) {
 			const commandFlags = Object.entries(command.flags ?? {})
 				.filter(([, flag]) => typeof flag !== 'string')
 				.map(([flagName, flag]) => {
-					const castedFlag = flag as TaggedFlagBuilder<FlagTag, unknown, unknown, unknown>;
+					const castedFlag = flag as TaggedFlagBuilder<FlagTag, string[] | null, unknown, unknown>;
 
 					const flagKey = kebabCaseString(camelCaseToKebabCase(flagName)).toLowerCase();
 

src/lib/command-framework/apify-command.ts

@@ -35,7 +35,7 @@ type If<T, Y, N> = T extends true ? Y : N;
 type IfNotUnknown<T, Y, N> = T extends unknown ? Y : N;
 
 type InferFlagTypeFromFlag<
-	Builder extends TaggedFlagBuilder<FlagTag, unknown, unknown, unknown>,
+	Builder extends TaggedFlagBuilder<FlagTag, string[] | null, unknown, unknown>,
 	OptionalIfHasDefault = false,
 > = Builder extends TaggedFlagBuilder<infer ReturnedType, never, infer Required, infer HasDefault> // Handle special case where there can be no choices
 	? If<
@@ -90,7 +90,7 @@ type _InferArgsFromCommand<O extends Record<string, TaggedArgBuilder<ArgTag, unk
 };
 
 type _InferFlagsFromCommand<
-	O extends Record<string, TaggedFlagBuilder<FlagTag, unknown, unknown, unknown>>,
+	O extends Record<string, TaggedFlagBuilder<FlagTag, string[] | null, unknown, unknown>>,
 	OptionalIfHasDefault = false,
 > = {
 	[K in keyof O as CamelCase<string & K>]: InferFlagTypeFromFlag<O[K], OptionalIfHasDefault>;
@@ -101,7 +101,7 @@ type InferArgsFromCommand<O extends Record<string, TaggedArgBuilder<ArgTag, unkn
 	: _InferArgsFromCommand<Exclude<O, undefined>>;
 
 type InferFlagsFromCommand<
-	O extends Record<string, TaggedFlagBuilder<FlagTag, unknown, unknown, unknown>> | undefined,
+	O extends Record<string, TaggedFlagBuilder<FlagTag, string[] | null, unknown, unknown>> | undefined,
 	OptionalIfHasDefault = false,
 > = (O extends undefined
 	? Record<string, unknown>
@@ -128,7 +128,7 @@ export abstract class ApifyCommand<T extends typeof BuiltApifyCommand = typeof B
 		json?: 'Do not use json as the key of an argument, as it will prevent the --json flag from working';
 	};
 
-	static flags?: Record<string, TaggedFlagBuilder<FlagTag, unknown, unknown, unknown>> & {
+	static flags?: Record<string, TaggedFlagBuilder<FlagTag, string[] | null, unknown, unknown>> & {
 		json?: 'Do not use json as the key of a flag, override the enableJsonFlag static property instead';
 	};
 

src/lib/command-framework/flags.ts

@@ -35,7 +35,12 @@ export interface IntegerFlagOptions extends BaseFlagOptions {
 	default?: number;
 }
 
-export type TaggedFlagBuilder<Tag extends FlagTag, ChoicesType = unknown, Required = boolean, HasDefault = false> = {
+export type TaggedFlagBuilder<
+	Tag extends FlagTag,
+	ChoicesType extends readonly string[] | null,
+	Required = boolean,
+	HasDefault = false,
+> = {
 	flagTag: Tag;
 	builder: (args: Argv, objectName: string, extraArgs?: string[], invertDefaultIfSet?: boolean) => Argv;
 	choicesType: ChoicesType;
@@ -57,7 +62,7 @@ export const Flags = {
 	integer: integerFlag,
 };
 
-function stringFlag<const Choices, const T extends StringFlagOptions<readonly string[]>>(
+function stringFlag<const Choices extends string[], const T extends StringFlagOptions<readonly string[]>>(
 	options: T & { choices?: Choices },
 ): TaggedFlagBuilder<'string', Choices, T['default'] extends string ? true : T['required'], T['default']> {
 	return {

src/lib/command-framework/help/CommandHelp.ts

@@ -141,7 +141,7 @@ export class CommandHelp extends BaseCommandRenderer {
 				}
 
 				return a[0].localeCompare(b[0]);
-			}) as [string, TaggedFlagBuilder<FlagTag, unknown, unknown, unknown>][],
+			}) as [string, TaggedFlagBuilder<FlagTag, string[] | null, unknown, unknown>][],
 		);
 
 		const flagsToIgnore = new Set<string>();
@@ -226,14 +226,17 @@ export class CommandHelp extends BaseCommandRenderer {
 		result.push('');
 	}
 
-	protected pushFlags(result: string[], flags: Map<string, TaggedFlagBuilder<FlagTag, unknown, unknown, unknown>>) {
+	protected pushFlags(
+		result: string[],
+		flags: Map<string, TaggedFlagBuilder<FlagTag, string[] | null, unknown, unknown>>,
+	) {
 		if (!flags.size) {
 			return;
 		}
 
 		result.push(chalk.bold('FLAGS'));
 
-		const linesOfFlags = new Map<string, TaggedFlagBuilder<FlagTag, unknown, unknown, unknown>>();
+		const linesOfFlags = new Map<string, TaggedFlagBuilder<FlagTag, string[] | null, unknown, unknown>>();
 
 		for (const [flagName, flag] of flags) {
 			const stringParts: string[] = [];
@@ -249,9 +252,12 @@ export class CommandHelp extends BaseCommandRenderer {
 					stringParts.push(`--${this.kebabFlagName(flagName)}`);
 					break;
 				case 'string':
-				case 'integer':
-					stringParts.push(`--${this.kebabFlagName(flagName)}=${chalk.underline('<value>')}`);
+				case 'integer': {
+					const flagValues = flag.choicesType ? '<option>' : '<value>';
+
+					stringParts.push(`--${this.kebabFlagName(flagName)}=${chalk.underline(flagValues)}`);
 					break;
+				}
 				default:
 					throw new Error(`Unhandled flag tag: ${flag.flagTag}`);
 			}
@@ -263,7 +269,11 @@ export class CommandHelp extends BaseCommandRenderer {
 
 		for (const [flagString, flag] of linesOfFlags) {
 			const paddingToAdd = widestFlagNameLength - stripAnsi(flagString).length;
-			const fullString = `${flagString}${' '.repeat(paddingToAdd)}  ${flag.description ?? ''}`;
+			let fullString = `${flagString}${' '.repeat(paddingToAdd)}  ${flag.description ?? ''}`;
+
+			if (flag.choicesType?.length) {
+				fullString += `\n<options: ${flag.choicesType.join('|')}>`;
+			}
 
 			const wrapped = wrap(fullString, getMaxLineWidth() - widestFlagNameLength);
 

src/lib/command-framework/help/_BaseCommandRenderer.ts

@@ -73,7 +73,7 @@ export abstract class BaseCommandRenderer {
 		return kebabCaseString(camelCaseToKebabCase(flagName)).toLowerCase();
 	}
 
-	protected makeFlagString(flagName: string, flag: TaggedFlagBuilder<FlagTag, unknown, unknown, unknown>) {
+	protected makeFlagString(flagName: string, flag: TaggedFlagBuilder<FlagTag, string[] | null, unknown, unknown>) {
 		const flagKey = this.kebabFlagName(flagName);
 
 		const mainFlagPart = flag.char ? `-${flag.char}` : `--${flagKey}`;
@@ -85,7 +85,9 @@ export abstract class BaseCommandRenderer {
 
 			case 'string':
 			case 'integer': {
-				return `${mainFlagPart} <value>`;
+				const flagValues = flag.choicesType?.length ? `${flag.choicesType.join('|')}` : '<value>';
+
+				return `${mainFlagPart} ${flagValues}`;
 			}
 
 			default: {