feat: [WIP] add MigratorAPI for vue upgrade usage

vuejs · haoqunjiang · Jul 2, 2019 · May 22, 2019 · Jun 14, 2019 · Jun 14, 2019
commit 3611ff6c92bf48fb03fbd1f27b325f4c8b861baa
diff --git a/packages/@vue/cli-plugin-babel/migrator/index.js b/packages/@vue/cli-plugin-babel/migrator/index.js
@@ -0,0 +1,16 @@
+module.exports = (api) => {
+  if (api.fromVersion('<=3.5.4')) {
+    // add core-js@2 as dependency
+    api.extendPackage({
+      dependencies: {
+        'core-js': '^2.6.5'
+      }
+    })
+  }
+
+  if (api.fromVersion('^3')) {
+    // TODO: update core-js@2 to core-js@3
+  }
+
+  api.exitLog('Full changelog: maybe-some-random-gist-url')
+}
diff --git a/packages/@vue/cli-shared-utils/index.js b/packages/@vue/cli-shared-utils/index.js
@@ -17,3 +17,4 @@
 
 exports.chalk = require('chalk')
 exports.execa = require('execa')
+exports.semver = require('semver')
diff --git a/packages/@vue/cli-shared-utils/lib/spinner.js b/packages/@vue/cli-shared-utils/lib/spinner.js
@@ -43,6 +43,10 @@ exports.resumeSpinner = () => {
   spinner.start()
 }
 
+exports.failSpinner = (text) => {
+  spinner.fail(text)
+}
+
 // silent all logs except errors during tests and keep record
 if (process.env.VUE_CLI_TEST) {
   require('./_silence')('spinner', exports)

diff --git a/packages/@vue/cli-upgrade/index.js b/packages/@vue/cli-upgrade/index.js
@@ -120,6 +120,7 @@ module.exports = async function vueCliUpgrade (semverLevel = 'minor') {
   }
 
   console.log('These packages can be upgraded:\n')
+  // TODO: alternative: https://github.com/angular/angular-cli/blob/34a55c96b2ed38b226879913839b97c601387653/packages/schematics/update/update/index.ts#L490-L509
   console.log(table.toString())
   console.log(
     `\nView complete changelog at ${chalk.blue(

diff --git a/packages/@vue/cli/bin/vue.js b/packages/@vue/cli/bin/vue.js
@@ -166,10 +166,12 @@ program
   })
 
 program
-  .command('upgrade [semverLevel]')
-  .description('upgrade vue cli service / plugins (default semverLevel: minor)')
-  .action((semverLevel, cmd) => {
-    loadCommand('upgrade', '@vue/cli-upgrade')(semverLevel, cleanArgs(cmd))
+  .command('upgrade [package-name]')
+  .description('upgrade vue cli service / plugins')
+  .option('-t, --to <version>', 'upgrade to a version that is not latest')
+  .option('-r, --registry <url>', 'Use specified npm registry when installing dependencies')
+  .action((packageName, cmd) => {
+    require('../lib/upgrade')(packageName, cleanArgs(cmd))
   })
 
 program

diff --git a/packages/@vue/cli/lib/Migrator.js b/packages/@vue/cli/lib/Migrator.js
@@ -0,0 +1,8 @@
+const Generator = require('./Generator')
+
+module.exports = class Migrator extends Generator {
+  constructor (context, options) {
+    super(context, options)
+    this.migrate = this.generate
+  }
+}
diff --git a/packages/@vue/cli/lib/MigratorAPI.js b/packages/@vue/cli/lib/MigratorAPI.js
@@ -0,0 +1,24 @@
+const semver = require('semver')
+const GeneratorAPI = require('./GeneratorAPI')
+
+class MigratorAPI extends GeneratorAPI {
+  /**
+   * @param {string} id - Id of the owner plugin
+   * @param {Migrator} migrator - The invoking Migrator instance
+   * @param {object} options - options passed to this plugin
+   * @param {object} rootOptions - root options (the entire preset)
+   */
+  constructor (id, installedVersion, migrator, options, rootOptions) {
+    super(id, migrator, options, rootOptions)
+
+    this.installedVersion = installedVersion
+    this.migrator = this.generator
+    // this.installedVersion = getInstalledVersion(id)
+  }
+
+  fromVersion (range) {
+    return semver.satisfies(this.installedVersion, range)
+  }
+}
+
+module.exports = MigratorAPI
diff --git a/packages/@vue/cli/lib/upgrade.js b/packages/@vue/cli/lib/upgrade.js
@@ -0,0 +1,227 @@
+const fs = require('fs')
+const path = require('path')
+const chalk = require('chalk')
+const execa = require('execa')
+const globby = require('globby')
+const { isBinaryFileSync } = require('isbinaryfile')
+const {
+  log,
+  error,
+  logWithSpinner,
+  stopSpinner,
+  failSpinner,
+
+  isPlugin,
+  loadModule,
+
+  hasProjectGit
+} = require('@vue/cli-shared-utils')
+
+const Migrator = require('./Migrator')
+const { getCommand, getVersion } = require('./util/packageManager')
+const getPackageJson = require('./util/getPackageJson')
+const getInstalledVersion = require('./util/getInstalledVersion')
+const tryGetNewerRange = require('./util/tryGetNewerRange')
+const { installDeps, installPackage } = require('./util/installDeps')
+const normalizeFilePaths = require('./util/normalizeFilePaths')
+
+async function readFiles (context) {
+  const files = await globby(['**'], {
+    cwd: context,
+    onlyFiles: true,
+    gitignore: true,
+    ignore: ['**/node_modules/**', '**/.git/**'],
+    dot: true
+  })
+  const res = {}
+  for (const file of files) {
+    const name = path.resolve(context, file)
+    res[file] = isBinaryFileSync(name)
+      ? fs.readFileSync(name)
+      : fs.readFileSync(name, 'utf-8')
+  }
+  return normalizeFilePaths(res)
+}
+
+async function runMigrator (packageName, options, context) {
+  const isTestOrDebug = process.env.VUE_CLI_TEST || process.env.VUE_CLI_DEBUG
+
+  const pluginMigrator = loadModule(`${packageName}/migrator`, context)
+  if (!pluginMigrator) { return }
+
+  const { registry } = options
+  const plugin = {
+    packageName,
+    apply: migrator,
+    options: {
+      registry
+    }
+  }
+
+  const pkg = getPackageJson(context)
+  const createCompleteCbs = []
+  const migrator = new Migrator(context, {
+    pkg,
+    plugins: [plugin],
+    files: await readFiles(context),
+    completeCbs: createCompleteCbs,
+    invoking: true
+  })
+
+  log(`🚀  Running migrator of ${packageName}`)
+  await migrator.migrate({
+    extractConfigFiles: true,
+    checkExisting: true
+  })
+
+  const newDeps = migrator.pkg.dependencies
+  const newDevDeps = migrator.pkg.devDependencies
+  const depsChanged =
+    JSON.stringify(newDeps) !== JSON.stringify(pkg.dependencies) ||
+    JSON.stringify(newDevDeps) !== JSON.stringify(pkg.devDependencies)
+
+  // TODO:
+
+  if (!isTestOrDebug && depsChanged) {
+    log(`📦  Installing additional dependencies...`)
+    log()
+    const packageManager = getCommand(context)
+    await installDeps(context, packageManager, plugin.options && plugin.options.registry)
+  }
+
+  if (createCompleteCbs.length) {
+    logWithSpinner('⚓', `Running completion hooks...`)
+    for (const cb of createCompleteCbs) {
+      await cb()
+    }
+    stopSpinner()
+    log()
+  }
+
+  log(`${chalk.green('✔')}  Successfully invoked migrator for plugin: ${chalk.cyan(plugin.id)}`)
+  if (!process.env.VUE_CLI_TEST && hasProjectGit(context)) {
+    const { stdout } = await execa('git', [
+      'ls-files',
+      '--exclude-standard',
+      '--modified',
+      '--others'
+    ], {
+      cwd: context
+    })
+    if (stdout.trim()) {
+      log(`   The following files have been updated / added:\n`)
+      log(
+        chalk.red(
+          stdout
+            .split(/\r?\n/g)
+            .map(line => `     ${line}`)
+            .join('\n')
+        )
+      )
+      log()
+      log(
+        `   You should review these changes with ${chalk.cyan(
+          `git diff`
+        )} and commit them.`
+      )
+      log()
+    }
+  }
+
+  migrator.printExitLogs()
+}
+
+async function upgradeSinglePackage (packageName, options, context) {
+  // FIXME: properly implement this
+  const required = require(`${context}/package.json`).devDependencies[packageName]
+  const installed = getInstalledVersion(packageName)
+
+  let targetVersion = options.to || 'latest'
+
+  // if the targetVersion is not an exact version
+  if (!/\d+\.\d+\.\d+/.test(targetVersion)) {
+    if (targetVersion === 'latest') {
+      logWithSpinner(`Getting latest version of ${packageName}`)
+    } else {
+      logWithSpinner(`Getting max satisfying version of ${packageName}@${options.to}`)
+    }
+
+    targetVersion = await getVersion(packageName, targetVersion, options.registry, context)
+    stopSpinner()
+  }
+
+  if (targetVersion === installed) {
+    log(`Already installed ${packageName}@${targetVersion}`)
+
+    const newRange = tryGetNewerRange(`^${targetVersion}`, required)
+    if (newRange !== required) {
+      // TODO:
+      // extendPackage({ devDependencies: { packageName: newRange } })
+      log(`${chalk.green('✔')}  Updated version range in ${chalk.yellow('package.json')}`)
+    }
+    return
+  }
+
+  log(`Upgrading ${packageName} from ${installed} to ${targetVersion}`)
+
+  // TODO: integrate getCommand into installPackage
+  const command = getCommand(context)
+  await installPackage(context, command, options.registry, packageName)
+  await runMigrator(packageName, { installed }, context)
+}
+
+async function upgradeAll (context) {
+  // get current deps
+  // filter @vue/cli-service, @vue/cli-plugin-* & vue-cli-plugin-*
+  const pkg = getPackageJson(context)
+  const upgradable = {
+    dependencies: {},
+    devDependencies: {},
+    optionalDependencies: {}
+  }
+
+  logWithSpinner('Gathering update information...')
+  for (const depType of Object.keys(upgradable)) {
+    for (const [packageName, range] of Object.entries(pkg[depType] || {})) {
+      if (packageName !== '@vue/cli-service' && !isPlugin(packageName)) {
+        continue
+      }
+
+      const latest = await getVersion(packageName, 'latest', undefined, context)
+      const latestRange = `^${latest}`
+
+      if (range !== latestRange) {
+        upgradable[depType][packageName] = latestRange
+      }
+    }
+  }
+
+  // TODO: upgrade all (interactive)
+  log(upgradable)
+
+  failSpinner()
+
+  return Promise.reject()
+}
+
+async function upgrade (packageName, options, context = process.cwd()) {
+  if (!packageName) {
+    if (options.to) {
+      error(`Must specify a package name to upgrade to ${options.to}`)
+      process.exit(1)
+    }
+
+    return upgradeAll(context)
+  }
+
+  return upgradeSinglePackage(packageName, options, context)
+}
+
+module.exports = (...args) => {
+  return upgrade(...args).catch(err => {
+    error(err)
+    if (!process.env.VUE_CLI_TEST) {
+      process.exit(1)
+    }
+  })
+}
diff --git a/packages/@vue/cli/lib/util/getInstalledVersion.js b/packages/@vue/cli/lib/util/getInstalledVersion.js
@@ -0,0 +1,14 @@
+const path = require('path')
+const getPackageJson = require('./getPackageJson')
+
+module.exports = function getInstalledVersion (packageName) {
+  // for first level deps, read package.json directly is way faster than `npm list`
+  try {
+    const packageJson = getPackageJson(
+      path.resolve(process.cwd(), 'node_modules', packageName)
+    )
+    return packageJson.version
+  } catch (e) {
+    return 'N/A'
+  }
+}
diff --git a/packages/@vue/cli/lib/util/getPackageJson.js b/packages/@vue/cli/lib/util/getPackageJson.js
@@ -0,0 +1,21 @@
+const fs = require('fs')
+const path = require('path')
+
+module.exports = function getPackageJson (projectPath) {
+  const packagePath = path.join(projectPath, 'package.json')
+
+  let packageJson
+  try {
+    packageJson = fs.readFileSync(packagePath, 'utf-8')
+  } catch (err) {
+    throw new Error(`${packagePath} not exist`)
+  }
+
+  try {
+    packageJson = JSON.parse(packageJson)
+  } catch (err) {
+    throw new Error('The package.json is malformed')
+  }
+
+  return packageJson
+}
diff --git a/packages/@vue/cli/lib/util/getPackageVersion.js b/packages/@vue/cli/lib/util/getPackageVersion.js
@@ -1,9 +1,11 @@
 const { request } = require('@vue/cli-shared-utils')
 
-module.exports = async function getPackageVersion (id, range = '') {
-  const registry = (await require('./shouldUseTaobao')())
-    ? `https://registry.npm.taobao.org`
-    : `https://registry.npmjs.org`
+module.exports = async function getPackageVersion (id, range = '', registry) {
+  if (!registry) {
+    registry = (await require('./shouldUseTaobao')())
+      ? `https://registry.npm.taobao.org`
+      : `https://registry.npmjs.org`
+  }
 
   let result
   try {