feat(generator): add exitLog api

Guillaume Chau · Guillaume Chau · commit 1ec3ead73ba6 · 2018-03-03T13:14:29.000+01:00
diff --git a/packages/@vue/cli/lib/Creator.js b/packages/@vue/cli/lib/Creator.js
@@ -176,6 +176,8 @@ module.exports = class Creator {
       chalk.cyan(` ${chalk.gray('$')} ${packageManager === 'yarn' ? 'yarn serve' : 'npm run serve'}`)
     )
     log()
+
+    generator.printExitLogs()
   }
 
   async promptAndResolvePreset () {
diff --git a/packages/@vue/cli/lib/Generator.js b/packages/@vue/cli/lib/Generator.js
@@ -5,6 +5,15 @@ const GeneratorAPI = require('./GeneratorAPI')
 const sortObject = require('./util/sortObject')
 const writeFileTree = require('./util/writeFileTree')
 const configTransforms = require('./util/configTransforms')
+const logger = require('@vue/cli-shared-utils/lib/logger')
+
+const logTypes = {
+  log: logger.log,
+  info: logger.info,
+  done: logger.done,
+  warn: logger.warn,
+  error: logger.error
+}
 
 module.exports = class Generator {
   constructor (context, pkg, plugins, completeCbs = []) {
@@ -20,6 +29,8 @@ module.exports = class Generator {
     this.files = {}
     this.fileMiddlewares = []
     this.postProcessFilesCbs = []
+    // exit messages
+    this.exitLogs = []
 
     const cliService = plugins.find(p => p.id === '@vue/cli-service')
     const rootOptions = cliService && cliService.options
@@ -135,4 +146,19 @@ module.exports = class Generator {
       return id === _id || id.replace(prefixRE, '') === _id
     })
   }
+
+  printExitLogs () {
+    if (this.exitLogs.length) {
+      this.exitLogs.forEach(({ id, msg, type }) => {
+        const shortId = id.replace('@vue/cli-plugin-', '').replace('vue-cli-plugin-', '')
+        const logFn = logTypes[type]
+        if (!logFn) {
+          logger.error(`Invalid api.exitLog type '${type}'.`, shortId)
+        } else {
+          logFn(msg, msg && shortId)
+        }
+      })
+      logger.log()
+    }
+  }
 }
diff --git a/packages/@vue/cli/lib/GeneratorAPI.js b/packages/@vue/cli/lib/GeneratorAPI.js
@@ -196,6 +196,16 @@ class GeneratorAPI {
   onCreateComplete (cb) {
     this.generator.completeCbs.push(cb)
   }
+
+  /**
+   * Add a message to be printed when the generator exits (after any other standard messages).
+   *
+   * @param {} msg String or value to print after the generation is completed
+   * @param {('log'|'info'|'done'|'warn'|'error')} [type='log'] Type of message
+   */
+  exitLog (msg, type = 'log') {
+    this.generator.exitLogs.push({ id: this.id, msg, type })
+  }
 }
 
 function extractCallDir () {
diff --git a/packages/@vue/cli/lib/invoke.js b/packages/@vue/cli/lib/invoke.js
@@ -125,6 +125,8 @@ async function invoke (pluginName, options = {}, context = process.cwd()) {
   }
   log(`   You should review and commit the changes.`)
   log()
+
+  generator.printExitLogs()
 }
 
 module.exports = (...args) => {

Original file line number	Diff line number	Diff line change
`@@ -176,6 +176,8 @@ module.exports = class Creator {`
`176`	`176`	chalk.cyan(` ${chalk.gray('$')} ${packageManager === 'yarn' ? 'yarn serve' : 'npm run serve'}`)
`177`	`177`	`)`
`178`	`178`	`log()`
	`179`	`+`
	`180`	`+ generator.printExitLogs()`
`179`	`181`	`}`
`180`	`182`
`181`	`183`	`async promptAndResolvePreset () {`
Original file line number	Diff line number	Diff line change
`@@ -125,6 +125,8 @@ async function invoke (pluginName, options = {}, context = process.cwd()) {`
`125`	`125`	`}`
`126`	`126`	log(` You should review and commit the changes.`)
`127`	`127`	`log()`
	`128`	`+`
	`129`	`+ generator.printExitLogs()`
`128`	`130`	`}`
`129`	`131`
`130`	`132`	`module.exports = (...args) => {`