build

node_modules/prompts/lib/elements/multiselect.js

@@ -3,7 +3,7 @@
 const color = require('kleur');
 const { cursor } = require('sisteransi');
 const Prompt = require('./prompt');
-const { clear, figures, style } = require('../util');
+const { clear, figures, style, wrap, entriesToDisplay } = require('../util');
 
 /**
  * MultiselectPrompt Base Element
@@ -14,6 +14,7 @@ const { clear, figures, style } = require('../util');
  * @param {String} [opts.warn] Hint shown for disabled choices
  * @param {Number} [opts.max] Max choices
  * @param {Number} [opts.cursor=0] Cursor start position
+ * @param {Number} [opts.optionsPerPage=10] Max options to display at once
  * @param {Stream} [opts.stdin] The Readable stream to listen to
  * @param {Stream} [opts.stdout] The Writable stream to write readline data to
  */
@@ -28,12 +29,15 @@ class MultiselectPrompt extends Prompt {
     this.minSelected = opts.min;
     this.showMinError = false;
     this.maxChoices = opts.max;
-    this.value = opts.choices.map((ch, idx) => {
+    this.instructions = opts.instructions;
+    this.optionsPerPage = opts.optionsPerPage || 10;
+    this.value = opts.choices.map((ch, idx) => {
       if (typeof ch === 'string')
         ch = {title: ch, value: idx};
       return {
         title: ch && (ch.title || ch.value || ch),
-        value: ch && (ch.value || idx),
+        description: ch && ch.description,
+        value: ch && (ch.value === undefined ? idx : ch.value),
         selected: ch && ch.selected,
         disabled: ch && ch.disabled
       };
@@ -136,54 +140,81 @@ class MultiselectPrompt extends Prompt {
     }
   }
 
+  toggleAll() {
+    if (this.maxChoices !== undefined || this.value[this.cursor].disabled) {
+      return this.bell();
+    }
+
+    const newSelected = !this.value[this.cursor].selected;
+    this.value.filter(v => !v.disabled).forEach(v => v.selected = newSelected);
+    this.render();
+  }
+
   _(c, key) {
     if (c === ' ') {
       this.handleSpaceToggle();
+    } else if (c === 'a') {
+      this.toggleAll();
     } else {
       return this.bell();
-    } 
+    }
   }
 
   renderInstructions() {
-    return `
-Instructions:
-    ${figures.arrowUp}/${figures.arrowDown}: Highlight option
-    ${figures.arrowLeft}/${figures.arrowRight}/[space]: Toggle selection
-    enter/return: Complete answer
-    `
+    if (this.instructions === undefined || this.instructions) {
+      if (typeof this.instructions === 'string') {
+        return this.instructions;
+      }
+      return '\nInstructions:\n'
+        + `    ${figures.arrowUp}/${figures.arrowDown}: Highlight option\n`
+        + `    ${figures.arrowLeft}/${figures.arrowRight}/[space]: Toggle selection\n`
+        + (this.maxChoices === undefined ? `    a: Toggle all\n` : '')
+        + `    enter/return: Complete answer`;
+    }
+    return '';
   }
 
-  renderOption(cursor, v, i) {
-    let title;
-    if (v.disabled) title = cursor === i ? color.gray().underline(v.title) : color.strikethrough().gray(v.title);
-    else title = cursor === i ? color.cyan().underline(v.title) : v.title;
-    return (v.selected ? color.green(figures.radioOn) : figures.radioOff) + '  ' + title
+  renderOption(cursor, v, i, arrowIndicator) {
+    const prefix = (v.selected ? color.green(figures.radioOn) : figures.radioOff) + ' ' + arrowIndicator + ' ';
+    let title, desc;
+
+    if (v.disabled) {
+      title = cursor === i ? color.gray().underline(v.title) : color.strikethrough().gray(v.title);
+    } else {
+      title = cursor === i ? color.cyan().underline(v.title) : v.title;
+      if (cursor === i && v.description) {
+        desc = ` - ${v.description}`;
+        if (prefix.length + title.length + desc.length >= this.out.columns
+          || v.description.split(/\r?\n/).length > 1) {
+          desc = '\n' + wrap(v.description, { margin: prefix.length, width: this.out.columns });
+        }
+      }
+    }
+
+    return prefix + title + color.gray(desc || '');
   }
 
   // shared with autocompleteMultiselect
   paginateOptions(options) {
-    const c = this.cursor;
-    let styledOptions = options.map((v, i) => this.renderOption(c, v, i));
-    const numOfOptionsToRender = 10; // if needed, can add an option to change this.
-
-    let scopedOptions = styledOptions;
-    let hint = '';
-    if (styledOptions.length === 0) {
+    if (options.length === 0) {
       return color.red('No matches for this query.');
-    } else if (styledOptions.length > numOfOptionsToRender) {
-      let startIndex = c - (numOfOptionsToRender / 2);
-      let endIndex = c + (numOfOptionsToRender / 2);
-      if (startIndex < 0) {
-        startIndex = 0;
-        endIndex = numOfOptionsToRender;
-      } else if (endIndex > options.length) {
-        endIndex = options.length;
-        startIndex = endIndex - numOfOptionsToRender;
-      }
-      scopedOptions = styledOptions.slice(startIndex, endIndex);
-      hint = color.dim('(Move up and down to reveal more choices)');
     }
-    return '\n' + scopedOptions.join('\n') + '\n' + hint;
+
+    let { startIndex, endIndex } = entriesToDisplay(this.cursor, options.length, this.optionsPerPage);
+    let prefix, styledOptions = [];
+
+    for (let i = startIndex; i < endIndex; i++) {
+      if (i === startIndex && startIndex > 0) {
+        prefix = figures.arrowUp;
+      } else if (i === endIndex - 1 && endIndex < options.length) {
+        prefix = figures.arrowDown;
+      } else {
+        prefix = ' ';
+      }
+      styledOptions.push(this.renderOption(this.cursor, options[i], i, prefix));
+    }
+
+    return '\n' + styledOptions.join('\n');
   }
 
   // shared with autocomleteMultiselect
@@ -196,13 +227,12 @@ Instructions:
 
   renderDoneOrInstructions() {
     if (this.done) {
-      const selected = this.value
+      return this.value
         .filter(e => e.selected)
         .map(v => v.title)
         .join(', ');
-      return selected;
     }
-    
+
     const output = [color.gray(this.hint), this.renderInstructions()];
 
     if (this.value[this.cursor].disabled) {
@@ -217,7 +247,6 @@ Instructions:
     super.render();
 
     // print prompt
-    
     let prompt = [
       style.symbol(this.done, this.aborted),
       color.bold(this.msg),