feat(ui): PluginApi -> describeTask initial impl.

Author: Guillaume Chau

packages/@vue/cli-plugin-eslint/ui.js

@@ -0,0 +1,74 @@
+module.exports = api => {
+  // Config file
+  api.describeConfig({
+    name: 'ESLint configuration',
+    description: 'Error checking & Code quality',
+    link: 'https://eslint.org',
+    files: {
+      json: ['eslintrc', 'eslintrc.json'],
+      js: ['eslintrc.js'],
+      package: 'eslintConfig'
+    },
+    onRead: ({ data }) => {
+      return {
+        prompts: [
+          {
+            name: 'rules.commaDangle',
+            type: 'list',
+            message: 'Trailing commas',
+            description: 'Enforce or disallow trailing commas at the end of the lines',
+            link: 'https://eslint.org/docs/rules/comma-dangle',
+            choices: [
+              {
+                name: 'Off',
+                value: 'off'
+              },
+              {
+                name: 'Never',
+                value: JSON.stringify(['error', 'never'])
+              },
+              {
+                name: 'Always',
+                value: JSON.stringify(['error', 'always'])
+              },
+              {
+                name: 'Always on multiline',
+                value: JSON.stringify(['error', 'always-multiline'])
+              },
+              {
+                name: 'Only on multiline',
+                value: JSON.stringify(['error', 'only-multiline'])
+              }
+            ],
+            value: JSON.stringify(data.rules['comma-dangle'] || ['error', 'never'])
+          }
+        ]
+      }
+    },
+    onWrite: ({ file, answers }) => {
+      file.assignData({
+        'rules.comma-dangle': answers.rules.commaDangle
+      })
+    }
+  })
+
+  // Tasks
+  api.describeTask({
+    match: /vue-cli-service lint/,
+    description: 'Lints and fixes files',
+    link: 'https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-eslint#injected-commands',
+    prompts: [
+      {
+        name: 'noFix',
+        type: 'confirm',
+        default: false,
+        description: 'Do not fix errors'
+      }
+    ],
+    onRun: ({ answers, args }) => {
+      if (answers.noFix) {
+        args.push('--no-fix')
+      }
+    }
+  })
+}

packages/@vue/cli-ui/src/components/TaskItem.vue

@@ -17,7 +17,7 @@
 
       <ListItemInfo
         :name="task.name"
-        :description="task.description || status"
+        :description="(task.status === 'idle' && task.description) || status"
         :selected="selected"
       />
     </div>
@@ -72,6 +72,11 @@ export default {
     flex 100% 1 1
     width 0
 
+    >>> .description
+      white-space nowrap
+      overflow hidden
+      text-overflow ellipsis
+
   &.selected
     &.status-error .list-item-info >>> .name
       color $vue-ui-color-danger

packages/@vue/cli-ui/src/graphql-api/api/PluginApi.js

@@ -0,0 +1,22 @@
+class PluginApi {
+  constructor () {
+    this.configurations = []
+    this.tasks = []
+  }
+
+  describeConfig (options) {
+    this.configurations.push(options)
+  }
+
+  describeTask (options) {
+    this.tasks.push(options)
+  }
+
+  getTask (command) {
+    return this.tasks.find(
+      options => options.match.test(command)
+    )
+  }
+}
+
+module.exports = PluginApi

packages/@vue/cli-ui/src/graphql-api/connectors/logs.js

@@ -1,7 +1,7 @@
 const shortId = require('shortid')
 const { events } = require('@vue/cli-shared-utils/lib/logger')
 const { generateTitle } = require('@vue/cli/lib/util/clearConsole')
-
+// Subs
 const channels = require('../channels')
 
 let init = false

packages/@vue/cli-ui/src/graphql-api/connectors/plugins.js

@@ -8,41 +8,44 @@ const {
   getPluginLink
 } = require('@vue/cli-shared-utils')
 const getPackageVersion = require('@vue/cli/lib/util/getPackageVersion')
+const { resolveModule, loadModule } = require('@vue/cli/lib/util/module')
 const {
   progress: installProgress,
   installPackage,
   uninstallPackage,
   updatePackage
 } = require('@vue/cli/lib/util/installDeps')
 const invoke = require('@vue/cli/lib/invoke')
-
+// Connectors
 const cwd = require('./cwd')
 const folders = require('./folders')
 const prompts = require('./prompts')
 const progress = require('./progress')
 const logs = require('./logs')
-
+// Api
+const PluginApi = require('../api/PluginApi')
+// Utils
 const { getCommand } = require('../utils/command')
 
+const PROGRESS_ID = 'plugin-installation'
+
+// Caches
 const metadataCache = new LRU({
   max: 200,
   maxAge: 1000 * 60 * 30
 })
-
 const logoCache = new LRU({
   max: 50
 })
 
-const PROGRESS_ID = 'plugin-installation'
-
+// Local
 let currentPluginId
 let eventsInstalled = false
 let plugins = []
+let pluginApi
 
 function getPath (id) {
-  return path.dirname(require.resolve(id, {
-    paths: [cwd.get()]
-  }))
+  return path.dirname(resolveModule(id, cwd.get()))
 }
 
 function findPlugins (deps) {
@@ -64,9 +67,23 @@ function list (file, context) {
   plugins = []
   plugins = plugins.concat(findPlugins(pkg.dependencies || {}))
   plugins = plugins.concat(findPlugins(pkg.devDependencies || {}))
+  resetPluginApi(context)
   return plugins
 }
 
+function resetPluginApi (context) {
+  pluginApi = new PluginApi()
+  plugins.forEach(plugin => runPluginApi(plugin.id, context))
+}
+
+function runPluginApi (id, context) {
+  const module = loadModule(`${id}/ui`, cwd.get(), true)
+  if (module) {
+    module(pluginApi)
+    console.log(`PluginApi called for ${id}`)
+  }
+}
+
 function findOne (id, context) {
   return plugins.find(
     p => p.id === id
@@ -175,13 +192,9 @@ function install (id, context) {
       status: 'plugin-install',
       args: [id]
     })
-
     currentPluginId = id
-
     await installPackage(cwd.get(), getCommand(), null, id)
-
     await initPrompts(id, context)
-
     return getInstallation(context)
   })
 }
@@ -192,13 +205,9 @@ function uninstall (id, context) {
       status: 'plugin-uninstall',
       args: [id]
     })
-
     currentPluginId = id
-
     await uninstallPackage(cwd.get(), getCommand(), null, id)
-
     currentPluginId = null
-
     return getInstallation(context)
   })
 }
@@ -209,13 +218,14 @@ function runInvoke (id, context) {
       status: 'plugin-invoke',
       args: [id]
     })
-
     currentPluginId = id
-
-    await invoke(id, prompts.getAnswers(), cwd.get())
-
+    // Allow plugins that don't have a generator
+    if (resolveModule(`${id}/generator`, cwd.get())) {
+      await invoke(id, prompts.getAnswers(), cwd.get())
+    }
+    // Run plugin api
+    runPluginApi(id, context)
     currentPluginId = null
-
     return getInstallation(context)
   })
 }
@@ -240,25 +250,23 @@ function update (id, context) {
       status: 'plugin-update',
       args: [id]
     })
-
     currentPluginId = id
-
     const plugin = findOne(id, context)
     const { current, wanted } = await getVersion(plugin, context)
-
     await updatePackage(cwd.get(), getCommand(), null, id)
-
     logs.add({
       message: `Plugin ${id} updated from ${current} to ${wanted}`,
       type: 'info'
     }, context)
-
     currentPluginId = null
-
     return findOne(id)
   })
 }
 
+function getApi () {
+  return pluginApi
+}
+
 module.exports = {
   list,
   findOne,
@@ -269,5 +277,7 @@ module.exports = {
   install,
   uninstall,
   update,
-  runInvoke
+  runInvoke,
+  resetPluginApi,
+  getApi
 }

packages/@vue/cli-ui/src/graphql-api/connectors/progress.js

@@ -1,3 +1,4 @@
+// Subs
 const channels = require('../channels')
 
 let map = new Map()