@inquirer/rawlist 2.2.3 → 2.3.0

package/README.md

@@ -90,11 +90,13 @@ type Choice<Value> = {
 
 Here's each property:
 
-- `value`: The value is what will be returned by `await select()`.
+- `value`: The value is what will be returned by `await rawlist()`.
 - `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`.
 
+`choices` can also be an array of string, in which case the string will be used both as the `value` and the `name`.
+
 ## Theming
 
 You can theme a prompt by passing a `theme` object option. The theme object only need to includes the keys you wish to modify, we'll fallback on the defaults for the rest.

package/dist/cjs/index.js

@@ -10,8 +10,32 @@ const numberRegex = /\d+/;
 function isSelectableChoice(choice) {
     return choice != null && !core_1.Separator.isSeparator(choice);
 }
+function normalizeChoices(choices) {
+    let index = 0;
+    return choices.map((choice) => {
+        var _a, _b, _c;
+        if (core_1.Separator.isSeparator(choice))
+            return choice;
+        index += 1;
+        if (typeof choice === 'string') {
+            return {
+                value: choice,
+                name: choice,
+                short: choice,
+                key: String(index),
+            };
+        }
+        const name = (_a = choice.name) !== null && _a !== void 0 ? _a : String(choice.value);
+        return {
+            value: choice.value,
+            name,
+            short: (_b = choice.short) !== null && _b !== void 0 ? _b : name,
+            key: (_c = choice.key) !== null && _c !== void 0 ? _c : String(index),
+        };
+    });
+}
 exports.default = (0, core_1.createPrompt)((config, done) => {
-    const { choices } = config;
+    const choices = (0, core_1.useMemo)(() => normalizeChoices(config.choices), [config.choices]);
     const [status, setStatus] = (0, core_1.useState)('pending');
     const [value, setValue] = (0, core_1.useState)('');
     const [errorMsg, setError] = (0, core_1.useState)();
@@ -49,15 +73,13 @@ exports.default = (0, core_1.createPrompt)((config, done) => {
     if (status === 'done') {
         return `${prefix} ${message} ${theme.style.answer(value)}`;
     }
-    let index = 0;
     const choicesStr = choices
         .map((choice) => {
         if (core_1.Separator.isSeparator(choice)) {
             return ` ${choice.separator}`;
         }
-        index += 1;
-        const line = `  ${choice.key || index}) ${String(choice.name || choice.value)}`;
-        if (choice.key === value.toLowerCase() || String(index) === value) {
+        const line = `  ${choice.key}) ${choice.name}`;
+        if (choice.key === value.toLowerCase()) {
             return theme.style.highlight(line);
         }
         return line;

package/dist/cjs/types/index.d.ts

@@ -8,7 +8,7 @@ type Choice<Value> = {
 };
 declare const _default: <Value>(config: {
     message: string;
-    choices: readonly (Separator | Choice<Value>)[];
+    choices: readonly (string | Separator)[] | readonly (Separator | Choice<Value>)[];
     theme?: PartialDeep<Theme> | undefined;
 }, context?: import("@inquirer/type").Context) => import("@inquirer/type").CancelablePromise<Value>;
 export default _default;

package/dist/esm/index.mjs

@@ -1,11 +1,34 @@
-import { createPrompt, useState, useKeypress, usePrefix, isEnterKey, Separator, makeTheme, } from '@inquirer/core';
+import { createPrompt, useMemo, useState, useKeypress, usePrefix, isEnterKey, Separator, makeTheme, } from '@inquirer/core';
 import colors from 'yoctocolors-cjs';
 const numberRegex = /\d+/;
 function isSelectableChoice(choice) {
     return choice != null && !Separator.isSeparator(choice);
 }
+function normalizeChoices(choices) {
+    let index = 0;
+    return choices.map((choice) => {
+        if (Separator.isSeparator(choice))
+            return choice;
+        index += 1;
+        if (typeof choice === 'string') {
+            return {
+                value: choice,
+                name: choice,
+                short: choice,
+                key: String(index),
+            };
+        }
+        const name = choice.name ?? String(choice.value);
+        return {
+            value: choice.value,
+            name,
+            short: choice.short ?? name,
+            key: choice.key ?? String(index),
+        };
+    });
+}
 export default createPrompt((config, done) => {
-    const { choices } = config;
+    const choices = useMemo(() => normalizeChoices(config.choices), [config.choices]);
     const [status, setStatus] = useState('pending');
     const [value, setValue] = useState('');
     const [errorMsg, setError] = useState();
@@ -42,15 +65,13 @@ export default createPrompt((config, done) => {
     if (status === 'done') {
         return `${prefix} ${message} ${theme.style.answer(value)}`;
     }
-    let index = 0;
     const choicesStr = choices
         .map((choice) => {
         if (Separator.isSeparator(choice)) {
             return ` ${choice.separator}`;
         }
-        index += 1;
-        const line = `  ${choice.key || index}) ${String(choice.name || choice.value)}`;
-        if (choice.key === value.toLowerCase() || String(index) === value) {
+        const line = `  ${choice.key}) ${choice.name}`;
+        if (choice.key === value.toLowerCase()) {
             return theme.style.highlight(line);
         }
         return line;

package/dist/esm/types/index.d.mts

@@ -8,7 +8,7 @@ type Choice<Value> = {
 };
 declare const _default: <Value>(config: {
     message: string;
-    choices: readonly (Separator | Choice<Value>)[];
+    choices: readonly (string | Separator)[] | readonly (Separator | Choice<Value>)[];
     theme?: PartialDeep<Theme> | undefined;
 }, context?: import("@inquirer/type").Context) => import("@inquirer/type").CancelablePromise<Value>;
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/rawlist",
-  "version": "2.2.3",
+  "version": "2.3.0",
   "description": "Inquirer rawlist prompt",
   "main": "./dist/cjs/index.js",
   "typings": "./dist/cjs/types/index.d.ts",
@@ -54,12 +54,12 @@
   "license": "MIT",
   "homepage": "https://github.com/SBoudrias/Inquirer.js/blob/main/packages/rawlist/README.md",
   "dependencies": {
-    "@inquirer/core": "^9.0.9",
-    "@inquirer/type": "^1.5.2",
+    "@inquirer/core": "^9.1.0",
+    "@inquirer/type": "^1.5.3",
     "yoctocolors-cjs": "^2.1.2"
   },
   "devDependencies": {
-    "@inquirer/testing": "^2.1.31"
+    "@inquirer/testing": "^2.1.32"
   },
   "scripts": {
     "tsc": "yarn run tsc:esm && yarn run tsc:cjs",
@@ -86,5 +86,5 @@
     }
   },
   "sideEffects": false,
-  "gitHead": "056e26aa6497e0036864d032f9eb8d821de821e7"
+  "gitHead": "0c039599ef88fe9eb804fe083ee386ec906a856f"
 }