@inquirer/rawlist 5.0.2 → 5.2.0

package/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.
@@ -86,6 +87,7 @@ type Choice<Value> = {
   name?: string;
   short?: string;
   key?: string;
+  description?: string;
 };
 ```
 
@@ -95,6 +97,7 @@ Here's each property:
 - `name`: This is the string displayed in the choice list.
 - `short`: Once the prompt is done (press enter), we'll use `short` if defined to render next to the question. By default we'll use `name`.
 - `key`: The key of the choice. Displayed as `key) name`.
+- `description`: Option description which appears below the list when the choice is selected.
 
 `choices` can also be an array of string, in which case the string will be used both as the `value` and the `name`.
 
@@ -114,6 +117,7 @@ type Theme = {
     message: (text: string, status: 'idle' | 'done' | 'loading') => string;
     error: (text: string) => string;
     highlight: (text: string) => string;
+    description: (text: string) => string;
   };
 };
 ```

package/dist/index.d.ts

@@ -1,16 +1,23 @@
 import { Separator, type Theme } from '@inquirer/core';
 import type { PartialDeep } from '@inquirer/type';
+type RawlistTheme = {
+    style: {
+        description: (text: string) => string;
+    };
+};
 type Choice<Value> = {
     value: Value;
     name?: string;
     short?: string;
     key?: string;
+    description?: string;
 };
 declare const _default: <Value>(config: {
     message: string;
-    choices: readonly (string | Separator)[] | readonly (Separator | Choice<Value>)[];
+    choices: readonly (Separator | Value | Choice<Value>)[];
     loop?: boolean | undefined;
-    theme?: PartialDeep<Theme> | undefined;
+    theme?: PartialDeep<Theme<RawlistTheme>> | undefined;
+    default?: NoInfer<Value> | undefined;
 }, context?: import("@inquirer/type").Context) => Promise<Value>;
 export default _default;
 export { Separator } from '@inquirer/core';

package/dist/index.js

@@ -1,6 +1,11 @@
 import { createPrompt, useMemo, useState, useKeypress, usePrefix, isDownKey, isEnterKey, isUpKey, Separator, makeTheme, ValidationError, } from '@inquirer/core';
 import { styleText } from 'node:util';
 const numberRegex = /\d+/;
+const rawlistTheme = {
+    style: {
+        description: (text) => styleText('cyan', text),
+    },
+};
 function isSelectableChoice(choice) {
     return choice != null && !Separator.isSeparator(choice);
 }
@@ -10,11 +15,12 @@ function normalizeChoices(choices) {
         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,
-                name: choice,
-                short: choice,
+                name,
+                short: name,
                 key: String(index),
             };
         }
@@ -24,6 +30,7 @@ function normalizeChoices(choices) {
             name,
             short: choice.short ?? name,
             key: choice.key ?? String(index),
+            description: choice.description,
         };
     });
 }
@@ -45,9 +52,14 @@ export default createPrompt((config, done) => {
     const { loop = true } = config;
     const choices = useMemo(() => normalizeChoices(config.choices), [config.choices]);
     const [status, setStatus] = useState('idle');
-    const [value, setValue] = useState('');
+    const [value, setValue] = useState(() => {
+        const defaultChoice = config.default == null
+            ? undefined
+            : choices.find((choice) => isSelectableChoice(choice) && choice.value === config.default);
+        return defaultChoice?.key ?? '';
+    });
     const [errorMsg, setError] = useState();
-    const theme = makeTheme(config.theme);
+    const theme = makeTheme(rawlistTheme, config.theme);
     const prefix = usePrefix({ status, theme });
     const bounds = useMemo(() => {
         const first = choices.findIndex(isSelectableChoice);
@@ -107,7 +119,7 @@ export default createPrompt((config, done) => {
             return ` ${choice.separator}`;
         }
         const line = `  ${choice.key}) ${choice.name}`;
-        if (choice.key === value.toLowerCase()) {
+        if (choice.key === value) {
             return theme.style.highlight(line);
         }
         return line;
@@ -117,9 +129,14 @@ export default createPrompt((config, done) => {
     if (errorMsg) {
         error = theme.style.error(errorMsg);
     }
+    const [selectedChoice] = getSelectedChoice(value, choices);
+    let description = '';
+    if (!errorMsg && selectedChoice?.description) {
+        description = theme.style.description(selectedChoice.description);
+    }
     return [
         `${prefix} ${message} ${value}`,
-        [choicesStr, error].filter(Boolean).join('\n'),
+        [choicesStr, error, description].filter(Boolean).join('\n'),
     ];
 });
 export { Separator } from '@inquirer/core';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/rawlist",
-  "version": "5.0.2",
+  "version": "5.2.0",
   "description": "Inquirer rawlist prompt",
   "keywords": [
     "answer",
@@ -42,41 +42,38 @@
     "zsh"
   ],
   "homepage": "https://github.com/SBoudrias/Inquirer.js/blob/main/packages/rawlist/README.md",
+  "license": "MIT",
+  "author": "Simon Boudrias <admin@simonboudrias.com>",
   "repository": {
     "type": "git",
     "url": "https://github.com/SBoudrias/Inquirer.js.git"
   },
-  "license": "MIT",
-  "author": "Simon Boudrias <admin@simonboudrias.com>",
-  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
   "type": "module",
+  "sideEffects": false,
   "exports": {
-    "./package.json": "./package.json",
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
-    }
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
   },
-  "files": [
-    "dist"
-  ],
   "scripts": {
     "tsc": "tsc"
   },
   "dependencies": {
-    "@inquirer/core": "^11.0.2",
-    "@inquirer/type": "^4.0.2"
+    "@inquirer/core": "^11.1.1",
+    "@inquirer/type": "^4.0.3"
   },
   "devDependencies": {
-    "@inquirer/testing": "^3.0.2",
+    "@inquirer/testing": "^3.0.4",
     "typescript": "^5.9.3"
   },
-  "engines": {
-    "node": ">=23.5.0 || ^22.13.0 || ^21.7.0 || ^20.12.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
   "peerDependencies": {
     "@types/node": ">=18"
   },
@@ -85,7 +82,10 @@
       "optional": true
     }
   },
+  "engines": {
+    "node": ">=23.5.0 || ^22.13.0 || ^21.7.0 || ^20.12.0"
+  },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "gitHead": "9c724296daad3d740b09173f9aae035dc62cb106"
+  "gitHead": "99d00a9adc53be8b7edf5926b2ec4ba0b792f68f"
 }