Add support for select prompts for number options

Author: ryangoree

.changeset/khaki-doodles-heal.md

@@ -0,0 +1,5 @@
+---
+"@gud/cli": minor
+---
+
+Added support for select prompts when the option type is "number" and added type inference to the choice values based on the option type.

packages/cli/src/core/client.ts

@@ -1,7 +1,12 @@
 import { Console } from 'node:console';
 import process from 'node:process';
-import prompts, { type PromptObject, type PromptType } from 'prompts';
+import prompts, {
+  type Choice,
+  type PromptObject,
+  type PromptType,
+} from 'prompts';
 import { CliError, type CliErrorOptions } from 'src/core/errors';
+import type { OptionPrimitiveType, OptionType } from 'src/core/options/options';
 import type { KeyMap, Replace } from 'src/utils/types';
 
 // Errors //
@@ -58,14 +63,23 @@ export type PromptPrimitiveType<T extends PromptType = PromptType> =
  * @see [GitHub - terkelg/prompts - Prompt Objects](https://github.com/terkelg/prompts#-prompt-objects)
  * @group Client
  */
-export type PromptParams<T extends PromptType = PromptType> = Replace<
+export type PromptParams<
+  T extends PromptType = PromptType,
+  TOptionType extends OptionType = OptionType,
+> = Replace<
   Omit<PromptObject, 'name' | 'separator'>,
   {
     // make the message property required since prompts throws an error if it's
     // not defined.
     message: NonNullable<prompts.PromptObject['message']>;
     // make the type property optional since we'll default to 'text'
     type?: T;
+    choices?: Replace<
+      Choice,
+      {
+        value?: OptionPrimitiveType<TOptionType>;
+      }
+    >[];
   }
 >;
 

packages/cli/src/core/options/option-prompt.ts

@@ -15,7 +15,7 @@ export type OptionPromptTypeMap = KeyMap<
   {
     array: 'autocompleteMultiselect' | 'list' | 'multiselect';
     boolean: 'confirm' | 'toggle';
-    number: 'number';
+    number: 'number' | 'select';
     secret: 'invisible' | 'password';
     string:
       | 'autocomplete'
@@ -32,7 +32,7 @@ export type OptionPromptType<T extends OptionType> = OptionPromptTypeMap[T];
 // Functions + Function Types //
 
 export type OptionPromptParams<T extends OptionConfig = OptionConfig> = Replace<
-  PromptParams,
+  PromptParams<OptionPromptType<T['type']>, T['type']>,
   {
     /**
      * The name of the option.

packages/cli/src/core/options/options-getter.ts

@@ -34,7 +34,9 @@ type OptionGetterParams<T extends OptionConfig = OptionConfig> = Pick<
   /**
    * The prompt to show the user if no value is provided (optional).
    */
-  prompt?: string | Omit<PromptParams<OptionPromptType<T['type']>>, 'validate'>;
+  prompt?:
+    | string
+    | Omit<PromptParams<OptionPromptType<T['type']>, T['type']>, 'validate'>;
 };
 
 /**

packages/cli/src/utils/types.ts

@@ -29,7 +29,7 @@ export type Eval<T> = { [K in keyof T]: T[K] } & unknown;
 /**
  * Replace properties in `T` with properties in `U`.
  */
-export type Replace<T, U> = Omit<T, keyof U> & U;
+export type Replace<T, U extends Partial<T> | {}> = Omit<T, keyof U> & U;
 
 /**
  * The opposite of {@linkcode Readonly<T>}. Make all properties in `T` mutable.