You're Invited:Meet the Socket Team at RSAC and BSidesSF 2026, March 23–26.RSVP →
Socket
Book a DemoSign in
Socket
Book a DemoSign in

@inquirer/select

Package Overview
Dependencies
Maintainers
2
Versions
119
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@inquirer/select - npm Package Compare versions

Comparing version
5.0.0
 to
5.0.1
+12
-17
package.json
{
"name": "@inquirer/select",
"version": "5.0.0",
"version": "5.0.1",
"description": "Inquirer select/list prompt",

@@ -55,3 +55,6 @@ "keywords": [

"./package.json": "./package.json",
".": "./src/index.ts"
".": {
"types": "./dist/index.d.ts",
"default": "./dist/index.js"
}
},

@@ -65,10 +68,9 @@ "files": [

"dependencies": {
"@inquirer/ansi": "^2.0.0",
"@inquirer/core": "^11.0.0",
"@inquirer/figures": "^2.0.0",
"@inquirer/type": "^4.0.0"
"@inquirer/ansi": "^2.0.1",
"@inquirer/core": "^11.0.1",
"@inquirer/figures": "^2.0.1",
"@inquirer/type": "^4.0.1"
},
"devDependencies": {
"@inquirer/testing": "^3.0.0",
"@repo/tsconfig": "0.0.0",
"@inquirer/testing": "^3.0.1",
"typescript": "^5.9.3"

@@ -80,10 +82,3 @@ },

"publishConfig": {
"access": "public",
"exports": {
"./package.json": "./package.json",
".": {
"types": "./dist/index.d.ts",
"default": "./dist/index.js"
}
}
"access": "public"
},

@@ -98,3 +93,3 @@ "peerDependencies": {

},
"gitHead": "676685d33374a30340c1b9f0831c7eae2b2357dd"
"gitHead": "cce79ce3b9bbdfb4dbb798078cf3b94b9adc7d1b"
}
-40
dist/commonjs/index.d.ts
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;
};
/** @deprecated Use theme.style.keysHelpTip instead */
helpMode: 'always' | 'never' | 'auto';
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;
instructions?: {
navigation: string;
pager: string;
} | undefined;
theme?: PartialDeep<Theme<SelectTheme>> | undefined;
}, context?: import("@inquirer/type").Context) => Promise<Value> & {
cancel: () => void;
};
export default _default;
export { Separator } from '@inquirer/core';
-194
dist/commonjs/index.js
"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Separator = void 0;
const core_1 = require("@inquirer/core");
const ansi_1 = require("@inquirer/ansi");
const yoctocolors_cjs_1 = __importDefault(require("yoctocolors-cjs"));
const figures_1 = __importDefault(require("@inquirer/figures"));
const selectTheme = {
icon: { cursor: figures_1.default.pointer },
style: {
disabled: (text) => yoctocolors_cjs_1.default.dim(`- ${text}`),
description: (text) => yoctocolors_cjs_1.default.cyan(text),
keysHelpTip: (keys) => keys
.map(([key, action]) => `${yoctocolors_cjs_1.default.bold(key)} ${yoctocolors_cjs_1.default.dim(action)}`)
.join(yoctocolors_cjs_1.default.dim(' • ')),
},
helpMode: 'always',
indexMode: 'hidden',
keybindings: [],
};
function isSelectable(item) {
return !core_1.Separator.isSeparator(item) && !item.disabled;
}
function normalizeChoices(choices) {
return choices.map((choice) => {
if (core_1.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;
});
}
exports.default = (0, core_1.createPrompt)((config, done) => {
const { loop = true, pageSize = 7 } = config;
const theme = (0, core_1.makeTheme)(selectTheme, config.theme);
const { keybindings } = theme;
const [status, setStatus] = (0, core_1.useState)('idle');
const prefix = (0, core_1.usePrefix)({ status, theme });
const searchTimeoutRef = (0, core_1.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 = (0, core_1.useMemo)(() => normalizeChoices(config.choices), [config.choices]);
const bounds = (0, core_1.useMemo)(() => {
const first = items.findIndex(isSelectable);
const last = items.findLastIndex(isSelectable);
if (first === -1) {
throw new core_1.ValidationError('[select prompt] No selectable choices. All choices are disabled.');
}
return { first, last };
}, [items]);
const defaultItemIndex = (0, core_1.useMemo)(() => {
if (!('default' in config))
return -1;
return items.findIndex((item) => isSelectable(item) && item.value === config.default);
}, [config.default, items]);
const [active, setActive] = (0, core_1.useState)(defaultItemIndex === -1 ? bounds.first : defaultItemIndex);
// Safe to assume the cursor position always point to a Choice.
const selectedChoice = items[active];
(0, core_1.useKeypress)((key, rl) => {
clearTimeout(searchTimeoutRef.current);
if ((0, core_1.isEnterKey)(key)) {
setStatus('done');
done(selectedChoice.value);
}
else if ((0, core_1.isUpKey)(key, keybindings) || (0, core_1.isDownKey)(key, keybindings)) {
rl.clearLine(0);
if (loop ||
((0, core_1.isUpKey)(key, keybindings) && active !== bounds.first) ||
((0, core_1.isDownKey)(key, keybindings) && active !== bounds.last)) {
const offset = (0, core_1.isUpKey)(key, keybindings) ? -1 : 1;
let next = active;
do {
next = (next + offset + items.length) % items.length;
} while (!isSelectable(items[next]));
setActive(next);
}
}
else if ((0, core_1.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 (core_1.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 ((0, core_1.isBackspaceKey)(key)) {
rl.clearLine(0);
}
else if (searchEnabled) {
const searchTerm = rl.line.toLowerCase();
const matchIndex = items.findIndex((item) => {
if (core_1.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);
}
});
(0, core_1.useEffect)(() => () => {
clearTimeout(searchTimeoutRef.current);
}, []);
const message = theme.style.message(config.message, status);
let helpLine;
// eslint-disable-next-line @typescript-eslint/no-deprecated
if (theme.helpMode !== 'never') {
// eslint-disable-next-line @typescript-eslint/no-deprecated
if (config.instructions) {
// eslint-disable-next-line @typescript-eslint/no-deprecated
const { pager, navigation } = config.instructions;
helpLine = theme.style.help(items.length > pageSize ? pager : navigation);
}
else {
helpLine = theme.style.keysHelpTip([
['↑↓', 'navigate'],
['⏎', 'select'],
]);
}
}
let separatorCount = 0;
const page = (0, core_1.usePagination)({
items,
active,
renderItem({ item, isActive, index }) {
if (core_1.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}${ansi_1.cursorHide}`;
});
var core_2 = require("@inquirer/core");
Object.defineProperty(exports, "Separator", { enumerable: true, get: function () { return core_2.Separator; } });
-3
dist/commonjs/package.json
{
"type": "commonjs"
}
-40
dist/esm/index.d.ts
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;
};
/** @deprecated Use theme.style.keysHelpTip instead */
helpMode: 'always' | 'never' | 'auto';
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;
instructions?: {
navigation: string;
pager: string;
} | undefined;
theme?: PartialDeep<Theme<SelectTheme>> | undefined;
}, context?: import("@inquirer/type").Context) => Promise<Value> & {
cancel: () => void;
};
export default _default;
export { Separator } from '@inquirer/core';
-187
dist/esm/index.js
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 colors from 'yoctocolors-cjs';
import figures from '@inquirer/figures';
const selectTheme = {
icon: { cursor: figures.pointer },
style: {
disabled: (text) => colors.dim(`- ${text}`),
description: (text) => colors.cyan(text),
keysHelpTip: (keys) => keys
.map(([key, action]) => `${colors.bold(key)} ${colors.dim(action)}`)
.join(colors.dim(' • ')),
},
helpMode: 'always',
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);
let helpLine;
// eslint-disable-next-line @typescript-eslint/no-deprecated
if (theme.helpMode !== 'never') {
// eslint-disable-next-line @typescript-eslint/no-deprecated
if (config.instructions) {
// eslint-disable-next-line @typescript-eslint/no-deprecated
const { pager, navigation } = config.instructions;
helpLine = theme.style.help(items.length > pageSize ? pager : navigation);
}
else {
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';
-3
dist/esm/package.json
{
"type": "module"
}