refactor: improve options validation

vuejs · Feb 4, 2018 · 85aacc3 · 85aacc3
1 parent d3d040a
commit 85aacc3
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 30 deletions.
diff --git a/packages/@vue/cli-service/lib/Service.js b/packages/@vue/cli-service/lib/Service.js
@@ -154,7 +154,7 @@ module.exports = class Service {
 
   loadProjectOptions (inlineOptions) {
     // vue.config.js
-    let fileConfig, pkgConfig, resolved
+    let fileConfig, pkgConfig, resolved, resovledFrom
     const configPath = (
       process.env.VUE_CLI_SERVICE_CONFIG_PATH ||
       path.resolve(this.context, 'vue.config.js')
@@ -182,23 +182,34 @@ module.exports = class Service {
     if (fileConfig) {
       if (pkgConfig) {
         warn(
-          `"vue" field in ${chalk.bold(`package.json`)} ignored ` +
+          `"vue" field in package.json ignored ` +
           `due to presence of ${chalk.bold('vue.config.js')}.`
         )
+        warn(
+          `You should migrate it into ${chalk.bold('vue.config.js')} ` +
+          `and remove it from package.json.`
+        )
       }
       resolved = fileConfig
+      resovledFrom = 'vue.config.js'
     } else if (pkgConfig) {
       resolved = pkgConfig
+      resovledFrom = '"vue" field in package.json'
     } else {
       resolved = inlineOptions || {}
+      resovledFrom = 'inline options'
     }
 
     // normlaize some options
     ensureSlash(resolved, 'base')
     removeSlash(resolved, 'outputDir')
 
     // validate options
-    validate(resolved)
+    validate(resolved, msg => {
+      error(
+        `Invalid options in ${chalk.bold(resovledFrom)}: ${msg}`
+      )
+    })
 
     return resolved
   }

diff --git a/packages/@vue/cli-service/lib/options.js b/packages/@vue/cli-service/lib/options.js
@@ -7,10 +7,13 @@ const schema = createSchema(joi => joi.object({
   productionSourceMap: joi.boolean(),
   vueLoader: joi.object(),
   parallel: joi.boolean(),
+  devServer: joi.object(),
   dll: joi.alternatives().try(
     joi.boolean(),
     joi.array().items(joi.string())
   ),
+
+  // css
   css: joi.object({
     modules: joi.boolean(),
     extract: joi.boolean(),
@@ -21,25 +24,25 @@ const schema = createSchema(joi => joi.object({
       stylus: joi.object()
     })
   }),
-  devServer: joi.object(),
-
-  // known options from offical plugins
-  lintOnSave: joi.boolean(),
 
   // webpack
   chainWebpack: joi.func(),
   configureWebpack: joi.alternatives().try(
     joi.object(),
     joi.func()
-  )
+  ),
+
+  // known runtime options for built-in plugins
+  lintOnSave: joi.boolean(),
+  pwa: joi.object(),
+
+  // 3rd party plugin options
+  pluginOptions: joi.object()
 }))
 
-exports.validate = options => validate(
-  options,
-  schema,
-  // so that plugins can make use of custom options
-  { allowUnknown: true }
-)
+exports.validate = (options, cb) => {
+  validate(options, schema, cb)
+}
 
 exports.defaults = () => ({
   // project deployment base

diff --git a/packages/@vue/cli-shared-utils/lib/validate.js b/packages/@vue/cli-shared-utils/lib/validate.js
@@ -1,17 +1,16 @@
 const joi = require('joi')
-const { error } = require('./logger')
 
 // proxy to joi for option validation
 exports.createSchema = fn => fn(joi)
 
-exports.validate = (obj, schema, options = {}, noExit) => {
-  joi.validate(obj, schema, options, err => {
+exports.validate = (obj, schema, cb) => {
+  joi.validate(obj, schema, {}, err => {
     if (err) {
-      error(`vue-cli options validation failed:\n` + err.message)
-      if (!noExit) {
-        process.exit(1)
-      } else {
+      cb(err.message)
+      if (process.env.VUE_CLI_TEST) {
         throw err
+      } else {
+        process.exit(1)
       }
     }
   })

diff --git a/packages/@vue/cli/lib/options.js b/packages/@vue/cli/lib/options.js
@@ -2,7 +2,7 @@ const fs = require('fs')
 const os = require('os')
 const path = require('path')
 const cloneDeep = require('lodash.clonedeep')
-const { error, log } = require('@vue/cli-shared-utils/lib/logger')
+const { error } = require('@vue/cli-shared-utils/lib/logger')
 const { createSchema, validate } = require('@vue/cli-shared-utils/lib/validate')
 
 const rcPath = exports.rcPath = (
@@ -24,7 +24,9 @@ const schema = createSchema(joi => joi.object().keys({
   presets: joi.object().pattern(/^/, presetSchema)
 }))
 
-exports.validatePreset = preset => validate(preset, presetSchema)
+exports.validatePreset = preset => validate(preset, presetSchema, msg => {
+  error(`invalid preset options: ${msg}`)
+})
 
 exports.defaultPreset = {
   router: false,
@@ -64,17 +66,14 @@ exports.loadOptions = () => {
         `Please fix/delete it and re-run vue-cli in manual mode.\n` +
         `(${e.message})`,
       )
-      // process.exit(1)
+      process.exit(1)
     }
-    try {
-      validate(cachedOptions, schema, undefined, true /* noExit */)
-    } catch (e) {
-      log(
+    validate(cachedOptions, schema, () => {
+      error(
         `~/.vuerc may be outdated. ` +
         `Please delete it and re-run vue-cli in manual mode.`
       )
-      // process.exit(1)
-    }
+    })
     return cachedOptions
   } else {
     return {}