refactor to make code easier to follow

Author: yyx990803

bin/vue-init

@@ -10,6 +10,7 @@ var ora = require('ora')
 var chalk = require('chalk')
 var inquirer = require('inquirer')
 var logger = require('../lib/logger')
+var generate = require('../lib/generate')
 var checkVersion = require('../lib/check-version')
 
 /**
@@ -87,14 +88,9 @@ if (exists(to)) {
  */
 
 function run () {
-  var options = require('../lib/options')(name)
-  var prompt = require('../lib/prompt')
-  var ask = require('../lib/ask')(options, prompt)
-  var generate = require('../lib/generate')(ask)
-
   // check if template is local
   if (hasSlash && exists(template)) {
-    generate(template, to, function (err) {
+    generate(name, template, to, function (err) {
       if (err) logger.fatal(err)
       console.log()
       logger.success('Generated "%s".', name)
@@ -112,7 +108,7 @@ function run () {
       download(template, tmp, { clone: clone }, function (err) {
         spinner.stop()
         if (err) logger.fatal(err)
-        generate(tmp, to, function (err) {
+        generate(name, tmp, to, function (err) {
           if (err) logger.fatal(err)
           rm(tmp)
           console.log()

lib/ask.js

@@ -1,27 +1,51 @@
 var async = require('async')
+var inquirer = require('inquirer')
+
+// Support types from prompt-for which was used before
+var promptMapping = {
+  string: 'input',
+  boolean: 'confirm'
+}
 
 /**
- * Metalsmith ask plugin.
+ * Ask questions, return results.
  *
- * @param {Function} options
- * @param {Function} prompt
+ * @param {Object} schema
+ * @param {Object} data
+ * @param {Function} done
  */
 
-function ask (options, prompt) {
-  return function (files, metalsmith, done) {
-    var opts = options(metalsmith._directory + '/..')
-
-    var prompts = Object.keys(opts.schema)
-    var metalsmithMetadata = metalsmith.metadata()
+module.exports = function ask (schema, data, done) {
+  async.eachSeries(Object.keys(schema), function (key, next) {
+    prompt(data, key, schema[key], next)
+  }, done)
+}
 
-    async.eachSeries(prompts, run, done)
+/**
+ * Inquirer prompt wrapper.
+ *
+ * @param {Object} data
+ * @param {String} key
+ * @param {Object} prompt
+ * @param {Function} done
+ */
 
-    function run (key, done) {
-      prompt(metalsmithMetadata, key, opts.schema[key], done)
+function prompt (data, key, prompt, done) {
+  inquirer.prompt([{
+    type: promptMapping[prompt.type] || prompt.type,
+    name: key,
+    message: prompt.label || key,
+    default: prompt.default,
+    choices: prompt.choices || []
+  }], function (answers) {
+    if (Array.isArray(answers[key])) {
+      data[key] = {}
+      answers[key].forEach(function (multiChoiceAnswer) {
+        data[key][multiChoiceAnswer] = true
+      })
+    } else {
+      data[key] = answers[key]
     }
-  }
-}
-
-module.exports = function (options, prompt) {
-  return ask(options, prompt)
+    done()
+  })
 }

lib/generate.js

@@ -2,6 +2,33 @@ var Metalsmith = require('metalsmith')
 var async = require('async')
 var render = require('consolidate').handlebars.render
 var path = require('path')
+var getOptions = require('./options')
+var askQuestions = require('./ask')
+
+/**
+ * Generate a template given a `src` and `dest`.
+ *
+ * @param {String} name
+ * @param {String} src
+ * @param {String} dest
+ * @param {Function} done
+ */
+
+module.exports = function generate (name, src, dest, done) {
+  var opts = getOptions(name, src)
+  Metalsmith(path.join(src, 'template'))
+    .use(function (files, metalsmith, done) {
+      askQuestions(opts.schema, metalsmith.metadata(), done)
+    })
+    .use(renderTemplateFiles)
+    .clean(false)
+    .source('.') // start from template root instead of `./src` which is Metalsmith's default for `source`
+    .destination(dest)
+    .build(function (err) {
+      if (err) throw err
+      done()
+    })
+}
 
 /**
  * Template in place plugin.
@@ -15,47 +42,16 @@ function renderTemplateFiles (files, metalsmith, done) {
   var keys = Object.keys(files)
   var metalsmithMetadata = metalsmith.metadata()
 
-  async.each(keys, run, done)
-
-  function run (file, done) {
+  async.each(keys, function (file, next) {
     var str = files[file].contents.toString()
-
     // do not attempt to render files that do not have mustaches
     if (!/{{([^{}]+)}}/g.test(str)) {
-      return done()
+      return next()
     }
-
     render(str, metalsmithMetadata, function (err, res) {
-      if (err) return done(err)
+      if (err) return next(err)
       files[file].contents = new Buffer(res)
-      done()
+      next()
     })
-  }
-}
-
-module.exports = function (ask) {
-  /**
-   * Generate a template given a `src` and `dest`.
-   *
-   * @param {String} src
-   * @param {String} dest
-   * @param {Function} fn
-   */
-
-  function generate (src, dest, fn) {
-    var template = path.join(src, 'template')
-
-    Metalsmith(template)
-      .use(ask)
-      .use(renderTemplateFiles)
-      .clean(false)
-      .source('.') // start from template root instead of `./src` which is Metalsmith's default for `source`
-      .destination(dest)
-      .build(function (err) {
-        if (err) throw err
-        fn()
-      })
-  }
-
-  return generate
+  }, done)
 }

lib/options.js

@@ -1,51 +1,47 @@
 var path = require('path')
 var metadata = require('read-metadata')
 var exists = require('fs').existsSync
-var getGitUser = require('../lib/git-user')
-
-module.exports = function (name) {
-  /**
-   * Read prompts metadata.
-   *
-   * @param {String} dir
-   * @return {Object}
-   */
-
-  function options (dir) {
-    var file = path.join(dir, 'meta.json')
-    var opts = exists(file)
-      ? metadata.sync(file)
-      : {}
-
-    setDefault(opts, 'name', name)
-
-    var author = getGitUser()
-    if (author) {
-      setDefault(opts, 'author', author)
-    }
-
-    return opts
+var getGitUser = require('./git-user')
+
+/**
+ * Read prompts metadata.
+ *
+ * @param {String} dir
+ * @return {Object}
+ */
+
+module.exports = function options (name, dir) {
+  var file = path.join(dir, 'meta.json')
+  var opts = exists(file)
+    ? metadata.sync(file)
+    : {}
+
+  setDefault(opts, 'name', name)
+
+  var author = getGitUser()
+  if (author) {
+    setDefault(opts, 'author', author)
   }
 
-  /**
-   * Set the default value for a schema key
-   *
-   * @param {Object} opts
-   * @param {String} key
-   * @param {String} val
-   */
+  return opts
+}
 
-  function setDefault (opts, key, val) {
-    var schema = opts.schema || (opts.schema = {})
-    if (!schema[key] || typeof schema[key] !== 'object') {
-      schema[key] = {
-        'type': 'string',
-        'default': val
-      }
-    } else {
-      schema[key]['default'] = val
+/**
+ * Set the default value for a schema key
+ *
+ * @param {Object} opts
+ * @param {String} key
+ * @param {String} val
+ */
+
+function setDefault (opts, key, val) {
+  var schema = opts.schema || (opts.schema = {})
+  if (!schema[key] || typeof schema[key] !== 'object') {
+    schema[key] = {
+      'type': 'string',
+      'default': val
     }
+  } else {
+    schema[key]['default'] = val
   }
-
-  return options
 }

lib/prompt.js

@@ -25,7 +25,7 @@
   "scripts": {
     "test": "npm run lint && npm run e2e",
     "lint": "eslint test lib bin/* --env mocha",
-    "e2e": "rimraf test/e2e/mock-template-build/*.* && BABEL_ENV=development mocha test/e2e/test.js --compilers js:babel-core/register"
+    "e2e": "rimraf test/e2e/mock-template-build/*.* && BABEL_ENV=development mocha test/e2e/test.js --slow 1000 --compilers js:babel-core/register"
   },
   "dependencies": {
     "async": "^2.0.0-rc.2",

package.json

@@ -2,15 +2,16 @@ const { expect } = require('chai')
 const fs = require('fs')
 const path = require('path')
 const rm = require('rimraf').sync
-var exists = require('fs').existsSync
+const exists = require('fs').existsSync
 const crypto = require('crypto')
 const render = require('consolidate').handlebars.render
+const inquirer = require('inquirer')
+const generate = require('../../lib/generate')
 
 const MOCK_TEMPLATE_REPO_PATH = './test/e2e/mock-template-repo'
 const MOCK_TEMPLATE_BUILD_PATH = path.resolve('./test/e2e/mock-template-build')
 
 describe('vue-cli', () => {
-  const options = require('../../lib/options')('test')
   const answers = {
     name: 'vue-cli-test',
     author: 'ziga',
@@ -21,15 +22,16 @@ describe('vue-cli', () => {
     }
   }
 
-  const promptFn = (metalsmithMetadata, key, prompt, cb) => {
-    metalsmithMetadata[key] = answers[key]
-    cb()
+  // monkey patch inquirer
+  inquirer.prompt = (questions, cb) => {
+    const key = questions[0].name
+    const _answers = {}
+    _answers[key] = answers[key]
+    cb(_answers)
   }
-  const ask = require('../../lib/ask')(options, promptFn)
-  const generate = require('../../lib/generate')(ask)
 
   it('template generation', done => {
-    generate(MOCK_TEMPLATE_REPO_PATH, MOCK_TEMPLATE_BUILD_PATH, err => {
+    generate('test', MOCK_TEMPLATE_REPO_PATH, MOCK_TEMPLATE_BUILD_PATH, err => {
       if (err) done()
 
       const handlebarsPackageJsonFile = fs.readFileSync(`${MOCK_TEMPLATE_REPO_PATH}/template/package.json`, 'utf8')
@@ -51,7 +53,7 @@ describe('vue-cli', () => {
     wstream.write(crypto.randomBytes(100))
     wstream.end()
 
-    generate(MOCK_TEMPLATE_REPO_PATH, MOCK_TEMPLATE_BUILD_PATH, err => {
+    generate('test', MOCK_TEMPLATE_REPO_PATH, MOCK_TEMPLATE_BUILD_PATH, err => {
       if (err) done()
 
       const handlebarsPackageJsonFile = fs.readFileSync(`${MOCK_TEMPLATE_REPO_PATH}/template/package.json`, 'utf8')