@inquirer/select 4.0.10 → 4.1.1

package/README.md

@@ -4,6 +4,16 @@ Simple interactive command line prompt to display a list of choices (single sele
 
 ![select prompt](https://cdn.rawgit.com/SBoudrias/Inquirer.js/28ae8337ba51d93e359ef4f7ee24e79b69898962/assets/screenshots/list.svg)
 
+# Special Thanks
+
+<div align="center" markdown="1">
+
+[![Graphite](https://github.com/user-attachments/assets/53db40ca-2254-481a-a094-6597f8716e29)](https://graphite.dev/?utm_source=npmjs&utm_medium=repo&utm_campaign=inquirerjs)<br>
+
+### [Graphite is the AI developer productivity platform helping teams on GitHub ship higher quality software, faster](https://graphite.dev/?utm_source=npmjs&utm_medium=repo&utm_campaign=inquirerjs)
+
+</div>
+
 # Installation
 
 <table>
@@ -144,6 +154,7 @@ type Theme = {
     cursor: string;
   };
   helpMode: 'always' | 'never' | 'auto';
+  indexMode: 'hidden' | 'number';
 };
 ```
 
@@ -153,6 +164,13 @@ type Theme = {
 - `always`: The help tips will always show and never hide.
 - `never`: The help tips will never show.
 
+### `theme.indexMode`
+
+Controls how indices are displayed before each choice:
+
+- `hidden` (default): No indices are shown
+- `number`: Display a number before each choice (e.g. "1. Option A")
+
 # License
 
 Copyright (c) 2023 Simon Boudrias (twitter: [@vaxilart](https://twitter.com/Vaxilart))<br/>

package/dist/commonjs/index.d.ts

@@ -9,6 +9,7 @@ type SelectTheme = {
         description: (text: string) => string;
     };
     helpMode: 'always' | 'never' | 'auto';
+    indexMode: 'hidden' | 'number';
 };
 type Choice<Value> = {
     value: Value;

package/dist/commonjs/index.js

@@ -15,6 +15,7 @@ const selectTheme = {
         description: (text) => yoctocolors_cjs_1.default.cyan(text),
     },
     helpMode: 'auto',
+    indexMode: 'hidden',
 };
 function isSelectable(item) {
     return !core_1.Separator.isSeparator(item) && !item.disabled;
@@ -32,13 +33,16 @@ function normalizeChoices(choices) {
             };
         }
         const name = choice.name ?? String(choice.value);
-        return {
+        const normalizedChoice = {
             value: choice.value,
             name,
-            description: choice.description,
             short: choice.short ?? name,
             disabled: choice.disabled ?? false,
         };
+        if (choice.description) {
+            normalizedChoice.description = choice.description;
+        }
+        return normalizedChoice;
     });
 }
 exports.default = (0, core_1.createPrompt)((config, done) => {
@@ -84,13 +88,15 @@ exports.default = (0, core_1.createPrompt)((config, done) => {
                 setActive(next);
             }
         }
-        else if ((0, core_1.isNumberKey)(key)) {
-            rl.clearLine(0);
-            const position = Number(key.name) - 1;
+        else if ((0, core_1.isNumberKey)(key) && !Number.isNaN(Number(rl.line))) {
+            const position = Number(rl.line) - 1;
             const item = items[position];
             if (item != null && isSelectable(item)) {
                 setActive(position);
             }
+            searchTimeoutRef.current = setTimeout(() => {
+                rl.clearLine(0);
+            }, 700);
         }
         else if ((0, core_1.isBackspaceKey)(key)) {
             rl.clearLine(0);
@@ -130,17 +136,18 @@ exports.default = (0, core_1.createPrompt)((config, done) => {
     const page = (0, core_1.usePagination)({
         items,
         active,
-        renderItem({ item, isActive }) {
+        renderItem({ item, isActive, index }) {
             if (core_1.Separator.isSeparator(item)) {
                 return ` ${item.separator}`;
             }
+            const indexLabel = theme.indexMode === 'number' ? `${index + 1}. ` : '';
             if (item.disabled) {
                 const disabledLabel = typeof item.disabled === 'string' ? item.disabled : '(disabled)';
-                return theme.style.disabled(`${item.name} ${disabledLabel}`);
+                return theme.style.disabled(`${indexLabel}${item.name} ${disabledLabel}`);
             }
             const color = isActive ? theme.style.highlight : (x) => x;
             const cursor = isActive ? theme.icon.cursor : ` `;
-            return color(`${cursor} ${item.name}`);
+            return color(`${cursor} ${indexLabel}${item.name}`);
         },
         pageSize,
         loop,

package/dist/esm/index.d.ts

@@ -9,6 +9,7 @@ type SelectTheme = {
         description: (text: string) => string;
     };
     helpMode: 'always' | 'never' | 'auto';
+    indexMode: 'hidden' | 'number';
 };
 type Choice<Value> = {
     value: Value;

package/dist/esm/index.js

@@ -9,6 +9,7 @@ const selectTheme = {
         description: (text) => colors.cyan(text),
     },
     helpMode: 'auto',
+    indexMode: 'hidden',
 };
 function isSelectable(item) {
     return !Separator.isSeparator(item) && !item.disabled;
@@ -26,13 +27,16 @@ function normalizeChoices(choices) {
             };
         }
         const name = choice.name ?? String(choice.value);
-        return {
+        const normalizedChoice = {
             value: choice.value,
             name,
-            description: choice.description,
             short: choice.short ?? name,
             disabled: choice.disabled ?? false,
         };
+        if (choice.description) {
+            normalizedChoice.description = choice.description;
+        }
+        return normalizedChoice;
     });
 }
 export default createPrompt((config, done) => {
@@ -78,13 +82,15 @@ export default createPrompt((config, done) => {
                 setActive(next);
             }
         }
-        else if (isNumberKey(key)) {
-            rl.clearLine(0);
-            const position = Number(key.name) - 1;
+        else if (isNumberKey(key) && !Number.isNaN(Number(rl.line))) {
+            const position = Number(rl.line) - 1;
             const item = items[position];
             if (item != null && isSelectable(item)) {
                 setActive(position);
             }
+            searchTimeoutRef.current = setTimeout(() => {
+                rl.clearLine(0);
+            }, 700);
         }
         else if (isBackspaceKey(key)) {
             rl.clearLine(0);
@@ -124,17 +130,18 @@ export default createPrompt((config, done) => {
     const page = usePagination({
         items,
         active,
-        renderItem({ item, isActive }) {
+        renderItem({ item, isActive, index }) {
             if (Separator.isSeparator(item)) {
                 return ` ${item.separator}`;
             }
+            const indexLabel = theme.indexMode === 'number' ? `${index + 1}. ` : '';
             if (item.disabled) {
                 const disabledLabel = typeof item.disabled === 'string' ? item.disabled : '(disabled)';
-                return theme.style.disabled(`${item.name} ${disabledLabel}`);
+                return theme.style.disabled(`${indexLabel}${item.name} ${disabledLabel}`);
             }
             const color = isActive ? theme.style.highlight : (x) => x;
             const cursor = isActive ? theme.icon.cursor : ` `;
-            return color(`${cursor} ${item.name}`);
+            return color(`${cursor} ${indexLabel}${item.name}`);
         },
         pageSize,
         loop,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/select",
-  "version": "4.0.10",
+  "version": "4.1.1",
   "description": "Inquirer select/list prompt",
   "keywords": [
     "answer",
@@ -74,15 +74,15 @@
     "tsc": "tshy"
   },
   "dependencies": {
-    "@inquirer/core": "^10.1.8",
+    "@inquirer/core": "^10.1.10",
     "@inquirer/figures": "^1.0.11",
-    "@inquirer/type": "^3.0.5",
+    "@inquirer/type": "^3.0.6",
     "ansi-escapes": "^4.3.2",
     "yoctocolors-cjs": "^2.1.2"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.4",
-    "@inquirer/testing": "^2.1.45",
+    "@inquirer/testing": "^2.1.46",
     "@repo/tsconfig": "workspace:*",
     "tshy": "^3.0.2"
   },
@@ -109,5 +109,5 @@
       "optional": true
     }
   },
-  "gitHead": "79a0b3e7446b4a3de09445bf2f4031e4190b6382"
+  "gitHead": "d367155a8d64d8b3e93f9c763adccf708aedc8a8"
 }