docs: readme for plugins

Author: yyx990803

packages/@vue/cli-plugin-babel/README.md

@@ -2,7 +2,7 @@
 
 > babel plugin for vue-cli
 
-## Transpilation
+## Configuration
 
 Uses Babel 7 + `babel-loader` + [@vue/babel-preset-app](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/babel-preset-app) by default, but can be configured via `.babelrc` to use any other Babel presets or plugins.
 
@@ -19,10 +19,6 @@ module.exports = {
 }
 ```
 
-## Injected Config Rules
-
-- `config.rule('js')`
-
 ## Caching
 
 [cache-loader](https://github.com/webpack-contrib/cache-loader) is enabled by default and cache is stored in `<projectRoot>/node_modules/.cache/cache-loader`.
@@ -37,3 +33,10 @@ module.exports = {
 npm install -D @vue/cli-plugin-babel
 vue invoke babel
 ```
+
+## Injected webpack-chain Rules
+
+- `config.rule('js')`
+- `config.rule('js').use('babel-loader')`
+- `config.rule('js').use('cache-loader')`
+- `config.rule('js').use('thread-loader')`

packages/@vue/cli-plugin-e2e-cypress/README.md

@@ -8,32 +8,32 @@ Cypress offers a rich interactive interface for running E2E tests, but currently
 
 ## Injected Commands
 
-### `vue-cli-service e2e`
+- **`vue-cli-service e2e`**
 
-run e2e tests headlessly with `cypress run`.
+  run e2e tests headlessly with `cypress run`.
 
-Options:
+  Options:
 
-```
---url      run e2e tests against given url instead of auto-starting dev server
--s, --spec runs a specific spec file. defaults to "all"
-```
+  ```
+  --url      run e2e tests against given url instead of auto-starting dev server
+  -s, --spec runs a specific spec file. defaults to "all"
+  ```
 
-Additionally, [all Cypress CLI options for `cypress run` are also supported](https://docs.cypress.io/guides/guides/command-line.html#cypress-run).
+  Additionally, [all Cypress CLI options for `cypress run` are also supported](https://docs.cypress.io/guides/guides/command-line.html#cypress-run).
 
-### `vue-cli-service e2e:open`
+- **`vue-cli-service e2e:open`**
 
-run e2e tests in interactive mode with `cypress open`.
+  run e2e tests in interactive mode with `cypress open`.
 
-Options:
+  Options:
 
-```
---url      run e2e tests against given url instead of auto-starting dev server
-```
+  ```
+  --url      run e2e tests against given url instead of auto-starting dev server
+  ```
 
-Additionally, [all Cypress CLI options for `cypress open` are also supported](https://docs.cypress.io/guides/guides/command-line.html#cypress-open).
+  Additionally, [all Cypress CLI options for `cypress open` are also supported](https://docs.cypress.io/guides/guides/command-line.html#cypress-open).
 
-Both commands automatically starts a server in production mode to run the e2e tests against. If you want to run the tests multiple times without having to restart the server every time, you can start the server with `vue-cli-service serve --mode production` in one terminal, and then run e2e tests against that server using the `--url` option.
+  Both commands automatically starts a server in production mode to run the e2e tests against. If you want to run the tests multiple times without having to restart the server every time, you can start the server with `vue-cli-service serve --mode production` in one terminal, and then run e2e tests against that server using the `--url` option.
 
 ## Configuration
 

packages/@vue/cli-plugin-e2e-nightwatch/README.md

@@ -4,20 +4,20 @@
 
 ## Injected Commands
 
-### `vue-cli-service e2e`
+- **`vue-cli-service e2e`**
 
-run e2e tests with [NightwatchJS](nightwatchjs.org).
+  run e2e tests with [NightwatchJS](nightwatchjs.org).
 
-Options:
+  Options:
 
-```
---url        run e2e tests against given url instead of auto-starting dev server
--e, --env    specify comma-delimited browser envs to run in (default: chrome)
--t, --test   sepcify a test to run by name
--f, --filter glob to filter tests by filename
-```
+  ```
+  --url        run e2e tests against given url instead of auto-starting dev server
+  -e, --env    specify comma-delimited browser envs to run in (default: chrome)
+  -t, --test   sepcify a test to run by name
+  -f, --filter glob to filter tests by filename
+  ```
 
-Additionally, [all Nightwatch CLI options are also supported](https://github.com/nightwatchjs/nightwatch/blob/master/lib/runner/cli/cli.js).
+  Additionally, [all Nightwatch CLI options are also supported](https://github.com/nightwatchjs/nightwatch/blob/master/lib/runner/cli/cli.js).
 
 ## Configuration
 

packages/@vue/cli-plugin-eslint/README.md

@@ -1,3 +1,33 @@
 # @vue/cli-plugin-eslint
 
 > eslint plugin for vue-cli
+
+## Injected Commands
+
+- **`vue-cli-service lint`**
+
+  Lints and fixes files in `src` and `test`.
+
+## Configuration
+
+ESLint can be configured via `.eslintrc` or the `eslintConfig` field in `package.json`.
+
+Lint-on-save during development with `eslint-loader` can be enabled with the `lintOnSave` option in `vue.config.js`:
+
+``` js
+module.exports = {
+  lintOnSave: true
+}
+```
+
+## Installing in an Already Created Project
+
+``` sh
+npm install -D @vue/cli-plugin-eslint
+vue invoke eslint
+```
+
+## Injected webpack-chain Rules
+
+- `config.rule('eslint')`
+- `config.rule('eslint').use('eslint-loader')`

packages/@vue/cli-plugin-pwa/README.md

@@ -5,29 +5,29 @@
 ## Configuration
 
 Configuration is handled via the `pwa` property of either the `vue.config.js`
-file, or the `"vue"` field in `package.json`. 
+file, or the `"vue"` field in `package.json`.
 
-### pwa.workboxPluginMode
+- **pwa.workboxPluginMode**
 
-This allows you to the choose between the two modes supported by the underlying
-[`workbox-webpack-plugin`](https://developers.google.com/web/tools/workbox/modules/workbox-webpack-plugin).
+  This allows you to the choose between the two modes supported by the underlying
+  [`workbox-webpack-plugin`](https://developers.google.com/web/tools/workbox/modules/workbox-webpack-plugin).
 
-- `'GenerateSW'` (default), will lead to a new service worker file being created
-each time you rebuild your web app.
+  - `'GenerateSW'` (default), will lead to a new service worker file being created
+  each time you rebuild your web app.
 
-- `'InjectManifest'` allows you to start with an existing service worker file,
-and creates a copy of that file with a "precache manifest" injected into it.
+  - `'InjectManifest'` allows you to start with an existing service worker file,
+  and creates a copy of that file with a "precache manifest" injected into it.
 
-The "[Which Plugin to Use?](https://developers.google.com/web/tools/workbox/modules/workbox-webpack-plugin#which_plugin_to_use)"
-guide can help you choose between the two modes.
+  The "[Which Plugin to Use?](https://developers.google.com/web/tools/workbox/modules/workbox-webpack-plugin#which_plugin_to_use)"
+  guide can help you choose between the two modes.
 
-### pwa.workboxOptions
+- **pwa.workboxOptions**
 
-These options are passed on through to the underlying `workbox-webpack-plugin`.
+  These options are passed on through to the underlying `workbox-webpack-plugin`.
 
-For more information on what values are supported, please see the guide for
-[`GenerateSW`](https://developers.google.com/web/tools/workbox/modules/workbox-webpack-plugin#full_generatesw_config)
-or for [`InjectManifest`](https://developers.google.com/web/tools/workbox/modules/workbox-webpack-plugin#full_injectmanifest_config).
+  For more information on what values are supported, please see the guide for
+  [`GenerateSW`](https://developers.google.com/web/tools/workbox/modules/workbox-webpack-plugin#full_generatesw_config)
+  or for [`InjectManifest`](https://developers.google.com/web/tools/workbox/modules/workbox-webpack-plugin#full_injectmanifest_config).
 
 ### Example Configuration
 
@@ -45,3 +45,14 @@ module.exports = {
   },
 };
 ```
+
+## Installing in an Already Created Project
+
+``` sh
+npm install -D @vue/cli-plugin-pwa
+vue invoke pwa
+```
+
+## Injected webpack-chain Rules
+
+- `config.plugin('workbox')`

packages/@vue/cli-plugin-typescript/README.md

@@ -1,3 +1,52 @@
 # @vue/cli-plugin-typescript
 
 > typescript plugin for vue-cli
+
+Uses TypeScript + `ts-loader` + [fork-ts-checker-webpack-plugin](https://github.com/Realytics/fork-ts-checker-webpack-plugin) for faster off-thread type checking.
+
+## Configuration
+
+TypeScript can be configured via `tsconfig.json`.
+
+This plugin can be used alongside `@vue/cli-plugin-babel`. When used with Babel, this plugin will output ES2015 and delegate the rest to Babel for auto polyfill based on browser targets.
+
+By default, `ts-loader` is only applied to files inside `src` and `test` directories. If you wish to explicitly transpile a dependency module, you will need to configure webpack in `vue.config.js`:
+
+``` js
+module.exports = {
+  chainWebpack: config => {
+    config
+      .rule('ts')
+        .include
+          .add(/module-to-transpile/)
+  }
+}
+```
+
+## Injected Commands
+
+If opted to use [TSLint](https://palantir.github.io/tslint/) during project creation, `vue-cli-service lint` will be injected.
+
+## Caching
+
+[cache-loader](https://github.com/webpack-contrib/cache-loader) is enabled by default and cache is stored in `<projectRoot>/node_modules/.cache/cache-loader`.
+
+## Parallelization
+
+[thread-loader](https://github.com/webpack-contrib/thread-loader) is enabled by default when the machine has more than 1 CPU cores. This can be turned off by setting `parallel: false` in `vue.config.js`.
+
+## Installing in an Already Created Project
+
+``` sh
+npm install -D @vue/cli-plugin-typescript
+vue invoke typescript
+```
+
+## Injected webpack-chain Rules
+
+- `config.rule('ts')`
+- `config.rule('ts').use('ts-loader')`
+- `config.rule('ts').use('babel-loader')` (when used alongside `@vue/cli-plugin-babel`)
+- `config.rule('ts').use('cache-loader')`
+- `config.rule('ts').use('thread-loader')`
+- `config.plugin('fork-ts-checker')`

packages/@vue/cli-plugin-unit-jest/README.md

@@ -1,3 +1,27 @@
 # @vue/cli-plugin-unit-jest
 
 > unit-jest plugin for vue-cli
+
+## Injected Commands
+
+- **`vue-cli-service test`**
+
+  Run unit tests with Jest. Default files matches are:
+
+  - Any files in `test/unit` that end in `.spec.(js|ts)`;
+  - Any js/ts files inside `__tests__` directories.
+
+  Usage: `vue-cli-service test [options] <regexForTestFiles>`
+
+  All [Jest command line options](https://facebook.github.io/jest/docs/en/cli.html) are also supported.
+
+## Configuration
+
+Jest can be configured via `jest.config.js` in your project root, or the `jest` field in `package.json`.
+
+## Installing in an Already Created Project
+
+``` sh
+npm install -D @vue/cli-plugin-unit-jest
+vue invoke unit-jest
+```

packages/@vue/cli-plugin-unit-mocha/README.md

@@ -1,3 +1,40 @@
 # @vue/cli-plugin-unit-mocha
 
 > unit-mocha plugin for vue-cli
+
+## Injected Commands
+
+- **`vue-cli-service test`**
+
+  Run unit tests with [mocha-webpack](https://github.com/zinserjan/mocha-webpack) + [chai](http://chaijs.com/).
+
+  **Note the tests are run inside Node.js with browser environment simulated with JSDOM.**
+
+  ```
+  Usage: vue-cli-service test [options] [...files]
+
+  Options:
+
+    --watch, -w   run in watch mode
+    --grep, -g    only run tests matching <pattern>
+    --slow, -s    "slow" test threshold in milliseconds
+    --timeout, -t timeout threshold in milliseconds
+    --bail, -b    bail after first test failure
+    --require, -r require the given module before running tests
+    --include     include the given module into test bundle
+  ```
+
+  Default files matches are: any files in `test/unit` that end in `.spec.(ts|js)`.
+
+  All [mocha-wepback command line options](http://zinserjan.github.io/mocha-webpack/docs/installation/cli-usage.html) are also supported.
+
+## Configuration
+
+Jest can be configured via `jest.config.js` in your project root, or the `jest` field in `package.json`.
+
+## Installing in an Already Created Project
+
+``` sh
+npm install -D @vue/cli-plugin-unit-mocha
+vue invoke unit-mocha
+```

packages/@vue/cli-plugin-unit-mocha/index.js

@@ -40,11 +40,13 @@ module.exports = api => {
       '--webpack-config',
       require.resolve('@vue/cli-service/webpack.config.js'),
       ...rawArgv,
-      ...(hasInlineFilesGlob ? [] : [`test/unit/**/*.js`])
+      ...(hasInlineFilesGlob ? [] : [
+        api.hasPlugin('typescript')
+          ? `test/unit/**/*.spec.ts`
+          : `test/unit/**/*.spec.js`
+      ])
     ]
 
-    console.log(argv)
-
     return new Promise((resolve, reject) => {
       const child = execa(bin, argv, { stdio: 'inherit' })
       child.on('error', reject)