⚡ improvement(docs): add cli service docs:serve alias command

kazupon · Jan 31, 2019 · 59b2b2b · 59b2b2b
1 parent b7e3251
commit 59b2b2b
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/generator/index.js b/generator/index.js
@@ -18,7 +18,8 @@ module.exports = (api, options, rootOptions) => {
   api.extendPackage({
     scripts: {
       'demo': 'vue-cli-service demo',
-      'docs:serve': 'vue-cli-service docs --mode dev',
+      'docs': 'npm run docs:serve',
+      'docs:serve': 'vue-cli-service docs --mode serve',
       'docs:build': 'vue-cli-service docs --mode build'
     },
     sideeffects: false,

diff --git a/lib/docs/command.js b/lib/docs/command.js
@@ -10,6 +10,9 @@ module.exports = api => ({
     }
   },
   fn: async args => {
+    if (!args.mode || args.mode !== 'build') {
+      args.mode = 'dev'
+    }
     args.mode = args.mode || 'serve'
     const bin = require.resolve(path.join(api.getCwd(), './node_modules/.bin/vuepress'))
     return service(bin, args)

diff --git a/tests/unit/commands/docs.spec.js b/tests/unit/commands/docs.spec.js
@@ -23,7 +23,7 @@ test('docs default', () => {
 
   const calls = docsService.mock.calls
   expect(calls[0][0]).toMatch(`${process.cwd()}/node_modules/vuepress/cli.js`)
-  expect(calls[0][1]).toEqual({ _: [], mode: 'serve' })
+  expect(calls[0][1]).toEqual({ _: [], mode: 'dev' })
 })
 
 test('docs serve', () => {
@@ -39,7 +39,7 @@ test('docs serve', () => {
   service.run('docs', { mode: 'serve' })
 
   const calls = docsService.mock.calls
-  expect(calls[0][1]).toEqual({ _: [], mode: 'serve' })
+  expect(calls[0][1]).toEqual({ _: [], mode: 'dev' })
 })
 
 test('docs build', () => {

diff --git a/tests/unit/generators/docs.spec.js b/tests/unit/generators/docs.spec.js
@@ -29,7 +29,8 @@ test('docs', async () => {
   }])
 
   // check pkg
-  expect(pkg.scripts['docs:serve']).toMatch('vue-cli-service docs --mode dev')
+  expect(pkg.scripts['docs']).toMatch('npm run docs:serve')
+  expect(pkg.scripts['docs:serve']).toMatch('vue-cli-service docs --mode serve')
   expect(pkg.scripts['docs:build']).toMatch('vue-cli-service docs --mode build')
 
   // check files