vue-cli/packages/@vue/cli/lib/Creator.js

const fs = require('fs')
const os = require('os')
const ejs = require('ejs')
const path = require('path')
const chalk = require('chalk')
const inquirer = require('inquirer')
const GeneratorAPI = require('./GeneratorAPI')
const installDeps = require('./util/installDeps')
const writeFileTree = require('./util/writeFileTree')

const {
  info,
  error,
  success,
  hasYarn,
  clearConsole
} = require('@vue/cli-shared-utils')

const debug = require('debug')
const rcPath = path.join(os.homedir(), '.vuerc')
const isMode = _mode => ({ mode }) => _mode === mode

const defaultOptions = {
  features: ['eslint', 'unit'],
  eslint: 'eslint-only',
  unit: 'mocha',
  assertionLibrary: 'chai',
  packageManager: hasYarn ? 'yarn' : 'npm'
}

module.exports = class Creator {
  constructor (name, generators) {
    this.name = name
    const { modePrompt, featurePrompt } = this.resolveIntroPrompts()
    this.modePrompt = modePrompt
    this.featurePrompt = featurePrompt
    this.outroPrompts = this.resolveOutroPrompts()
    this.injectedPrompts = []
    this.promptCompleteCbs = []
    this.fileMiddlewares = []

    this.options = {}
    this.pkg = {
      name,
      version: '0.1.0',
      private: true,
      scripts: {},
      dependencies: {},
      devDependencies: {}
    }
    // for conflict resolution
    this.depSources = {}
    // virtual file tree
    this.files = {}

    generators.forEach(({ id, apply }) => {
      apply(new GeneratorAPI(id, this))
    })
  }

  async create (targetDir) {
    // prompt
    clearConsole()
    let options = await inquirer.prompt(this.resolveFinalPrompts())
    debug('rawOptions')(options)

    if (options.mode === 'saved') {
      options = this.loadSavedOptions()
    } else if (options.mode === 'default') {
      options = defaultOptions
    }
    options.projectName = this.name

    // run cb registered by generators
    this.promptCompleteCbs.forEach(cb => cb(options))
    this.options = options
    debug('options')(options)
    // save options
    if (options.mode === 'manual' && options.save) {
      this.saveOptions(options)
    }

    // wait for file resolve
    await this.resolveFiles()
    // set package.json
    this.resolvePkg()
    this.files['package.json'] = JSON.stringify(this.pkg, null, 2)
    // write file tree to disk
    await writeFileTree(targetDir, this.files)

    success(`Project created in ${chalk.cyan(options.projectName)}.`)

    if (options.packageManager) {
      info(`Installing dependencies with ${options.packageManager}. This may take a while...`)
      await installDeps(options.packageManager, targetDir)
    }
  }

  resolveIntroPrompts () {
    const modePrompt = {
      name: 'mode',
      type: 'list',
      message: `Pick a project creation mode:`,
      choices: [
        {
          name: 'Zero-configuration with defaults',
          value: 'default'
        },
        {
          name: 'Manually select features',
          value: 'manual'
        }
      ]
    }
    if (fs.existsSync(rcPath)) {
      modePrompt.choices.unshift({
        name: 'Use previously saved preferences',
        value: 'saved'
      })
    }
    const featurePrompt = {
      name: 'features',
      when: isMode('manual'),
      type: 'checkbox',
      message: 'Please check the features needed for your project.',
      choices: []
    }
    return {
      modePrompt,
      featurePrompt
    }
  }

  resolveOutroPrompts () {
    const outroPrompts = [
      {
        name: 'save',
        when: isMode('manual'),
        type: 'confirm',
        message: 'Save the preferences for future projects?'
      }
    ]
    if (hasYarn) {
      outroPrompts.unshift({
        name: 'packageManager',
        when: isMode('manual'),
        type: 'list',
        message: 'Automatically install NPM dependencies after project creation?',
        choices: [
          {
            name: 'Use NPM',
            value: 'npm',
            short: 'NPM'
          },
          {
            name: 'Use Yarn',
            value: 'yarn',
            short: 'Yarn'
          },
          {
            name: `I'll handle that myself`,
            value: false,
            short: 'No'
          }
        ]
      })
    } else {
      outroPrompts.unshift({
        name: 'packageManager',
        when: isMode('manual'),
        type: 'confirm',
        message: 'Automatically install NPM dependencies after project creation?'
      })
    }
    return outroPrompts
  }

  resolveFinalPrompts () {
    // patch generator-injected prompts to only show when mode === 'manual'
    this.injectedPrompts.forEach(prompt => {
      const originalWhen = prompt.when || (() => true)
      prompt.when = options => {
        return options.mode === 'manual' && originalWhen(options)
      }
    })
    const prompts = [].concat(
      this.modePrompt,
      this.featurePrompt,
      this.injectedPrompts,
      this.outroPrompts
    )
    debug('prompts')(prompts)
    return prompts
  }

  loadSavedOptions () {
    try {
      return JSON.parse(fs.readFileSync(rcPath, 'utf-8'))
    } catch (e) {
      error(
        `Error loading saved preferences: ` +
        `~/.vuerc may be corrupted or have syntax errors. ` +
        `You may need to delete it and re-run vue-cli in manual mode.\n` +
        `(${e.message})`,
        true
      )
    }
  }

  saveOptions (options) {
    try {
      fs.writeFileSync(rcPath, JSON.stringify(options, null, 2))
    } catch (e) {
      error(
        `Error saving preferences: ` +
        `make sure you have write access to ~/.vuerc.\n` +
        `(${e.message})`
      )
    }
  }

  resolvePkg () {
    const sortDeps = deps => Object.keys(deps).sort().reduce((res, name) => {
      res[name] = deps[name]
      return res
    }, {})
    this.pkg.dependencies = sortDeps(this.pkg.dependencies)
    this.pkg.devDependencies = sortDeps(this.pkg.devDependencies)
    debug('pkg')(this.pkg)
  }

  async resolveFiles () {
    for (const middleware of this.fileMiddlewares) {
      await middleware(this.files, ejs.render)
    }
    debug('files')(this.files)
  }
}