You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
187 lines
7.1 KiB
JavaScript
187 lines
7.1 KiB
JavaScript
3 weeks ago
|
import { createPrompt, useState, useKeypress, usePrefix, usePagination, useRef, useEffect, useMemo, isEnterKey, Separator, makeTheme, } from '@inquirer/core';
|
||
|
import colors from 'yoctocolors-cjs';
|
||
|
import figures from '@inquirer/figures';
|
||
|
const searchTheme = {
|
||
|
icon: { cursor: figures.pointer },
|
||
|
style: {
|
||
|
disabled: (text) => colors.dim(`- ${text}`),
|
||
|
searchTerm: (text) => colors.cyan(text),
|
||
|
description: (text) => colors.cyan(text),
|
||
|
},
|
||
|
helpMode: 'auto',
|
||
|
};
|
||
|
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 { pageSize = 7, validate = () => true } = config;
|
||
|
const theme = makeTheme(searchTheme, config.theme);
|
||
|
const firstRender = useRef(true);
|
||
|
const [status, setStatus] = useState('loading');
|
||
|
const [searchTerm, setSearchTerm] = useState('');
|
||
|
const [searchResults, setSearchResults] = useState([]);
|
||
|
const [searchError, setSearchError] = useState();
|
||
|
const prefix = usePrefix({ status, theme });
|
||
|
const bounds = useMemo(() => {
|
||
|
const first = searchResults.findIndex(isSelectable);
|
||
|
const last = searchResults.findLastIndex(isSelectable);
|
||
|
return { first, last };
|
||
|
}, [searchResults]);
|
||
|
const [active = bounds.first, setActive] = useState();
|
||
|
useEffect(() => {
|
||
|
const controller = new AbortController();
|
||
|
setStatus('loading');
|
||
|
setSearchError(undefined);
|
||
|
const fetchResults = async () => {
|
||
|
try {
|
||
|
const results = await config.source(searchTerm || undefined, {
|
||
|
signal: controller.signal,
|
||
|
});
|
||
|
if (!controller.signal.aborted) {
|
||
|
// Reset the pointer
|
||
|
setActive(undefined);
|
||
|
setSearchError(undefined);
|
||
|
setSearchResults(normalizeChoices(results));
|
||
|
setStatus('idle');
|
||
|
}
|
||
|
}
|
||
|
catch (error) {
|
||
|
if (!controller.signal.aborted && error instanceof Error) {
|
||
|
setSearchError(error.message);
|
||
|
}
|
||
|
}
|
||
|
};
|
||
|
void fetchResults();
|
||
|
return () => {
|
||
|
controller.abort();
|
||
|
};
|
||
|
}, [searchTerm]);
|
||
|
// Safe to assume the cursor position never points to a Separator.
|
||
|
const selectedChoice = searchResults[active];
|
||
|
useKeypress(async (key, rl) => {
|
||
|
if (isEnterKey(key)) {
|
||
|
if (selectedChoice) {
|
||
|
setStatus('loading');
|
||
|
const isValid = await validate(selectedChoice.value);
|
||
|
setStatus('idle');
|
||
|
if (isValid === true) {
|
||
|
setStatus('done');
|
||
|
done(selectedChoice.value);
|
||
|
}
|
||
|
else if (selectedChoice.name === searchTerm) {
|
||
|
setSearchError(isValid || 'You must provide a valid value');
|
||
|
}
|
||
|
else {
|
||
|
// Reset line with new search term
|
||
|
rl.write(selectedChoice.name);
|
||
|
setSearchTerm(selectedChoice.name);
|
||
|
}
|
||
|
}
|
||
|
else {
|
||
|
// Reset the readline line value to the previous value. On line event, the value
|
||
|
// get cleared, forcing the user to re-enter the value instead of fixing it.
|
||
|
rl.write(searchTerm);
|
||
|
}
|
||
|
}
|
||
|
else if (key.name === 'tab' && selectedChoice) {
|
||
|
rl.clearLine(0); // Remove the tab character.
|
||
|
rl.write(selectedChoice.name);
|
||
|
setSearchTerm(selectedChoice.name);
|
||
|
}
|
||
|
else if (status !== 'loading' && (key.name === 'up' || key.name === 'down')) {
|
||
|
rl.clearLine(0);
|
||
|
if ((key.name === 'up' && active !== bounds.first) ||
|
||
|
(key.name === 'down' && active !== bounds.last)) {
|
||
|
const offset = key.name === 'up' ? -1 : 1;
|
||
|
let next = active;
|
||
|
do {
|
||
|
next = (next + offset + searchResults.length) % searchResults.length;
|
||
|
} while (!isSelectable(searchResults[next]));
|
||
|
setActive(next);
|
||
|
}
|
||
|
}
|
||
|
else {
|
||
|
setSearchTerm(rl.line);
|
||
|
}
|
||
|
});
|
||
|
const message = theme.style.message(config.message, status);
|
||
|
if (active > 0) {
|
||
|
firstRender.current = false;
|
||
|
}
|
||
|
let helpTip = '';
|
||
|
if (searchResults.length > 1 &&
|
||
|
(theme.helpMode === 'always' || (theme.helpMode === 'auto' && firstRender.current))) {
|
||
|
helpTip =
|
||
|
searchResults.length > pageSize
|
||
|
? `\n${theme.style.help(`(${config.instructions?.pager ?? 'Use arrow keys to reveal more choices'})`)}`
|
||
|
: `\n${theme.style.help(`(${config.instructions?.navigation ?? 'Use arrow keys'})`)}`;
|
||
|
}
|
||
|
// TODO: What to do if no results are found? Should we display a message?
|
||
|
const page = usePagination({
|
||
|
items: searchResults,
|
||
|
active,
|
||
|
renderItem({ item, isActive }) {
|
||
|
if (Separator.isSeparator(item)) {
|
||
|
return ` ${item.separator}`;
|
||
|
}
|
||
|
if (item.disabled) {
|
||
|
const disabledLabel = typeof item.disabled === 'string' ? item.disabled : '(disabled)';
|
||
|
return theme.style.disabled(`${item.name} ${disabledLabel}`);
|
||
|
}
|
||
|
const color = isActive ? theme.style.highlight : (x) => x;
|
||
|
const cursor = isActive ? theme.icon.cursor : ` `;
|
||
|
return color(`${cursor} ${item.name}`);
|
||
|
},
|
||
|
pageSize,
|
||
|
loop: false,
|
||
|
});
|
||
|
let error;
|
||
|
if (searchError) {
|
||
|
error = theme.style.error(searchError);
|
||
|
}
|
||
|
else if (searchResults.length === 0 && searchTerm !== '' && status === 'idle') {
|
||
|
error = theme.style.error('No results found');
|
||
|
}
|
||
|
let searchStr;
|
||
|
if (status === 'done' && selectedChoice) {
|
||
|
const answer = selectedChoice.short;
|
||
|
return `${prefix} ${message} ${theme.style.answer(answer)}`;
|
||
|
}
|
||
|
else {
|
||
|
searchStr = theme.style.searchTerm(searchTerm);
|
||
|
}
|
||
|
const choiceDescription = selectedChoice?.description
|
||
|
? `\n${theme.style.description(selectedChoice.description)}`
|
||
|
: ``;
|
||
|
return [
|
||
|
[prefix, message, searchStr].filter(Boolean).join(' '),
|
||
|
`${error ?? page}${helpTip}${choiceDescription}`,
|
||
|
];
|
||
|
});
|
||
|
export { Separator } from '@inquirer/core';
|