inquirer-sortable-checkbox
Version:
Inquirer sortable checkbox prompt
206 lines (205 loc) • 8.88 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const core_1 = require("@inquirer/core");
const chalk_1 = __importDefault(require("chalk"));
const figures_1 = __importDefault(require("@inquirer/figures"));
const ansi_escapes_1 = __importDefault(require("ansi-escapes"));
const checkboxTheme = {
icon: {
checked: chalk_1.default.green(figures_1.default.circleFilled),
unchecked: figures_1.default.circle,
cursor: figures_1.default.pointer,
},
style: {
disabledChoice: (text) => chalk_1.default.dim(`- ${text}`),
renderSelectedChoices: (selectedChoices) => selectedChoices.map((choice) => choice.name || choice.value).join(', '),
},
helpMode: 'auto',
};
exports.default = (0, core_1.createPrompt)((config, done) => {
const { instructions, pageSize = 7, choices, required, validate = () => true, } = config;
const theme = (0, core_1.makeTheme)(checkboxTheme, config.theme);
const prefix = (0, core_1.usePrefix)({ theme });
const firstRender = (0, core_1.useRef)(true);
const [status, setStatus] = (0, core_1.useState)('pending');
const [items, setItems] = (0, core_1.useState)(choices.map((choice) => (Object.assign({}, choice))));
const bounds = (0, core_1.useMemo)(() => {
const first = items.findIndex(isSelectable);
const last = items.findLastIndex(isSelectable);
if (first < 0) {
throw new core_1.ValidationError('[checkbox prompt] No selectable choices. All choices are disabled.');
}
return { first, last };
}, [items]);
const [active, setActive] = (0, core_1.useState)(bounds.first);
const [showHelpTip, setShowHelpTip] = (0, core_1.useState)(true);
const [errorMsg, setError] = (0, core_1.useState)(undefined);
(0, core_1.useKeypress)((key) => __awaiter(void 0, void 0, void 0, function* () {
if ((0, core_1.isEnterKey)(key)) {
const selection = items.filter(isChecked);
const isValid = yield 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 (isActivateNextItemKey(key) || isActivatePreviousItemKey(key)) {
if ((isActivatePreviousItemKey(key) && active !== bounds.first) ||
(isActivateNextItemKey(key) && active !== bounds.last)) {
const offset = (0, core_1.isUpKey)(key) ? -1 : 1;
let next = active;
do {
next = (next + offset + items.length) % items.length;
} while (!isSelectable(items[next]));
setActive(next);
}
}
else if ((0, core_1.isSpaceKey)(key)) {
setError(undefined);
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 ((0, core_1.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)));
}
}
else if (isMoveItemUpKey(key) || isMoveItemDownKey(key)) {
setShowHelpTip(false);
if (items.length < 2) {
return;
}
const offset = isMoveItemUpKey(key) ? -1 : 1;
let moveActiveTo = active + offset;
if (!config.sortingLoop &&
(moveActiveTo < 0 || moveActiveTo > items.length - 1)) {
return;
}
let newItems;
if (moveActiveTo === -1) {
newItems = [...items.slice(1), items[0]];
moveActiveTo = items.length - 1;
}
else if (moveActiveTo === items.length) {
newItems = [items.at(-1), ...items.slice(0, -1)];
moveActiveTo = 0;
}
else {
newItems = [...items];
newItems[moveActiveTo] = items[active];
newItems[active] = items[moveActiveTo];
}
setItems(newItems);
setActive(moveActiveTo);
}
}));
const message = theme.style.message(config.message);
const page = (0, core_1.usePagination)({
items,
active,
renderItem({ item, isActive }) {
const line = item.name || item.value;
if (item.disabled) {
const disabledLabel = typeof item.disabled === 'string' ? item.disabled : '(disabled)';
return theme.style.disabledChoice(`${line} ${disabledLabel}`);
}
const checkbox = item.checked ? theme.icon.checked : theme.icon.unchecked;
const color = isActive ? theme.style.highlight : (x) => x;
const cursor = isActive ? theme.icon.cursor : ' ';
return color(`${cursor}${checkbox} ${line}`);
},
pageSize,
loop: false,
});
if (status === 'done') {
const selection = items.filter(isChecked);
const answer = theme.style.answer(theme.style.renderSelectedChoices(selection, items));
return `${prefix} ${message} ${answer}`;
}
let helpTipTop = '';
let helpTipBottom = '';
if (theme.helpMode === 'always' ||
(theme.helpMode === 'auto' &&
showHelpTip &&
(instructions === undefined || instructions))) {
if (typeof instructions === 'string') {
helpTipTop = instructions;
}
else {
const keys = [
`${theme.style.key('space')} to select`,
`${theme.style.key('a')} to toggle all`,
`${theme.style.key('i')} to invert selection`,
`${theme.style.key('ctrl+up')} to move item up`,
`${theme.style.key('ctrl+down')} to move item down`,
`and ${theme.style.key('enter')} to proceed`,
];
helpTipTop = ` (Press ${keys.join(', ')})`;
}
if (items.length > pageSize &&
(theme.helpMode === 'always' ||
(theme.helpMode === 'auto' && firstRender.current))) {
helpTipBottom = `\n${theme.style.help('(Use arrow keys to reveal more choices)')}`;
firstRender.current = false;
}
}
let error = '';
if (errorMsg) {
error = `\n${theme.style.error(errorMsg)}`;
}
return `${prefix} ${message}${helpTipTop}\n${page}${helpTipBottom}${error}${ansi_escapes_1.default.cursorHide}`;
});
function isSelectable(item) {
return !item.disabled;
}
function isChecked(item) {
return isSelectable(item) && Boolean(item.checked);
}
function toggle(item) {
return isSelectable(item) ? Object.assign(Object.assign({}, item), { checked: !item.checked }) : item;
}
function check(checked) {
return function (item) {
return isSelectable(item) ? Object.assign(Object.assign({}, item), { checked }) : item;
};
}
function isActivatePreviousItemKey(key) {
return (0, core_1.isUpKey)(key) && !key.ctrl;
}
function isActivateNextItemKey(key) {
return (0, core_1.isDownKey)(key) && !key.ctrl;
}
function isMoveItemUpKey(key) {
return key.ctrl && (0, core_1.isUpKey)(key);
}
function isMoveItemDownKey(key) {
return key.ctrl && (0, core_1.isDownKey)(key);
}