feat: vue config command (vuejs#1554)

Payton Burdette · Akryum · commit 153c41855562 · 2018-07-12T00:36:59.000+02:00
* fixed broken plugin dev link on contributing guide

* feat(cli-service): vue config command added

* feat(cli-service): vue config command added

* feat(cli-service): added config commands get and delete

* feat(cli-service): added vue edit command and opn dependcy

* feat(cli-service): added vue config set command and vue config check

* feat(cli-service): nested path support and command/logs adjustment

* feat(cli-service): command option descriptions updated with preset

* refactor: object get/set/unset

* feat: json option + fs/JSON fixes
diff --git a/packages/@vue/cli-service/lib/commands/inspect.js b/packages/@vue/cli-service/lib/commands/inspect.js
@@ -11,7 +11,7 @@ module.exports = (api, options) => {
       '--verbose': 'show full function definitions in output'
     }
   }, args => {
-    const get = require('get-value')
+    const { get } = require('@vue/cli-shared-utils')
     const { toString } = require('webpack-chain')
     const config = api.resolveWebpackConfig()
     const { _: paths, verbose } = args
diff --git a/packages/@vue/cli-service/package.json b/packages/@vue/cli-service/package.json
@@ -41,7 +41,6 @@
     "file-loader": "^1.1.11",
     "friendly-errors-webpack-plugin": "^1.7.0",
     "fs-extra": "^6.0.1",
-    "get-value": "^3.0.1",
     "globby": "^8.0.1",
     "hash-sum": "^1.0.2",
     "html-webpack-plugin": "^3.2.0",
diff --git a/packages/@vue/cli-shared-utils/index.js b/packages/@vue/cli-shared-utils/index.js
@@ -3,6 +3,7 @@
   'exit',
   'ipc',
   'logger',
+  'object',
   'openBrowser',
   'pluginResolution',
   'request',
diff --git a/packages/@vue/cli-shared-utils/lib/object.js b/packages/@vue/cli-shared-utils/lib/object.js
@@ -26,7 +26,7 @@ exports.get = function (target, path) {
   return obj[fields[l - 1]]
 }
 
-exports.remove = function (target, path) {
+exports.unset = function (target, path) {
   const fields = path.split('.')
   let obj = target
   const l = fields.length
diff --git a/packages/@vue/cli-ui/apollo-server/connectors/configurations.js b/packages/@vue/cli-ui/apollo-server/connectors/configurations.js
@@ -9,7 +9,7 @@ const plugins = require('./plugins')
 const folders = require('./folders')
 const prompts = require('./prompts')
 // Utils
-const { get, set, remove } = require('../../src/util/object')
+const { get, set, unset } = require('@vue/cli-shared-utils')
 const { log } = require('../util/logger')
 const { loadModule } = require('@vue/cli/lib/util/module')
 const extendJSConfig = require('@vue/cli/lib/util/extendJSConfig')
@@ -232,7 +232,7 @@ async function save (id, context) {
 
               const value = newData[key]
               if (typeof value === 'undefined') {
-                remove(data[fileId], key)
+                unset(data[fileId], key)
               } else {
                 set(data[fileId], key, value)
               }
diff --git a/packages/@vue/cli-ui/apollo-server/connectors/prompts.js b/packages/@vue/cli-ui/apollo-server/connectors/prompts.js
@@ -1,5 +1,5 @@
 // Utils
-const ObjectUtil = require('../../src/util/object')
+const { get, set, unset } = require('@vue/cli-shared-utils')
 const { log } = require('../util/logger')
 
 let answers = {}
@@ -85,11 +85,11 @@ async function getChoices (prompt) {
 }
 
 function setAnswer (id, value) {
-  ObjectUtil.set(answers, id, value)
+  set(answers, id, value)
 }
 
 function removeAnswer (id) {
-  ObjectUtil.remove(answers, id)
+  unset(answers, id)
 }
 
 function generatePrompt (data) {
@@ -159,7 +159,7 @@ function getAnswers () {
 }
 
 function getAnswer (id) {
-  return ObjectUtil.get(answers, id)
+  return get(answers, id)
 }
 
 async function reset () {
diff --git a/packages/@vue/cli/bin/vue.js b/packages/@vue/cli/bin/vue.js
@@ -126,6 +126,18 @@ program
     loadCommand('init', '@vue/cli-init')
   })
 
+program
+  .command('config [value]')
+  .description('inspect and modify the config')
+  .option('-g, --get <path>', 'get value from option')
+  .option('-s, --set <path> <value>', 'set option value')
+  .option('-d, --delete <path>', 'delete option from config')
+  .option('-e, --edit', 'open config with default editor')
+  .option('--json', 'outputs JSON result only')
+  .action((value, cmd) => {
+    require('../lib/config')(value, cleanArgs(cmd))
+  })
+
 // output help information on unknown commands
 program
   .arguments('<command>')
diff --git a/packages/@vue/cli/lib/config.js b/packages/@vue/cli/lib/config.js
@@ -0,0 +1,86 @@
+const fs = require('fs-extra')
+const path = require('path')
+const homedir = require('os').homedir()
+const { get, set, unset, error } = require('@vue/cli-shared-utils')
+const launch = require('launch-editor')
+
+async function config (value, options) {
+  const file = path.resolve(homedir, '.vuerc')
+  const config = await fs.readJson(file)
+
+  if (!options.delete && !options.get && !options.edit && !options.set) {
+    if (options.json) {
+      console.log(JSON.stringify({
+        resolvedPath: file,
+        content: config
+      }))
+    } else {
+      console.log('Resolved path: ' + file + '\n', JSON.stringify(config, null, 2))
+    }
+  }
+
+  if (options.get) {
+    const value = get(config, options.get)
+    if (options.json) {
+      console.log(JSON.stringify({
+        value
+      }))
+    } else {
+      console.log(value)
+    }
+  }
+
+  if (options.delete) {
+    unset(config, options.delete)
+    await fs.writeFile(file, JSON.stringify(config, null, 2), 'utf-8')
+    if (options.json) {
+      console.log(JSON.stringify({
+        deleted: options.delete
+      }))
+    } else {
+      console.log(`You have removed the option: ${options.delete}`)
+    }
+  }
+
+  if (options.edit) {
+    launch(file)
+  }
+
+  if (options.set && !value) {
+    throw new Error(`Make sure you define a value for the option ${options.set}`)
+  }
+
+  if (options.set && value) {
+    set(config, options.set, value)
+
+    if (value.match('[0-9]')) {
+      set(config, options.set, parseInt(value))
+    }
+
+    if (value === 'true') {
+      set(config, options.set, true)
+    }
+
+    if (value === 'false') {
+      set(config, options.set, false)
+    }
+
+    await fs.writeFile(file, JSON.stringify(config, null, 2), 'utf-8')
+    if (options.json) {
+      console.log(JSON.stringify({
+        updated: options.set
+      }))
+    } else {
+      console.log(`You have updated the option: ${options.set} to ${value}`)
+    }
+  }
+}
+
+module.exports = (...args) => {
+  return config(...args).catch(err => {
+    error(err)
+    if (!process.env.VUE_CLI_TEST) {
+      process.exit(1)
+    }
+  })
+}
diff --git a/packages/@vue/cli/package.json b/packages/@vue/cli/package.json
@@ -46,6 +46,7 @@
     "javascript-stringify": "^1.6.0",
     "js-yaml": "^3.12.0",
     "klaw-sync": "^4.0.0",
+    "launch-editor": "^2.2.1",
     "lodash.clonedeep": "^4.5.0",
     "minimist": "^1.2.0",
     "recast": "^0.15.2",
diff --git a/yarn.lock b/yarn.lock
@@ -5476,12 +5476,6 @@ get-value@^2.0.3, get-value@^2.0.6:
   version "2.0.6"
   resolved "https://registry.yarnpkg.com/get-value/-/get-value-2.0.6.tgz#dc15ca1c672387ca76bd37ac0a395ba2042a2c28"
 
-get-value@^3.0.1:
-  version "3.0.1"
-  resolved "https://registry.yarnpkg.com/get-value/-/get-value-3.0.1.tgz#5efd2a157f1d6a516d7524e124ac52d0a39ef5a8"
-  dependencies:
-    isobject "^3.0.1"
-
 getos@2.8.4:
   version "2.8.4"
   resolved "https://registry.yarnpkg.com/getos/-/getos-2.8.4.tgz#7b8603d3619c28e38cb0fe7a4f63c3acb80d5163"

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ module.exports = (api, options) => {`
`11`	`11`	`'--verbose': 'show full function definitions in output'`
`12`	`12`	`}`
`13`	`13`	`}, args => {`
`14`		`- const get = require('get-value')`
	`14`	`+ const { get } = require('@vue/cli-shared-utils')`
`15`	`15`	`const { toString } = require('webpack-chain')`
`16`	`16`	`const config = api.resolveWebpackConfig()`
`17`	`17`	`const { _: paths, verbose } = args`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ exports.get = function (target, path) {`
`26`	`26`	`return obj[fields[l - 1]]`
`27`	`27`	`}`
`28`	`28`
`29`		`-exports.remove = function (target, path) {`
	`29`	`+exports.unset = function (target, path) {`
`30`	`30`	`const fields = path.split('.')`
`31`	`31`	`let obj = target`
`32`	`32`	`const l = fields.length`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`// Utils`
`2`		`-const ObjectUtil = require('../../src/util/object')`
	`2`	`+const { get, set, unset } = require('@vue/cli-shared-utils')`
`3`	`3`	`const { log } = require('../util/logger')`
`4`	`4`
`5`	`5`	`let answers = {}`
`@@ -85,11 +85,11 @@ async function getChoices (prompt) {`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`function setAnswer (id, value) {`
`88`		`- ObjectUtil.set(answers, id, value)`
	`88`	`+ set(answers, id, value)`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`function removeAnswer (id) {`
`92`		`- ObjectUtil.remove(answers, id)`
	`92`	`+ unset(answers, id)`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`function generatePrompt (data) {`
`@@ -159,7 +159,7 @@ function getAnswers () {`
`159`	`159`	`}`
`160`	`160`
`161`	`161`	`function getAnswer (id) {`
`162`		`- return ObjectUtil.get(answers, id)`
	`162`	`+ return get(answers, id)`
`163`	`163`	`}`
`164`	`164`
`165`	`165`	`async function reset () {`