Add description option to choices (#905)

* Add long option to choices

Adds a `long` option to a choice in a select prompt. If the option is set, the text in `long` for the currently selected option is shown as help at the bottom of the list window.

* Rename long to description

* revert README change

Co-authored-by: Simon Boudrias <[email protected]>

Author: spalladino

README.md

@@ -128,7 +128,7 @@ A question object is a `hash` containing question related values:
 - **message**: (String|Function) The question to print. If defined as a function, the first parameter will be the current inquirer session answers. Defaults to the value of `name` (followed by a colon).
 - **default**: (String|Number|Boolean|Array|Function) Default value(s) to use if nothing is entered, or a function that returns the default value(s). If defined as a function, the first parameter will be the current inquirer session answers.
 - **choices**: (Array|Function) Choices array or a function returning a choices array. If defined as a function, the first parameter will be the current inquirer session answers.
-  Array values can be simple `numbers`, `strings`, or `objects` containing a `name` (to display in list), a `value` (to save in the answers hash) and a `short` (to display after selection) properties. The choices array can also contain [a `Separator`](#separator).
+  Array values can be simple `numbers`, `strings`, or `objects` containing a `name` (to display in list), a `value` (to save in the answers hash), and a `short` (to display after selection) properties. The choices array can also contain [a `Separator`](#separator).
 - **validate**: (Function) Receive the user input and answers hash. Should return `true` if the value is valid, and an error message (`String`) otherwise. If `false` is returned, a default error message is provided.
 - **filter**: (Function) Receive the user input and answers hash. Returns the filtered value to be used inside the program. The value returned will be added to the _Answers_ hash.
 - **transformer**: (Function) Receive the user input, answers hash and option flags, and return a transformed value to display to the user. The transformation only impacts what is shown while editing. It does not modify the answers hash.

packages/select/demo.js

@@ -6,8 +6,12 @@ const select = require('.');
   answer = await select({
     message: 'Select a package manager',
     choices: [
-      { name: 'npm', value: 'npm' },
-      { name: 'yarn', value: 'yarn' },
+      {
+        name: 'npm',
+        value: 'npm',
+        description: 'npm is the most popular package manager'
+      },
+      { name: 'yarn', value: 'yarn', description: 'yarn is an awesome package manager' },
       { name: 'jspm', value: 'jspm', disabled: true }
     ]
   });
@@ -30,7 +34,7 @@ const select = require('.');
       { value: 'L' },
       { value: 'M' },
       { value: 'N' },
-      { value: 'O' },
+      { value: 'O', description: 'Letter O, not number 0' },
       { value: 'P' },
       { value: 'Q' },
       { value: 'R' },

packages/select/index.js

@@ -65,5 +65,8 @@ module.exports = createPrompt((config, done) => {
     .join('\n');
   const windowedChoices = paginator.paginate(allChoices, cursorPosition, pageSize);
 
-  return `${prefix} ${message}\n${windowedChoices}${cursorHide}`;
+  const choice = choices[cursorPosition];
+  const choiceDescription = choice && choice.description ? `\n${choice.description}` : ``;
+
+  return `${prefix} ${message}\n${windowedChoices}${choiceDescription}${cursorHide}`;
 });