| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215 |
- /**
- * `list` type prompt
- */
- var _ = require("lodash");
- var util = require("util");
- var chalk = require("chalk");
- var cliCursor = require("cli-cursor");
- var figures = require("figures");
- var Base = require("./base");
- var observe = require("../utils/events");
- var utils = require("../utils/readline");
- var Paginator = require("../utils/paginator");
- /**
- * Module exports
- */
- module.exports = Prompt;
- /**
- * Constructor
- */
- function Prompt() {
- Base.apply( this, arguments );
- if (!this.opt.choices) {
- this.throwParamError("choices");
- }
- if ( _.isArray(this.opt.default) ) {
- this.opt.choices.forEach(function( choice ) {
- if ( this.opt.default.indexOf(choice.value) >= 0 ) {
- choice.checked = true;
- }
- }, this);
- }
- this.firstRender = true;
- this.pointer = 0;
- // Make sure no default is set (so it won't be printed)
- this.opt.default = null;
- this.paginator = new Paginator();
- }
- util.inherits( Prompt, Base );
- /**
- * Start the Inquiry session
- * @param {Function} cb Callback when prompt is done
- * @return {this}
- */
- Prompt.prototype._run = function( cb ) {
- this.done = cb;
- var events = observe(this.rl);
- var validation = this.handleSubmitEvents( events.line );
- validation.success.forEach( this.onEnd.bind(this) );
- validation.error.forEach( this.onError.bind(this) );
- events.normalizedUpKey.takeUntil( validation.success ).forEach( this.onUpKey.bind(this) );
- events.normalizedDownKey.takeUntil( validation.success ).forEach( this.onDownKey.bind(this) );
- events.numberKey.takeUntil( validation.success ).forEach( this.onNumberKey.bind(this) );
- events.spaceKey.takeUntil( validation.success ).forEach( this.onSpaceKey.bind(this) );
- // Init the prompt
- cliCursor.hide();
- this.render();
- return this;
- };
- /**
- * Render the prompt to screen
- * @return {Prompt} self
- */
- Prompt.prototype.render = function (error) {
- // Render question
- var cursor = 0;
- var message = this.getQuestion();
- if ( this.firstRender ) {
- message += "(Press <space> to select)";
- }
- // Render choices or answer depending on the state
- if ( this.status === "answered" ) {
- message += chalk.cyan( this.selection.join(", ") );
- } else {
- var choicesStr = renderChoices(this.opt.choices, this.pointer);
- message += "\n" + this.paginator.paginate(choicesStr, this.pointer);
- }
- if (error) {
- message += '\n' + chalk.red('>> ') + error;
- cursor++;
- }
- this.firstRender = false;
- this.screen.render(message, { cursor: cursor });
- };
- /**
- * When user press `enter` key
- */
- Prompt.prototype.onEnd = function( state ) {
- this.status = "answered";
- // Rerender prompt (and clean subline error)
- this.render();
- this.screen.done();
- cliCursor.show();
- this.done( state.value );
- };
- Prompt.prototype.onError = function ( state ) {
- this.render(state.isValid);
- };
- Prompt.prototype.getCurrentValue = function () {
- var choices = this.opt.choices.filter(function( choice ) {
- return !!choice.checked && !choice.disabled;
- });
- this.selection = _.pluck(choices, "name");
- return _.pluck(choices, "value");
- };
- Prompt.prototype.onUpKey = function() {
- var len = this.opt.choices.realLength;
- this.pointer = (this.pointer > 0) ? this.pointer - 1 : len - 1;
- this.render();
- };
- Prompt.prototype.onDownKey = function() {
- var len = this.opt.choices.realLength;
- this.pointer = (this.pointer < len - 1) ? this.pointer + 1 : 0;
- this.render();
- };
- Prompt.prototype.onNumberKey = function( input ) {
- if ( input <= this.opt.choices.realLength ) {
- this.pointer = input - 1;
- this.toggleChoice( this.pointer );
- }
- this.render();
- };
- Prompt.prototype.onSpaceKey = function( input ) {
- this.toggleChoice(this.pointer);
- this.render();
- };
- Prompt.prototype.toggleChoice = function( index ) {
- var checked = this.opt.choices.getChoice(index).checked;
- this.opt.choices.getChoice(index).checked = !checked;
- };
- /**
- * Function for rendering checkbox choices
- * @param {Number} pointer Position of the pointer
- * @return {String} Rendered content
- */
- function renderChoices(choices, pointer) {
- var output = '';
- var separatorOffset = 0;
- choices.forEach(function (choice, i) {
- if (choice.type === 'separator') {
- separatorOffset++;
- output += ' ' + choice + '\n';
- return;
- }
- if (choice.disabled) {
- separatorOffset++;
- output += ' - ' + choice.name;
- output += ' (' + (_.isString(choice.disabled) ? choice.disabled : 'Disabled') + ')';
- } else {
- var isSelected = (i - separatorOffset === pointer);
- output += isSelected ? chalk.cyan(figures.pointer) : ' ';
- output += getCheckbox(choice.checked) + ' ' + choice.name;
- }
- output += '\n';
- });
- return output.replace(/\n$/, '');
- }
- /**
- * Get the checkbox
- * @param {Boolean} checked - add a X or not to the checkbox
- * @return {String} Composited checkbox string
- */
- function getCheckbox(checked) {
- return checked ? chalk.green(figures.radioOn) : figures.radioOff;
- }
|