feat: run-questionnaire

src/run-questionnaire.js

@@ -0,0 +1,169 @@
+import _ from 'lodash';
+import {select, multiselect, text} from './prompts';
+import applicable from './applicable';
+
+// Get user provided predefinedProperties, preselectedFeatures, go through all the questions,
+// Output a cleaned up features.
+//
+// _debug is used to pass in answers for prompts.
+export default async function(questions, {
+  unattended = false,
+  preselectedFeatures = [],
+  predefinedProperties = {},
+  _debug = []
+}) {
+  const pickedFeatures = [];
+  const properties = {};
+
+  async function ask(question) {
+    let {choices, name} = question;
+
+    if (!name && !choices) {
+      throw new Error(`Question needs to supply "choices" for selection, or "name" for text prompt. Invalid question:\n` +
+        JSON.stringify(question, null, 2) + '\n\n');
+    }
+
+    if (name && choices) {
+      // only text prompt needs name
+      name = null;
+    }
+
+    // Conditional question.
+    // check ./applicable.js for acceptable expression
+    if (question.if && !applicable(pickedFeatures, question.if)) {
+      return;
+    }
+
+    // text
+    if (name) {
+      properties[name] = await textPrompt(question, {unattended, predefinedProperties, _debug});
+      return;
+    }
+
+    // select or multiselect
+    selectPrompt(question, pickedFeatures, {preselectedFeatures, unattended, _debug});
+  }
+
+  for (let i = 0, ii = questions.length; i < ii; i++) {
+    await ask(questions[i]);
+  }
+
+  return [properties, pickedFeatures];
+}
+
+export async function textPrompt(question, {predefinedProperties, unattended, _debug}) {
+  const {name} = question;
+  if (!name.match(/^[a-zA-Z1-9-]+$/)) {
+    throw new Error(`Name ${JSON.stringify(name)} is invalid. Only accept letters, numbers, and dash(-).` +
+      'In question:\n' + JSON.stringify(question, null, 2) + '\n\n');
+  }
+
+  let answer;
+  if (predefinedProperties[name]) {
+    answer = predefinedProperties[name];
+  } else if (unattended) {
+    answer = question.default || '';
+  } else if (_debug && _debug.length) {
+    answer = _debug.shift();
+  } else {
+    answer = await text(question);
+  }
+  return answer;
+}
+
+export async function selectPrompt(question, pickedFeatures, {preselectedFeatures, unattended, _debug}) {
+  let {choices, multiple} = question;
+
+  choices.forEach((c, i) => {
+    if (c.value && (typeof c.value !== 'string' || !c.value.match(/^[a-zA-Z1-9-]*$/))) {
+      throw new Error(`Value ${JSON.stringify(c.value)} is invalid. Only accept letters, numbers, and dash(-).` +
+        'In question:\n' + JSON.stringify(question, null, 2) + '\n\n');
+    }
+    if (!c.value && i !== 0) {
+      throw new Error(`Only first choice can have empty value. Please reorder the question choices:\n` +
+        JSON.stringify(question, null, 2) + '\n\n');
+    }
+  });
+
+  // Conditional choices
+  // {value: 'foo', message: 'Foo', hint: 'lorem', if: 'webpack && typescript'}
+  choices = choices.filter(c => !c.if || applicable(pickedFeatures, c.if));
+
+  // not applicable at all
+  if (choices.length === 0) return;
+  // only one choice for single-select, don't have to raise the question
+  if (choices.length === 1 && !multiple) {
+    if (choices[0].value) pickedFeatures.push(choices[0].value);
+    return;
+  }
+
+  // find the last match, in order to allow user to overwrite
+  let selected;
+  let matchingIndex;
+  const multiselected = [];
+  _.each(choices, c => {
+    // skip empty value
+    if (!c.value) return;
+    const idx = preselectedFeatures.indexOf(c.value);
+    if (idx === -1) return;
+    if (multiple) {
+      multiselected.push(c.value);
+    } else {
+      if (matchingIndex === undefined || matchingIndex < idx) {
+        matchingIndex = idx;
+        selected = c.value;
+      }
+    }
+  });
+
+  if (multiple && multiselected.length) {
+    multiselected.forEach(s => s && pickedFeatures.push(s));
+    return;
+  }
+
+  if (!multiple && selected) {
+    if (selected) pickedFeatures.push(selected);
+    return;
+  }
+
+  // Pick default answer in unattended mode
+  if (unattended) {
+    if (multiple) {
+      const selected = _(choices).filter('selected').map('value').value();
+      if (selected.length) {
+        selected.forEach(s => pickedFeatures.push(s));
+      }
+    } else {
+      const first = _.trim(choices[0].value);
+      if (first) pickedFeatures.push(first);
+    }
+    return;
+  }
+
+  // choice index is 1-based.
+  if (_debug && _debug.length) {
+    let idx = _debug.shift();
+    if (idx) {
+      if (multiple) {
+        _.each(idx, i => {
+          const debugPicked = choices[i - 1].value;
+          if (debugPicked) pickedFeatures.push(debugPicked);
+        });
+      } else {
+        const debugPicked = choices[idx - 1].value;
+        if (debugPicked) pickedFeatures.push(debugPicked);
+      }
+      return;
+    }
+  }
+
+  if (multiple) {
+    const picked = await multiselect(question);
+    if (picked && picked.length) {
+      picked.forEach(p => pickedFeatures.push(p));
+    }
+  } else {
+    const picked = await select(question);
+    if (picked) pickedFeatures.push(picked);
+  }
+}

test/prompts/_prompt-under-test.js

@@ -42,4 +42,4 @@ function wrap(prompt) {
 const text = wrap(_text);
 const select = wrap(_select);
 const multiselect = wrap(_multiselect);
-export {text, select, multiselect};
+export {delay, pressKeys, text, select, multiselect};