fix(ui): return correct default value for list prompts

Author: acburdine

lib/ui/index.js

@@ -25,6 +25,19 @@ const defaultOptions = {
     auto: false
 };
 
+function hasDefault(prompt = {}) {
+    return isObject(prompt) && prompt.hasOwnProperty('default');
+}
+
+function getDefault(prompt = {}) {
+    if (prompt.choices && prompt.choices.length) {
+        const defaultChoice = prompt.choices[prompt.default];
+        return isObject(defaultChoice) ? defaultChoice.value : defaultChoice;
+    }
+
+    return prompt.default;
+}
+
 /**
  * UI class. Handles all interaction with the user via the terminal
  *
@@ -136,18 +149,22 @@ class UI {
 
         if (this.auto) {
             if (Array.isArray(prompts)) {
-                const defaultedPrompts = prompts.filter(prompt => Boolean(prompt.default)).reduce(
-                    (obj, prompt) => Object.assign({}, obj, {[prompt.name]: prompt.default}),
+                const defaultedPrompts = prompts.filter(hasDefault).reduce(
+                    (obj, prompt) => Object.assign({}, obj, {[prompt.name]: getDefault(prompt)}),
                     {}
                 );
-                const promptsToAsk = prompts.filter(prompt => !prompt.default);
+                const promptsToAsk = prompts.filter(prompt => !hasDefault(prompt));
+
+                if (!promptsToAsk.length) {
+                    return Promise.resolve(defaultedPrompts);
+                }
 
                 return this.noSpin(() => this.inquirer(promptsToAsk))
                     .then(answers => Object.assign(answers, defaultedPrompts));
             }
 
             /* istanbul ignore else */
-            if (isObject(prompts) && prompts.default) {
+            if (hasDefault(prompts)) {
                 return Promise.resolve({[prompts.name]: prompts.default});
             }
         }

test/unit/ui/index-spec.js

@@ -296,6 +296,38 @@ describe('Unit: UI', function () {
             });
         });
 
+        it('returns default if auto is true and prompt type is list/expand', function () {
+            const ui = new UI();
+            ui.auto = true;
+
+            const prompts = [{
+                type: 'rawlist',
+                name: 'a',
+                choices: ['small', 'medium', 'large'],
+                default: 2
+            }, {
+                type: 'rawlist',
+                name: 'b',
+                choices: ['small', 'medium', 'large'],
+                default: 0
+            }, {
+                type: 'expand',
+                name: 'c',
+                choices: ['small', 'medium', 'large'],
+                default: 1
+            }];
+
+            const noSpinStub = sinon.stub(ui, 'noSpin');
+            return ui.prompt(prompts).then((results) => {
+                expect(results).to.deep.equal({
+                    a: 'large',
+                    b: 'small',
+                    c: 'medium'
+                });
+                expect(noSpinStub.called).to.be.false;
+            });
+        });
+
         it('passes options to prompt method', function () {
             const ui = new UI();
             ui.allowPrompt = true;