Mick's Blog | Mick's Blog

找了个vue-cli比较简单的版本来解刨一下

源码地址

我们直接从github打开地址clone下来即可

git clone git@github.com:vuejs/vue-cli.git

然后将分支切换到v2就是我们今天要看到代码分支。

init初始化

vue init webpack [project-name]

当我们使用vue-cli的时候，使用上面的命令。然后这行命令执行，其实就是执行我们源码中bin/vue-init文件。下面我们就来看看这个文件

/**
 * Usage.
 */
// 配置command使用方法
program
  .usage('<template-name> [project-name]')
  .option('-c, --clone', 'use git clone')
  .option('--offline', 'use cached template')

/**
 * Help.
 */

program.on('--help', () => {
  console.log('  Examples:')
  console.log()
  console.log(chalk.gray('    # create a new project with an official template'))
  console.log('    $ vue init webpack my-project')
  console.log()
  console.log(chalk.gray('    # create a new project straight from a github template'))
  console.log('    $ vue init username/repo my-project')
  console.log()
})

/**
 * Help.
 */

function help () {
  program.parse(process.argv)
  if (program.args.length < 1) return program.help()
}
help()

这里主要是对commander进行配置，当我们执行vue init后面不传参的时候或者执行vue init --help会在命令行给出一些提示信息

settings

let template = program.args[0]
const hasSlash = template.indexOf('/') > -1
const rawName = program.args[1]
const inPlace = !rawName || rawName === '.' // 判断项目名是否为空 或者为'.'
const name = inPlace ? path.relative('../', process.cwd()) : rawName
const to = path.resolve(rawName || '.')
const clone = program.clone || false

// 模板地址的加载
const tmp = path.join(home, '.vue-templates', template.replace(/[\/:]/g, '-'))
console.log(tmp);
// vue init --offline xx xx 会读取缓存中的模板
if (program.offline) {
  console.log(`> Use cached template at ${chalk.yellow(tildify(tmp))}`)
  template = tmp
}

这里主要是定义了一些变量。首先通过program.args获取命令行的参数，第一个参数是模板template，第二个参数是项目名称rawName。template主要有两种，一种是通过官方的webpack创建，另一种是通过github上面的第三方仓库当做模板创建，hasSlash则表示如果template上有/则表示是使用第二种方式创建模板。inPlace判断项目名称是否为空或者是否为'.'。name表示项目名，to表示当前项目的目录。clone则在下面下载的时候判断是从第三个clone还是download。

我们首先会根据template去下载模板，下载完成之后会存放在根目录下的.vue-templates文件中，而tmp就是我们当前模板的地址。如果参数中有--offline则表示直接取本地已经下载好的模板，就不需要去重新下载模板了。

执行run

// 是否为在当前目录下创建 or 存在当前目录
if (inPlace || exists(to)) {
  inquirer.prompt([{
    type: 'confirm',
    message: inPlace
      ? 'Generate project in current directory?'
      : 'Target directory exists. Continue?',
    name: 'ok'
  }]).then(answers => {
    if (answers.ok) {
      run()
    }
  }).catch(logger.fatal)
} else {
  run()
}

对inPlace和exists(to)判断是否当前目录下已经创建或者是否已经存在当前目录。如果是则进行询问是否继续创建，否则执行run,如果继续创建也执行run

/**
 * Check, download and generate the project.
 */
function run () {
  // check if template is local
  // 如果走的是本地的模板
  if (isLocalPath(template)) {
    const templatePath = getTemplatePath(template)
    // 如果本地模板存在
    if (exists(templatePath)) {
      generate(name, templatePath, to, err => {
        if (err) logger.fatal(err)
        console.log()
        logger.success('Generated "%s".', name)
      })
    } else {
      logger.fatal('Local template "%s" not found.', template)
    }
  } else {
    // 走官方模板
    checkVersion(() => {
      if (!hasSlash) {
        // use official templates
        const officialTemplate = 'vuejs-templates/' + template
        if (template.indexOf('#') !== -1) {
          downloadAndGenerate(officialTemplate)
        } else {
          if (template.indexOf('-2.0') !== -1) {
            warnings.v2SuffixTemplatesDeprecated(template, inPlace ? '' : name)
            return
          }

          // warnings.v2BranchIsNowDefault(template, inPlace ? '' : name)
          downloadAndGenerate(officialTemplate)
        }
      } else {
        downloadAndGenerate(template)
      }
    })
  }
}

如果是本地的模板则拿到template的地址进行判断，如果地址存在则执行generate（这个方法下面单独说）。否则则取得是官方模板，然后对版本号进行审核。

module.exports = done => {
  // Ensure minimum supported node version is used
  if (!semver.satisfies(process.version, packageConfig.engines.node)) {
    return console.log(chalk.red(
      '  You must upgrade node to >=' + packageConfig.engines.node + '.x to use vue-cli'
    ))
  }

  request({
    url: 'https://registry.npmjs.org/vue-cli',
    timeout: 1000
  }, (err, res, body) => {
    if (!err && res.statusCode === 200) {
      const latestVersion = JSON.parse(body)['dist-tags'].latest
      const localVersion = packageConfig.version
      if (semver.lt(localVersion, latestVersion)) {
        console.log(chalk.yellow('  A newer version of vue-cli is available.'))
        console.log()
        console.log('  latest:    ' + chalk.green(latestVersion))
        console.log('  installed: ' + chalk.red(localVersion))
        console.log()
      }
    }
    done()
  })
}

首先会判断当前node版本号是否大于规定的版本号，如果小于在提示更新node版本。然后请求https://registry.npmjs.org/vue-cli拿到当前vue-cli最新的版本和本地的版本进行对比，如果本地的版本小于最新的版本，则提示版本信息。

版本号审核完毕之后，判断是从github上下载模板还是从官方下载模板。最终都会执行downloadAndGenerate


function downloadAndGenerate (template) {
  const spinner = ora('downloading template')
  spinner.start()
  // Remove if local template exists
  if (exists(tmp)) rm(tmp)
  download(template, tmp, { clone }, err => {
    spinner.stop()
    if (err) logger.fatal('Failed to download repo ' + template + ': ' + err.message.trim())
    generate(name, tmp, to, err => {
      if (err) logger.fatal(err)
      console.log()
      logger.success('Generated "%s".', name)
    })
  })
}

spinner.start()是下载时候的loading,如果当前模板已经存在，则先删除掉，在执行download。

download

function download (repo, dest, opts, fn) {
  if (typeof opts === 'function') {
    fn = opts
    opts = null
  }
  opts = opts || {}
  var clone = opts.clone || false

  repo = normalize(repo)
  var url = getUrl(repo, clone)

  if (clone) {
    gitclone(url, dest, { checkout: repo.checkout, shallow: repo.checkout === 'master' }, function (err) {
      if (err === undefined) {
        rm(dest + '/.git')
        fn()
      } else {
        fn(err)
      }
    })
  } else {
    downloadUrl(url, dest, { extract: true, strip: 1, mode: '666', headers: { accept: 'application/zip' } }).then(data => {
      fn()
    }).catch(err => {
      fn(err)
    })
  }
}

如果需要clone则执行gitclone去clone模板，否则执行downloadUrl去下载模板。这两个方法是使用的第三方的库，有兴趣可以了解一下。

下载完成之后，spinner.stop()关闭loading,然后开始generate生成了。

generate

const chalk = require('chalk')
const Metalsmith = require('metalsmith') // 静态网页生成
const Handlebars = require('handlebars') // 模板引擎
const async = require('async')
// 模板引擎的解析渲染器
const render = require('consolidate').handlebars.render
const path = require('path')
// 多条件匹配
const multimatch = require('multimatch')
const getOptions = require('./options')
const ask = require('./ask')
const filter = require('./filter')
const logger = require('./logger')

// register handlebars helper
Handlebars.registerHelper('if_eq', function (a, b, opts) {
  return a === b
    ? opts.fn(this)
    : opts.inverse(this)
})

Handlebars.registerHelper('unless_eq', function (a, b, opts) {
  return a === b
    ? opts.inverse(this)
    : opts.fn(this)
})

在generate.js文件中，引入了很多的第三方的包，这里比较重要的是metalsmith主要是静态网页生成和handlerbars主要是模板引擎。还有一个是require('consolidate').handlebars.render作为模板引擎的解析渲染器。注册了两个渲染器

下面主要看下generate的实现

module.exports = function generate (name, src, dest, done) {
  // 读取配置项入口
  const opts = getOptions(name, src)
  // metalsmith 初始化
  const metalsmith = Metalsmith(path.join(src, 'template'))

  // 配置项合并
  const data = Object.assign(metalsmith.metadata(), {
    destDirName: name,
    inPlace: dest === process.cwd(),
    noEscape: true
  })
  // 配置对象
  opts.helpers && Object.keys(opts.helpers).map(key => {
    Handlebars.registerHelper(key, opts.helpers[key])
  })

  const helpers = { chalk, logger }

  // 调用before钩子
  if (opts.metalsmith && typeof opts.metalsmith.before === 'function') {
    opts.metalsmith.before(metalsmith, opts, helpers)
  }

  // 询问
  metalsmith.use(askQuestions(opts.prompts))
    // 配置过滤
    .use(filterFiles(opts.filters))
    // 渲染模板文件
    .use(renderTemplateFiles(opts.skipInterpolation))

  if (typeof opts.metalsmith === 'function') {
    opts.metalsmith(metalsmith, opts, helpers)
  } else if (opts.metalsmith && typeof opts.metalsmith.after === 'function') {
    opts.metalsmith.after(metalsmith, opts, helpers)
  }

  metalsmith.clean(false)
    .source('.') // start from template root instead of `./src` which is Metalsmith's default for `source`
    .destination(dest)
    .build((err, files) => {
      done(err)
      if (typeof opts.complete === 'function') {
        const helpers = { chalk, logger, files }
        opts.complete(data, helpers)
      } else {
        logMessage(opts.completeMessage, data)
      }
    })

  return data
}

首先通过getOptions读取配置项入口。

module.exports = function options (name, dir) {
  const opts = getMetadata(dir)

  setDefault(opts, 'name', name)
  setValidateName(opts)

  const author = getGitUser()
  if (author) {
    setDefault(opts, 'author', author)
  }

  return opts
}

/**
 * Gets the metadata from either a meta.json or meta.js file.
 *
 * @param  {String} dir
 * @return {Object}
 */

function getMetadata (dir) {
  const json = path.join(dir, 'meta.json')
  const js = path.join(dir, 'meta.js')
  let opts = {}

  if (exists(json)) {
    opts = metadata.sync(json)
  } else if (exists(js)) {
    const req = require(path.resolve(js))
    if (req !== Object(req)) {
      throw new Error('meta.js needs to expose an object')
    }
    opts = req
  }

  return opts
}

通过getMetadata方法读取模板中的meta.json或者meta.js文件，然后把结果赋值给opts。然后对name的设置进行校验，接着对本地git作者信息进行合并，最终返回opts。

执行完了getOptions之后，然后metalsmith初始化，要在初始化这个目录下面生成静态文件。对meta.json文件中的helpers进行注册渲染模板的数据。执行before钩子。然后通过对象的方式操作真实的模板，通过askQuestions来询问一些问题，过滤一些文件。

接着通过opts.metalsmith执行模板。最后执行构建，当生成完毕之后执行complete方法。

以上就是generate的主要流程我们来简单的总结一下

读取配置入口
metalsmith初始化
配置项合并
调用before钩子
询问、配置过滤、渲染模板文件
build构建
构建完成之后执行complete

掘金

源码地址 #

init初始化 #

settings #

执行run #

download #