feat(@inquirer/rawlist) Add support for default

Author: MazenSamehR

packages/rawlist/README.md

@@ -72,6 +72,7 @@ const answer = await rawlist({
 | message  | `string`                | yes      | The question to ask                                                                                                               |
 | choices  | `Choice[]`              | yes      | List of the available choices.                                                                                                    |
 | loop     | `boolean`               | no       | Defaults to `true`. When set to `false`, the cursor will be constrained to the top and bottom of the choice list without looping. |
+| default  | `Value`                 | no       | The value of the choice to preselect. If the value is not found, no choice is preselected.                                       |
 | theme    | [See Theming](#Theming) | no       | Customize look of the prompt.                                                                                                     |
 
 `Separator` objects can be used in the `choices` array to render non-selectable lines in the choice list. By default it'll render a line, but you can provide the text as argument (`new Separator('-- Dependencies --')`). This option is often used to add labels to groups within long list of options.

packages/rawlist/rawlist.test.ts

@@ -1,4 +1,4 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expectTypeOf, it, expect } from 'vitest';
 import { render } from '@inquirer/testing';
 import rawlist, { Separator } from './src/index.ts';
 
@@ -389,4 +389,51 @@ describe('rawlist prompt', () => {
 
     await expect(answer).resolves.toEqual('second');
   });
+
+  describe('default', () => {
+    it('preselects the default value', async () => {
+      const { answer, events, getScreen } = await render(rawlist, {
+        message: 'Select a number',
+        choices: numberedChoices,
+        default: 2,
+      });
+
+      expect(getScreen()).toMatchInlineSnapshot(`
+        "? Select a number 2
+          1) 1
+          2) 2
+          3) 3
+          4) 4
+          5) 5"
+      `);
+
+      events.keypress('enter');
+      expectTypeOf(answer).resolves.toEqualTypeOf<number>();
+      expect(getScreen()).toMatchInlineSnapshot('"✔ Select a number 2"');
+      await expect(answer).resolves.toEqual(2);
+    });
+
+    it('ignores default value if not found', async () => {
+      const { answer, events, getScreen } = await render(rawlist, {
+        message: 'Select a fruit',
+        choices: [
+          { name: 'Apple', value: 'apple' },
+          { name: 'Banana', value: 'banana' },
+        ],
+        // Forcing an invalid default value
+        default: 'Oops! not in the list' as 'banana',
+      });
+
+      expect(getScreen()).toMatchInlineSnapshot(`
+        "? Select a fruit
+          1) Apple
+          2) Banana"
+      `);
+
+      events.type('1');
+      events.keypress('enter');
+      expectTypeOf(answer).resolves.toEqualTypeOf<'apple' | 'banana'>();
+      await expect(answer).resolves.toEqual('apple');
+    });
+  });
 });

packages/rawlist/src/index.ts

@@ -32,18 +32,12 @@ type NormalizedChoice<Value> = {
   key: string;
 };
 
-type RawlistConfig<
-  Value,
-  ChoicesObject =
-    | ReadonlyArray<string | Separator>
-    | ReadonlyArray<Choice<Value> | Separator>,
-> = {
+type RawlistConfig<Value> = {
   message: string;
-  choices: ChoicesObject extends ReadonlyArray<string | Separator>
-    ? ChoicesObject
-    : ReadonlyArray<Choice<Value> | Separator>;
+  choices: ReadonlyArray<Value | Choice<Value> | Separator>;
   loop?: boolean;
   theme?: PartialDeep<Theme>;
+  default?: NoInfer<Value>;
 };
 
 function isSelectableChoice<T>(
@@ -53,18 +47,19 @@ function isSelectableChoice<T>(
 }
 
 function normalizeChoices<Value>(
-  choices: ReadonlyArray<string | Separator> | ReadonlyArray<Choice<Value> | Separator>,
+  choices: ReadonlyArray<Value | Choice<Value> | Separator>,
 ): Array<NormalizedChoice<Value> | Separator> {
   let index = 0;
   return choices.map((choice) => {
     if (Separator.isSeparator(choice)) return choice;
 
     index += 1;
-    if (typeof choice === 'string') {
+    if (typeof choice !== 'object' || choice === null || !('value' in choice)) {
+      const name = String(choice);
       return {
-        value: choice as Value,
-        name: choice,
-        short: choice,
+        value: choice,
+        name,
+        short: name,
         key: String(index),
       };
     }
@@ -105,7 +100,16 @@ export default createPrompt(
     const { loop = true } = config;
     const choices = useMemo(() => normalizeChoices(config.choices), [config.choices]);
     const [status, setStatus] = useState<Status>('idle');
-    const [value, setValue] = useState<string>('');
+    const [value, setValue] = useState<string>(() => {
+      const defaultChoice =
+        config.default == null
+          ? undefined
+          : choices.find(
+              (choice): choice is NormalizedChoice<Value> =>
+                isSelectableChoice(choice) && choice.value === config.default,
+            );
+      return defaultChoice?.key ?? '';
+    });
     const [errorMsg, setError] = useState<string>();
     const theme = makeTheme(config.theme);
     const prefix = usePrefix({ status, theme });