wishthis/node_modules/inquirer/lib/prompts/rawlist.js

229 lines
5.2 KiB
JavaScript
Raw Normal View History

2022-01-21 08:28:41 +00:00
'use strict';
/**
* `rawlist` type prompt
*/
2022-06-08 10:36:39 +00:00
const chalk = require('chalk');
const { map, takeUntil } = require('rxjs/operators');
const Base = require('./base');
const Separator = require('../objects/separator');
const observe = require('../utils/events');
const Paginator = require('../utils/paginator');
const incrementListIndex = require('../utils/incrementListIndex');
2022-01-21 08:28:41 +00:00
class RawListPrompt extends Base {
constructor(questions, rl, answers) {
super(questions, rl, answers);
2022-06-08 10:36:39 +00:00
this.hiddenLine = '';
this.lastKey = '';
2022-01-21 08:28:41 +00:00
if (!this.opt.choices) {
this.throwParamError('choices');
}
this.opt.validChoices = this.opt.choices.filter(Separator.exclude);
this.selected = 0;
this.rawDefault = 0;
2022-06-08 10:36:39 +00:00
Object.assign(this.opt, {
validate(val) {
2022-01-21 08:28:41 +00:00
return val != null;
2022-06-08 10:36:39 +00:00
},
2022-01-21 08:28:41 +00:00
});
2022-06-08 10:36:39 +00:00
const def = this.opt.default;
if (typeof def === 'number' && def >= 0 && def < this.opt.choices.realLength) {
2022-01-21 08:28:41 +00:00
this.selected = def;
this.rawDefault = def;
2022-06-08 10:36:39 +00:00
} else if (typeof def !== 'number' && def != null) {
const index = this.opt.choices.realChoices.findIndex(({ value }) => value === def);
const safeIndex = Math.max(index, 0);
2022-01-21 08:28:41 +00:00
this.selected = safeIndex;
this.rawDefault = safeIndex;
}
// Make sure no default is set (so it won't be printed)
this.opt.default = null;
2022-06-08 10:36:39 +00:00
const shouldLoop = this.opt.loop === undefined ? true : this.opt.loop;
this.paginator = new Paginator(undefined, { isInfinite: shouldLoop });
2022-01-21 08:28:41 +00:00
}
/**
* Start the Inquiry session
* @param {Function} cb Callback when prompt is done
* @return {this}
*/
_run(cb) {
this.done = cb;
// Once user confirm (enter key)
2022-06-08 10:36:39 +00:00
const events = observe(this.rl);
const submit = events.line.pipe(map(this.getCurrentValue.bind(this)));
2022-01-21 08:28:41 +00:00
2022-06-08 10:36:39 +00:00
const validation = this.handleSubmitEvents(submit);
2022-01-21 08:28:41 +00:00
validation.success.forEach(this.onEnd.bind(this));
validation.error.forEach(this.onError.bind(this));
2022-06-08 10:36:39 +00:00
events.normalizedUpKey
2022-04-07 07:06:43 +00:00
.pipe(takeUntil(validation.success))
2022-06-08 10:36:39 +00:00
.forEach(this.onUpKey.bind(this));
2022-05-29 09:24:36 +00:00
events.normalizedDownKey
2022-06-08 10:36:39 +00:00
.pipe(takeUntil(validation.success))
2022-05-29 09:24:36 +00:00
.forEach(this.onDownKey.bind(this));
2022-06-08 10:36:39 +00:00
events.keypress
.pipe(takeUntil(validation.success))
.forEach(this.onKeypress.bind(this));
2022-01-21 08:28:41 +00:00
// Init the prompt
this.render();
return this;
}
/**
* Render the prompt to screen
* @return {RawListPrompt} self
*/
render(error) {
// Render question
2022-06-08 10:36:39 +00:00
let message = this.getQuestion();
let bottomContent = '';
2022-01-21 08:28:41 +00:00
if (this.status === 'answered') {
2022-06-08 10:36:39 +00:00
message += chalk.cyan(this.opt.choices.getChoice(this.selected).short);
2022-01-21 08:28:41 +00:00
} else {
2022-06-08 10:36:39 +00:00
const choicesStr = renderChoices(this.opt.choices, this.selected);
2022-01-21 08:28:41 +00:00
message +=
'\n' + this.paginator.paginate(choicesStr, this.selected, this.opt.pageSize);
message += '\n Answer: ';
}
message += this.rl.line;
if (error) {
bottomContent = '\n' + chalk.red('>> ') + error;
}
this.screen.render(message, bottomContent);
}
/**
* When user press `enter` key
*/
getCurrentValue(index) {
2022-06-08 10:36:39 +00:00
if (index == null) {
2022-01-21 08:28:41 +00:00
index = this.rawDefault;
2022-06-08 10:36:39 +00:00
} else if (index === '') {
this.selected = this.selected === undefined ? -1 : this.selected;
index = this.selected;
2022-01-21 08:28:41 +00:00
} else {
index -= 1;
}
2022-06-08 10:36:39 +00:00
const choice = this.opt.choices.getChoice(index);
2022-01-21 08:28:41 +00:00
return choice ? choice.value : null;
}
onEnd(state) {
this.status = 'answered';
this.answer = state.value;
// Re-render prompt
this.render();
this.screen.done();
this.done(state.value);
}
onError() {
this.render('Please enter a valid index');
}
/**
* When user press a key
*/
onKeypress() {
2022-06-08 10:36:39 +00:00
let index;
if (this.lastKey === 'arrow') {
index = this.hiddenLine.length ? Number(this.hiddenLine) - 1 : 0;
} else {
index = this.rl.line.length ? Number(this.rl.line) - 1 : 0;
}
this.lastKey = '';
2022-01-21 08:28:41 +00:00
if (this.opt.choices.getChoice(index)) {
this.selected = index;
} else {
this.selected = undefined;
}
this.render();
}
/**
* When user press up key
*/
onUpKey() {
this.onArrowKey('up');
}
/**
* When user press down key
*/
onDownKey() {
this.onArrowKey('down');
}
/**
* When user press up or down key
* @param {String} type Arrow type: up or down
*/
onArrowKey(type) {
2022-06-08 10:36:39 +00:00
this.selected = incrementListIndex(this.selected, type, this.opt) || 0;
this.hiddenLine = String(this.selected + 1);
this.rl.line = '';
this.lastKey = 'arrow';
2022-01-21 08:28:41 +00:00
}
}
/**
* Function for rendering list choices
* @param {Number} pointer Position of the pointer
* @return {String} Rendered content
*/
function renderChoices(choices, pointer) {
2022-06-08 10:36:39 +00:00
let output = '';
let separatorOffset = 0;
2022-01-21 08:28:41 +00:00
2022-06-08 10:36:39 +00:00
choices.forEach((choice, i) => {
output += output ? '\n ' : ' ';
2022-01-21 08:28:41 +00:00
if (choice.type === 'separator') {
separatorOffset++;
output += ' ' + choice;
return;
}
2022-06-08 10:36:39 +00:00
const index = i - separatorOffset;
let display = index + 1 + ') ' + choice.name;
2022-01-21 08:28:41 +00:00
if (index === pointer) {
display = chalk.cyan(display);
}
output += display;
});
return output;
}
module.exports = RawListPrompt;