easy-cli-framework
Version:
A framework for building CLI applications that are robust and easy to maintain. Supports theming, configuration files, interactive prompts, and more.
66 lines (62 loc) • 2.33 kB
JavaScript
;
var yargsInteractive = require('yargs-interactive');
// @ts-ignore Untyped Module
/**
* Prompts the user to select a choice from a list of choices, if the input is invalid, it will prompt the user again for a valid input
*
* @param {string} prompt The prompt to display to the user
* @param {string[]} choices The choices to display to the user
* @param {PromptChoiceOptions} options The options for the prompt
*
* @returns {Promise<string>} The choice the user selected
*
* @example
* ```typescript
* // Prompt the user to select a choice
* const choice = await promptChoice('Select a choice', ['A', 'B', 'C']);
* console.log(choice);
*
* // Prompt the user to select a choice with a default option
* const choice = await promptChoice('Select a choice', ['A', 'B', 'C'], { defaultOption: 'A' });
* console.log(choice);
*
* // Prompt the user to select a choice using a custom theme
* const choice = await promptChoice('Select a choice', ['A', 'B', 'C'], {
* theme: new EasyCLITheme(),
* promptTheme: 'info',
* });
* console.log(choice);
*
* // Prompt the user to select a choice using a custom displaying the choices with a theme
* const theme = new EasyCLITheme();
* const choice = await promptChoice('Select a choice', [
* theme.formattedString('A', 'info'),
* theme.formattedString('B', 'warn'),
* theme.formattedString('C', 'error'),
* ]);
* console.log(choice);
* ```
*
*/
const promptChoice = async (prompt, choices, { defaultOption = null, validator = () => true, validationErrorMessage = 'Invalid input', theme = null, promptTheme = 'default', } = {}) => {
var _a;
while (true) {
const { choice } = await yargsInteractive()
.usage('$0 <command> [args]')
.interactive({
interactive: { default: true },
choice: {
type: 'list',
describe: (_a = theme === null || theme === undefined ? undefined : theme.formattedString(prompt, promptTheme)) !== null && _a !== undefined ? _a : prompt,
choices,
default: defaultOption,
prompt: 'always',
},
});
if (validator(choice)) {
return choice;
}
console.log(validationErrorMessage);
}
};
exports.promptChoice = promptChoice;