rdme
Version:
ReadMe's official CLI and GitHub Action.
47 lines (46 loc) • 1.81 kB
JavaScript
import prompts from 'prompts';
import isCI from './isCI.js';
/**
* The `prompts` library doesn't always interpret CTRL+C and release the terminal back to the user
* so we need handle this ourselves. This function is just a simple overload of the main `prompts`
* import that we use.
*
* @see {@link https://github.com/terkelg/prompts/issues/252}
*/
export default async function promptTerminal(questions, options) {
/**
* Runs a check before every prompt renders to make sure that
* prompt is not being run in a CI environment.
*/
function onRender() {
if (isCI()) {
process.stdout.write('\n');
process.stdout.write('Yikes! Looks like we were about to prompt you for something in a CI environment. Are you missing an argument?');
process.stdout.write('\n\n');
process.stdout.write('Try running `rdme <command> --help` or get in touch at support@readme.io.');
process.stdout.write('\n\n');
process.exit(1);
}
}
if (Array.isArray(questions)) {
// oxlint-disable-next-line no-param-reassign -- This is safe to rewrite our incoming questions for `prompts`.
questions = questions.map(question => ({ onRender, ...question }));
}
else {
// oxlint-disable-next-line no-param-reassign
questions.onRender = onRender;
}
return prompts(questions, {
/**
* The CTRL+C handler discussed above.
* @see {@link https://github.com/terkelg/prompts#optionsoncancel}
*/
onCancel: () => {
process.stdout.write('\n');
process.stdout.write('Thanks for using rdme! See you soon ✌️');
process.stdout.write('\n\n');
process.exit(1);
},
...options,
});
}