chore: merge branch 'dev' into docs

Author: haoqunjiang

docs/.vuepress/config.js

@@ -109,6 +109,14 @@ module.exports = {
           ],
           '/dev-guide/': [
             '/dev-guide/plugin-dev.md',
+            {
+              title: 'API reference',
+              collapsable: false,
+              children: [
+                '/dev-guide/plugin-api.md',
+                '/dev-guide/generator-api.md',
+              ]
+            },
             {
               title: 'UI Development',
               collapsable: false,

docs/.vuepress/public/generator-template.png

@@ -0,0 +1,133 @@
+# Generator API
+
+## resolve
+
+- **Arguments**
+  - `{string} _path` - relative path from project root
+
+- **Returns**
+  - `{string}`- the resolved absolute path
+
+- **Usage**:
+Resolve a path for the current project
+
+## hasPlugin
+
+- **Arguments**
+  - `{string} id` - plugin id, can omit the (@vue/|vue-|@scope/vue)-cli-plugin- prefix
+
+- **Returns**
+  - `{boolean}`
+
+- **Usage**:
+Check if the project has a plugin with given id
+
+## addConfigTransform
+
+- **Arguments**
+  - `{string} key` - config key in package.json
+  - `{object} options` - options
+  - `{object} options.file` - file descriptor. Used to search for existing file. Each key is a file type (possible values: ['js', 'json', 'yaml', 'lines']). The value is a list of filenames.
+  Example:
+  ```js
+  {
+    js: ['.eslintrc.js'],
+    json: ['.eslintrc.json', '.eslintrc']
+  }
+  ```
+  By default, the first filename will be used to create the config file.
+
+- **Returns**
+  - `{boolean}`
+
+- **Usage**:
+Configure how config files are extracted.
+
+## extendPackage
+
+- **Arguments**
+  - `{object | () => object} fields` - fields to merge
+
+- **Usage**:
+Extend the `package.json` of the project. Nested fields are deep-merged unless `{ merge: false }` is passed. Also resolves dependency conflicts between plugins. Tool configuration fields may be extracted into standalone files before files are written to disk.
+
+## render
+
+- **Arguments**
+  - `{string | object | FileMiddleware} source` - can be one of
+    - relative path to a directory;
+    - object hash of `{ sourceTemplate: targetFile }` mappings;
+    - a custom file middleware function
+  - `{object} [additionalData]` - additional data available to templates
+  - `{object} [ejsOptions]` - options for ejs
+
+- **Usage**:
+Render template files into the virtual files tree object.
+
+## postProcessFiles
+
+- **Arguments**
+  - `{FileMiddleware} cb` - file middleware
+
+- **Usage**:
+Push a file middleware that will be applied after all normal file middlewares have been applied.
+
+## onCreateComplete
+
+- **Arguments**
+  - `{function} cb`
+
+- **Usage**:
+Push a callback to be called when the files have been written to disk.
+
+## exitLog
+
+- **Arguments**
+  - `{} msg` - string or value to print after the generation is completed;
+  - `{('log'|'info'|'done'|'warn'|'error')} [type='log']` - type of the message.
+
+- **Usage**:
+Add a message to be printed when the generator exits (after any other standard messages).
+
+## genJSConfig
+
+- **Arguments**
+  - `{any} value`
+
+- **Usage**:
+Convenience method for generating a JS config file from JSON
+
+## injectImports
+
+- **Arguments**
+  - `{string} file` - target file to add imports
+  - `{string | [string]} imports` - imports string/array
+
+- **Usage**:
+Add import statements to a file.
+
+## injectRootOptions
+
+- **Arguments**
+  - `{string} file` - target file to add options
+  - `{string | [string]} options` - options string/array
+
+- **Usage**:
+Add options to the root Vue instance (detected by `new Vue`).
+
+## entryFile
+
+- **Returns**
+  - `{('src/main.ts'|'src/main.js')}`
+
+- **Usage**:
+Get the entry file taking into account typescript.
+
+## invoking
+
+- **Returns**
+  - `{boolean}`
+
+- **Usage**:
+Checks if the plugin is being invoked.
+

docs/.vuepress/public/prompts-example.png

@@ -0,0 +1,112 @@
+# Plugin API
+
+## getCwd
+
+- **Usage**:
+Returns a current working directory
+
+## resolve
+
+- **Arguments**
+  - `{string} path` - relative path from project root
+
+- **Returns**
+  - `{string}`- the resolved absolute path
+
+- **Usage**:
+Resolve a path for the current project
+
+## hasPlugin
+
+- **Arguments**
+  - `{string} id` - plugin id, can omit the (@vue/|vue-|@scope/vue)-cli-plugin- prefix
+
+- **Returns**
+  - `{boolean}`
+
+- **Usage**:
+Check if the project has a plugin with given id
+
+## registerCommand
+
+- **Arguments**
+  - `{string} name`
+  - `{object} [opts]`
+  ```js
+  {
+    description: string,
+    usage: string,
+    options: { [string]: string }
+  }
+  ```
+  - `{function} fn`
+  ```js
+  (args: { [string]: string }, rawArgs: string[]) => ?Promise
+  ```
+
+- **Usage**:
+Register a command that will become available as `vue-cli-service [name]`.
+
+## chainWebpack
+
+- **Arguments**
+  - `{function} fn`
+
+- **Usage**:
+Register a function that will receive a chainable webpack config. This function is lazy and won't be called until `resolveWebpackConfig` is called.
+
+
+## configureWebpack
+
+- **Arguments**
+  - `{object | function} fn`
+
+- **Usage**:
+Register a webpack configuration object that will be merged into the config **OR** a function that will receive the raw webpack config. The function can either mutate the config directly or return an object
+that will be merged into the webpack config.
+
+## configureDevServer
+
+- **Arguments**
+  - `{object | function} fn`
+
+- **Usage**:
+Register a dev serve config function. It will receive the express `app` instance of the dev server.
+
+## resolveWebpackConfig
+
+- **Arguments**
+  - `{ChainableWebpackConfig} [chainableConfig]`
+- **Returns**
+  - `{object}` - raw webpack config
+
+- **Usage**:
+Resolve the final raw webpack config, that will be passed to webpack.
+
+## resolveChainableWebpackConfig
+
+- **Returns**
+  - `{ChainableWebpackConfig}`
+
+- **Usage**:
+Resolve an intermediate chainable webpack config instance, which can be further tweaked before generating the final raw webpack config. You can call this multiple times to generate different branches of the base webpack config.
+
+See [https://github.com/mozilla-neutrino/webpack-chain](https://github.com/mozilla-neutrino/webpack-chain)
+
+## genCacheConfig
+
+- **Arguments**
+  - `id`
+  - `partialIdentifier`
+  - `configFiles`
+- **Returns**
+  - `{object}`
+  ```js
+  {
+    cacheDirectory: string,
+    cacheIdentifier: string }
+  ```
+
+- **Usage**:
+Generate a cache identifier from a number of variables.
+