@inquirer/select 4.4.1 → 5.0.0

package/README.md

@@ -152,7 +152,7 @@ type Theme = {
 
 This function allows you to customize the keyboard shortcuts help tip displayed below the prompt. It receives an array of key-action pairs and should return a formatted string. You can also hook here to localize the labels to different languages.
 
-It can also returns `undefined` to hide the help tip entirely. This is the replacement for the deprecated theme option `helpMode: 'never'`.
+It can also returns `undefined` to hide the help tip entirely.
 
 ```js
 theme: {

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+import { Separator, type Theme, type Keybinding } from '@inquirer/core';
+import type { PartialDeep } from '@inquirer/type';
+type SelectTheme = {
+    icon: {
+        cursor: string;
+    };
+    style: {
+        disabled: (text: string) => string;
+        description: (text: string) => string;
+        keysHelpTip: (keys: [key: string, action: string][]) => string | undefined;
+    };
+    indexMode: 'hidden' | 'number';
+    keybindings: ReadonlyArray<Keybinding>;
+};
+type Choice<Value> = {
+    value: Value;
+    name?: string;
+    description?: string;
+    short?: string;
+    disabled?: boolean | string;
+    type?: never;
+};
+declare const _default: <Value>(config: {
+    message: string;
+    choices: readonly (string | Separator)[] | readonly (Separator | Choice<Value>)[];
+    pageSize?: number | undefined;
+    loop?: boolean | undefined;
+    default?: unknown;
+    theme?: PartialDeep<Theme<SelectTheme>> | undefined;
+}, context?: import("@inquirer/type").Context) => Promise<Value>;
+export default _default;
+export { Separator } from '@inquirer/core';

package/dist/index.js

@@ -0,0 +1,174 @@
+import { createPrompt, useState, useKeypress, usePrefix, usePagination, useRef, useMemo, useEffect, isBackspaceKey, isEnterKey, isUpKey, isDownKey, isNumberKey, Separator, ValidationError, makeTheme, } from '@inquirer/core';
+import { cursorHide } from '@inquirer/ansi';
+import { styleText } from 'node:util';
+import figures from '@inquirer/figures';
+const selectTheme = {
+    icon: { cursor: figures.pointer },
+    style: {
+        disabled: (text) => styleText('dim', `- ${text}`),
+        description: (text) => styleText('cyan', text),
+        keysHelpTip: (keys) => keys
+            .map(([key, action]) => `${styleText('bold', key)} ${styleText('dim', action)}`)
+            .join(styleText('dim', ' • ')),
+    },
+    indexMode: 'hidden',
+    keybindings: [],
+};
+function isSelectable(item) {
+    return !Separator.isSeparator(item) && !item.disabled;
+}
+function normalizeChoices(choices) {
+    return choices.map((choice) => {
+        if (Separator.isSeparator(choice))
+            return choice;
+        if (typeof choice === 'string') {
+            return {
+                value: choice,
+                name: choice,
+                short: choice,
+                disabled: false,
+            };
+        }
+        const name = choice.name ?? String(choice.value);
+        const normalizedChoice = {
+            value: choice.value,
+            name,
+            short: choice.short ?? name,
+            disabled: choice.disabled ?? false,
+        };
+        if (choice.description) {
+            normalizedChoice.description = choice.description;
+        }
+        return normalizedChoice;
+    });
+}
+export default createPrompt((config, done) => {
+    const { loop = true, pageSize = 7 } = config;
+    const theme = makeTheme(selectTheme, config.theme);
+    const { keybindings } = theme;
+    const [status, setStatus] = useState('idle');
+    const prefix = usePrefix({ status, theme });
+    const searchTimeoutRef = useRef();
+    // Vim keybindings (j/k) conflict with typing those letters in search,
+    // so search must be disabled when vim bindings are enabled
+    const searchEnabled = !keybindings.includes('vim');
+    const items = useMemo(() => normalizeChoices(config.choices), [config.choices]);
+    const bounds = useMemo(() => {
+        const first = items.findIndex(isSelectable);
+        const last = items.findLastIndex(isSelectable);
+        if (first === -1) {
+            throw new ValidationError('[select prompt] No selectable choices. All choices are disabled.');
+        }
+        return { first, last };
+    }, [items]);
+    const defaultItemIndex = useMemo(() => {
+        if (!('default' in config))
+            return -1;
+        return items.findIndex((item) => isSelectable(item) && item.value === config.default);
+    }, [config.default, items]);
+    const [active, setActive] = useState(defaultItemIndex === -1 ? bounds.first : defaultItemIndex);
+    // Safe to assume the cursor position always point to a Choice.
+    const selectedChoice = items[active];
+    useKeypress((key, rl) => {
+        clearTimeout(searchTimeoutRef.current);
+        if (isEnterKey(key)) {
+            setStatus('done');
+            done(selectedChoice.value);
+        }
+        else if (isUpKey(key, keybindings) || isDownKey(key, keybindings)) {
+            rl.clearLine(0);
+            if (loop ||
+                (isUpKey(key, keybindings) && active !== bounds.first) ||
+                (isDownKey(key, keybindings) && active !== bounds.last)) {
+                const offset = isUpKey(key, keybindings) ? -1 : 1;
+                let next = active;
+                do {
+                    next = (next + offset + items.length) % items.length;
+                } while (!isSelectable(items[next]));
+                setActive(next);
+            }
+        }
+        else if (isNumberKey(key) && !Number.isNaN(Number(rl.line))) {
+            const selectedIndex = Number(rl.line) - 1;
+            // Find the nth item (ignoring separators)
+            let selectableIndex = -1;
+            const position = items.findIndex((item) => {
+                if (Separator.isSeparator(item))
+                    return false;
+                selectableIndex++;
+                return selectableIndex === selectedIndex;
+            });
+            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);
+        }
+        else if (searchEnabled) {
+            const searchTerm = rl.line.toLowerCase();
+            const matchIndex = items.findIndex((item) => {
+                if (Separator.isSeparator(item) || !isSelectable(item))
+                    return false;
+                return item.name.toLowerCase().startsWith(searchTerm);
+            });
+            if (matchIndex !== -1) {
+                setActive(matchIndex);
+            }
+            searchTimeoutRef.current = setTimeout(() => {
+                rl.clearLine(0);
+            }, 700);
+        }
+    });
+    useEffect(() => () => {
+        clearTimeout(searchTimeoutRef.current);
+    }, []);
+    const message = theme.style.message(config.message, status);
+    const helpLine = theme.style.keysHelpTip([
+        ['↑↓', 'navigate'],
+        ['⏎', 'select'],
+    ]);
+    let separatorCount = 0;
+    const page = usePagination({
+        items,
+        active,
+        renderItem({ item, isActive, index }) {
+            if (Separator.isSeparator(item)) {
+                separatorCount++;
+                return ` ${item.separator}`;
+            }
+            const indexLabel = theme.indexMode === 'number' ? `${index + 1 - separatorCount}. ` : '';
+            if (item.disabled) {
+                const disabledLabel = typeof item.disabled === 'string' ? item.disabled : '(disabled)';
+                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} ${indexLabel}${item.name}`);
+        },
+        pageSize,
+        loop,
+    });
+    if (status === 'done') {
+        return [prefix, message, theme.style.answer(selectedChoice.short)]
+            .filter(Boolean)
+            .join(' ');
+    }
+    const { description } = selectedChoice;
+    const lines = [
+        [prefix, message].filter(Boolean).join(' '),
+        page,
+        ' ',
+        description ? theme.style.description(description) : '',
+        helpLine,
+    ]
+        .filter(Boolean)
+        .join('\n')
+        .trimEnd();
+    return `${lines}${cursorHide}`;
+});
+export { Separator } from '@inquirer/core';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/select",
-  "version": "4.4.1",
+  "version": "5.0.0",
   "description": "Inquirer select/list prompt",
   "keywords": [
     "answer",
@@ -52,53 +52,36 @@
   "type": "module",
   "exports": {
     "./package.json": "./package.json",
-    ".": {
-      "import": {
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/index.d.ts",
-        "default": "./dist/commonjs/index.js"
-      }
-    }
+    ".": "./src/index.ts"
   },
-  "main": "./dist/commonjs/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/commonjs/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
-    "attw": "attw --pack",
-    "tsc": "tshy"
+    "tsc": "tsc"
   },
   "dependencies": {
-    "@inquirer/ansi": "^1.0.2",
-    "@inquirer/core": "^10.3.1",
-    "@inquirer/figures": "^1.0.15",
-    "@inquirer/type": "^3.0.10",
-    "yoctocolors-cjs": "^2.1.3"
+    "@inquirer/ansi": "^2.0.0",
+    "@inquirer/core": "^11.0.0",
+    "@inquirer/figures": "^2.0.0",
+    "@inquirer/type": "^4.0.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.18.2",
-    "@inquirer/testing": "^2.1.52",
+    "@inquirer/testing": "^3.0.0",
     "@repo/tsconfig": "0.0.0",
-    "tshy": "^3.0.3"
+    "typescript": "^5.9.3"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=23.5.0 || ^22.13.0 || ^21.7.0 || ^20.12.0"
   },
   "publishConfig": {
-    "access": "public"
-  },
-  "tshy": {
-    "exclude": [
-      "src/**/*.test.ts"
-    ],
+    "access": "public",
     "exports": {
       "./package.json": "./package.json",
-      ".": "./src/index.ts"
+      ".": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
     }
   },
   "peerDependencies": {
@@ -109,5 +92,5 @@
       "optional": true
     }
   },
-  "gitHead": "6881993e517e76fa891b72e1f5086fd11f7676ac"
+  "gitHead": "676685d33374a30340c1b9f0831c7eae2b2357dd"
 }