import { createPrompt, useState, useKeypress, usePrefix, usePagination, useMemo, isUpKey, isDownKey, isSpaceKey, isNumberKey, isEnterKey, Separator, } from '@inquirer/core'; import chalk from 'chalk'; import figures from 'figures'; import ansiEscapes from 'ansi-escapes'; function isSelectable(item) { return !Separator.isSeparator(item) && !item.disabled; } function isChecked(item) { return isSelectable(item) && Boolean(item.checked); } function toggle(item) { return isSelectable(item) ? { ...item, checked: !item.checked } : item; } function check(checked) { return function (item) { return isSelectable(item) ? { ...item, checked } : item; }; } function renderItem({ item, isActive }) { if (Separator.isSeparator(item)) { return ` ${item.separator}`; } const line = item.name || item.value; if (item.disabled) { const disabledLabel = typeof item.disabled === 'string' ? item.disabled : '(disabled)'; return chalk.dim(`- ${line} ${disabledLabel}`); } const checkbox = item.checked ? chalk.green(figures.circleFilled) : figures.circle; const color = isActive ? chalk.cyan : (x) => x; const prefix = isActive ? figures.pointer : ' '; return color(`${prefix}${checkbox} ${line}`); } export default createPrompt((config, done) => { const { prefix = usePrefix(), instructions, pageSize = 7, loop = true, choices, required, validate = () => true, } = config; const [status, setStatus] = useState('pending'); const [items, setItems] = useState(choices.map((choice) => ({ ...choice }))); const bounds = useMemo(() => { const first = items.findIndex(isSelectable); // TODO: Replace with `findLastIndex` when it's available. const last = items.length - 1 - [...items].reverse().findIndex(isSelectable); if (first < 0) { throw new Error('[checkbox prompt] No selectable choices. All choices are disabled.'); } return { first, last }; }, [items]); const [active, setActive] = useState(bounds.first); const [showHelpTip, setShowHelpTip] = useState(true); const [errorMsg, setError] = useState(undefined); useKeypress(async (key) => { if (isEnterKey(key)) { const selection = items.filter(isChecked); const isValid = await validate([...selection]); if (required && !items.some(isChecked)) { setError('At least one choice must be selected'); } else if (isValid === true) { setStatus('done'); done(selection.map((choice) => choice.value)); } else { setError(isValid || 'You must select a valid value'); } } else if (isUpKey(key) || isDownKey(key)) { if (loop || (isUpKey(key) && active !== bounds.first) || (isDownKey(key) && active !== bounds.last)) { const offset = isUpKey(key) ? -1 : 1; let next = active; do { next = (next + offset + items.length) % items.length; } while (!isSelectable(items[next])); setActive(next); } } else if (isSpaceKey(key)) { setError(undefined); setShowHelpTip(false); setItems(items.map((choice, i) => (i === active ? toggle(choice) : choice))); } else if (key.name === 'a') { const selectAll = Boolean(items.find((choice) => isSelectable(choice) && !choice.checked)); setItems(items.map(check(selectAll))); } else if (key.name === 'i') { setItems(items.map(toggle)); } else if (isNumberKey(key)) { // Adjust index to start at 1 const position = Number(key.name) - 1; const item = items[position]; if (item != null && isSelectable(item)) { setActive(position); setItems(items.map((choice, i) => (i === position ? toggle(choice) : choice))); } } }); const message = chalk.bold(config.message); const page = usePagination({ items, active, renderItem, pageSize, loop, }); if (status === 'done') { const selection = items .filter(isChecked) .map((choice) => choice.name || choice.value); return `${prefix} ${message} ${chalk.cyan(selection.join(', '))}`; } let helpTip = ''; if (showHelpTip && (instructions === undefined || instructions)) { if (typeof instructions === 'string') { helpTip = instructions; } else { const keys = [ `${chalk.cyan.bold('')} to select`, `${chalk.cyan.bold('')} to toggle all`, `${chalk.cyan.bold('')} to invert selection`, `and ${chalk.cyan.bold('')} to proceed`, ]; helpTip = ` (Press ${keys.join(', ')})`; } } let error = ''; if (errorMsg) { error = chalk.red(`> ${errorMsg}`); } return `${prefix} ${message}${helpTip}\n${page}\n${error}${ansiEscapes.cursorHide}`; }); export { Separator };