docs: created a script to generate docs

vuejs · haoqunjiang · Jun 12, 2019 · Jun 8, 2019 · Jun 10, 2019 · Jun 10, 2019
commit 3ccc64feb38f96254bb020829adc09de1c382723
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -147,10 +147,10 @@ module.exports = {
               '/core-plugins/typescript.md',
               '/core-plugins/eslint.md',
               '/core-plugins/pwa.md',
-              '/core-plugins/jest.md',
-              '/core-plugins/mocha.md',
-              '/core-plugins/cypress.md',
-              '/core-plugins/nightwatch.md'
+              '/core-plugins/unit-jest.md',
+              '/core-plugins/unit-mocha.md',
+              '/core-plugins/e2e-cypress.md',
+              '/core-plugins/e2e-nightwatch.md'
             ]
           }],
 

diff --git a/docs/core-plugins/README.md b/docs/core-plugins/README.md
@@ -8,7 +8,7 @@ This section contains documentation for core Vue CLI plugins:
 - [TypeScript](typescript.md)
 - [ESLint](eslint.md)
 - [PWA](pwa.md)
-- [Jest](jest.md)
-- [Mocha](mocha.md)
-- [Cypress](cypress.md)
-- [Nightwatch](nightwatch.md)
+- [Jest](unit-jest.md)
+- [Mocha](unit-mocha.md)
+- [Cypress](e2e-cypress.md)
+- [Nightwatch](e2e-nightwatch.md)
diff --git a/docs/core-plugins/babel.md b/docs/core-plugins/babel.md
@@ -1,6 +1,6 @@
 # @vue/cli-plugin-babel
 
-> Babel plugin for Vue CLI
+> babel plugin for vue-cli
 
 ## Configuration
 

diff --git a/docs/core-plugins/cypress.md → docs/core-plugins/e2e-cypress.md b/docs/core-plugins/cypress.md → docs/core-plugins/e2e-cypress.md
@@ -1,6 +1,6 @@
 # @vue/cli-plugin-e2e-cypress
 
-> e2e-cypress plugin for Vue CLI
+> e2e-cypress plugin for vue-cli
 
 This adds E2E testing support using [Cypress](https://www.cypress.io/).
 
@@ -29,7 +29,7 @@ Cypress offers a rich interactive interface for running E2E tests, but currently
 
   - In GUI mode, [all Cypress CLI options for `cypress open` are also supported](https://docs.cypress.io/guides/guides/command-line.html#cypress-open);
   - In `--headless` mode, [all Cypress CLI options for `cypress run` are also supported](https://docs.cypress.io/guides/guides/command-line.html#cypress-run).
-
+  
   Examples :
   - Run Cypress in headless mode for a specific file: `vue-cli-service test:e2e --headless --spec tests/e2e/specs/actions.spec.js`
 

diff --git a/docs/core-plugins/nightwatch.md → docs/core-plugins/e2e-nightwatch.md b/docs/core-plugins/nightwatch.md → docs/core-plugins/e2e-nightwatch.md
@@ -1,6 +1,6 @@
 # @vue/cli-plugin-e2e-nightwatch
 
-> e2e-nightwatch plugin for Vue CLI
+> e2e-nightwatch plugin for vue-cli
 
 ## Injected Commands
 

diff --git a/docs/core-plugins/eslint.md b/docs/core-plugins/eslint.md
@@ -1,6 +1,6 @@
 # @vue/cli-plugin-eslint
 
-> ESLint plugin for Vue CLI
+> eslint plugin for vue-cli
 
 ## Injected Commands
 

diff --git a/docs/core-plugins/pwa.md b/docs/core-plugins/pwa.md
@@ -1,6 +1,6 @@
 # @vue/cli-plugin-pwa
 
-> Progressive Web Application plugin for Vue CLI
+> pwa plugin for vue-cli
 
 The service worker added with this plugin is only enabled in the production environment (e.g. only if you run `npm run build` or `yarn build`). Enabling service worker in a development mode is not a recommended practice, because it can lead to the situation when previously cached assets are used and the latest local changes are not included.
 
@@ -10,7 +10,8 @@ If you need to test a service worker locally, build the application and run a si
 
 ## Configuration
 
-Configuration is handled via the `pwa` property of either the `vue.config.js` file, or the `"vue"` field in `package.json`.
+Configuration is handled via the `pwa` property of either the `vue.config.js`
+file, or the `"vue"` field in `package.json`.
 
 - **pwa.workboxPluginMode**
 
@@ -70,6 +71,19 @@ Configuration is handled via the `pwa` property of either the `vue.config.js` fi
 
     The path of app’s manifest.
 
+- **pwa.manifestOptions**
+
+  - Default: `{}`
+
+    The object will be used to generate the `manifest.json`
+
+    If the following attributes are not defined in the object, the options of `pwa` or default options will be used instead.
+      - name: `pwa.name`
+      - short_name: `pwa.name`
+      - start_url: `'.'`
+      - display: `'standalone'`
+      - theme_color: `pwa.themeColor`
+
 - **pwa.iconPaths**
 
   - Defaults:

diff --git a/docs/core-plugins/typescript.md b/docs/core-plugins/typescript.md
@@ -1,6 +1,6 @@
 # @vue/cli-plugin-typescript
 
-> TypeScript plugin for Vue CLI
+> 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.
 

diff --git a/docs/core-plugins/jest.md → docs/core-plugins/unit-jest.md b/docs/core-plugins/jest.md → docs/core-plugins/unit-jest.md
@@ -1,6 +1,6 @@
 # @vue/cli-plugin-unit-jest
 
-> unit-jest plugin for Vue CLI
+> unit-jest plugin for vue-cli
 
 ## Injected Commands
 

diff --git a/docs/core-plugins/mocha.md → docs/core-plugins/unit-mocha.md b/docs/core-plugins/mocha.md → docs/core-plugins/unit-mocha.md
@@ -1,6 +1,6 @@
 # @vue/cli-plugin-unit-mocha
 
-> unit-mocha plugin for Vue CLI
+> unit-mocha plugin for vue-cli
 
 ## Injected Commands
 

diff --git a/package.json b/package.json
@@ -17,7 +17,8 @@
     "version": "node scripts/genChangelog.js && git add CHANGELOG.md",
     "docs": "vuepress dev docs",
     "docs:build": "vuepress build docs",
-    "patch-chromedriver": "node scripts/patchChromedriver.js"
+    "patch-chromedriver": "node scripts/patchChromedriver.js",
+    "gen-docs": "node scripts/genDocs.js"
   },
   "gitHooks": {
     "pre-commit": "lint-staged",

diff --git a/scripts/genDocs.js b/scripts/genDocs.js
@@ -0,0 +1,18 @@
+const fs = require('fs')
+const path = require('path')
+
+const plugins = ['babel', 'e2e-cypress', 'e2e-nightwatch', 'eslint', 'pwa', 'typescript', 'unit-jest', 'unit-mocha']
+
+const genDocs = (module.exports = async () => {
+  plugins.forEach(plugin => {
+    const entryPath = path.resolve(__dirname, '../packages', '@vue', `cli-plugin-${plugin}`, 'README.md')
+    const entryContent = fs.readFileSync(entryPath)
+    const docPath = path.resolve(__dirname, '../docs', 'core-plugins', `${plugin}.md`)
+    fs.writeFile(docPath, entryContent, () => {})
+  })
+})
+
+genDocs().catch(err => {
+  console.error(err)
+  process.exit(1)
+})