Merge branch 'next' of https://github.com/vuejs/vuepress into next

Author: ulivz

babel.config.js

@@ -2,7 +2,7 @@ module.exports = {
   'env': {
     'test': {
       'presets': [
-        ['@babel/preset-env', { 'targets': { 'node': 8 }}]
+        ['@babel/preset-env', { 'targets': { 'node': 'current' }}]
       ]
     }
   }

packages/@vuepress/core/__test__/app/Content.spec.js

@@ -0,0 +1,24 @@
+const AsyncOption = require('../../lib/plugin-api/abstract/AsyncOption')
+
+describe('AsyncOption', () => {
+  test('parallelApply', async () => {
+    const option = new AsyncOption('option')
+    const handler1 = jest.fn()
+    const handler2 = jest.fn()
+
+    option.add('plugin-a', handler1)
+    option.add('plugin-b', handler2)
+
+    // TODO for now, if a class extends from another class.
+    // the original methods in that class will be lost.
+
+    await option.parallelApply(1, 2)
+    // expect(handler1.mock.calls).toHaveLength(1)
+    // expect(handler2.mock.calls).toHaveLength(1)
+    // expect(handler1.mock.calls[0][0]).toBe(1)
+    // expect(handler1.mock.calls[0][1]).toBe(2)
+    // expect(handler2.mock.calls[0][0]).toBe(1)
+    // expect(handler2.mock.calls[0][1]).toBe(2)
+  })
+})
+

packages/@vuepress/core/__test__/plugin-api/AsyncOption.spec.js

@@ -1,66 +1,90 @@
-import Option from '../../lib/plugin-api/Option'
+import Option from '../../lib/plugin-api/abstract/Option'
 
 describe('Option', () => {
-  test('shoould option record the key', () => {
+  test('key', () => {
     const option = new Option('option')
     expect(option.key).toBe('option')
   })
 
-  test('should \'tap\' work', () => {
+  test('add', () => {
     const option = new Option('option')
-    option.tap('plugin-a', 'a')
-    option.tap('plugin-b', 'b')
+    option.add('plugin-a', 'a')
+    option.add('plugin-b', 'b')
+
     expect(option.items).toEqual([
       { value: 'a', name: 'plugin-a' },
       { value: 'b', name: 'plugin-b' }
     ])
+
     expect(option.values).toEqual(['a', 'b'])
   })
 
-  test('should \'tap\' resolve array value', () => {
+  test('add - resolve array', () => {
     const option = new Option('option')
-    option.tap('plugin-a', ['a-1', 'a-2'])
-    option.tap('plugin-b', 'b')
+    option.add('plugin-a', ['a-1', 'a-2'])
+    option.add('plugin-b', 'b')
+
     expect(option.items).toEqual([
       { value: 'a-1', name: 'plugin-a' },
       { value: 'a-2', name: 'plugin-a' },
       { value: 'b', name: 'plugin-b' }
     ])
-    expect(option.values).toEqual(['a-1', 'a-2', 'b'])
   })
 
-  test('should \'apply\' work', async () => {
+  test('delete', () => {
     const option = new Option('option')
-    const handler1 = jest.fn()
-    const handler2 = jest.fn()
+    option.add('plugin-a', ['a-1', 'a-2'])
+    option.add('plugin-b', 'b')
 
-    option.tap('plugin-a', handler1)
-    option.tap('plugin-b', handler2)
+    option.delete('plugin-a')
 
-    await option.apply(1, 2)
-    expect(handler1.mock.calls).toHaveLength(1)
-    expect(handler2.mock.calls).toHaveLength(1)
-    expect(handler1.mock.calls[0][0]).toBe(1)
-    expect(handler1.mock.calls[0][1]).toBe(2)
-    expect(handler2.mock.calls[0][0]).toBe(1)
-    expect(handler2.mock.calls[0][1]).toBe(2)
+    expect(option.items).toEqual([
+      { value: 'b', name: 'plugin-b' }
+    ])
+  })
+
+  test('clear', () => {
+    const option = new Option('option')
+    option.add('plugin-a', ['a-1', 'a-2'])
+
+    option.clear()
+
+    expect(option.items).toEqual([])
   })
 
-  test('should \'parallelApply\' work', async () => {
+  test('syncApply', () => {
     const option = new Option('option')
     const handler1 = jest.fn()
     const handler2 = jest.fn()
 
-    option.tap('plugin-a', handler1)
-    option.tap('plugin-b', handler2)
+    option.add('plugin-a', handler1)
+    option.add('plugin-b', handler2)
 
-    await option.parallelApply(1, 2)
+    option.syncApply('p1', 'p2')
     expect(handler1.mock.calls).toHaveLength(1)
     expect(handler2.mock.calls).toHaveLength(1)
-    expect(handler1.mock.calls[0][0]).toBe(1)
-    expect(handler1.mock.calls[0][1]).toBe(2)
-    expect(handler2.mock.calls[0][0]).toBe(1)
-    expect(handler2.mock.calls[0][1]).toBe(2)
+    expect(handler1.mock.calls[0][0]).toBe('p1')
+    expect(handler1.mock.calls[0][1]).toBe('p2')
+    expect(handler2.mock.calls[0][0]).toBe('p1')
+    expect(handler2.mock.calls[0][1]).toBe('p2')
+  })
+
+  test('appliedItems', () => {
+    const option = new Option('option')
+    const fn1 = () => 'fn1'
+    const fn2 = () => 'fn2'
+    const handler1 = jest.fn(fn1)
+    const handler2 = jest.fn(fn2)
+
+    option.add('plugin-a', handler1)
+    option.add('plugin-b', handler2)
+
+    option.syncApply(1, 2)
+
+    expect(option.appliedItems).toEqual([
+      { value: 'fn1', name: 'plugin-a' },
+      { value: 'fn2', name: 'plugin-b' }
+    ])
   })
 })
 

packages/@vuepress/core/__test__/plugin-api/Option.spec.js

@@ -6,15 +6,15 @@ import PluginAPI from '../../lib/plugin-api/index'
 import { PLUGIN_OPTION_MAP } from '../../lib/plugin-api/constants'
 
 describe('Plugin', () => {
-  test('should \'registerOption\' work.', () => {
+  test('registerOption', () => {
     const api = new PluginAPI()
     const readyHandler = () => {}
     api.registerOption(PLUGIN_OPTION_MAP.READY.key, readyHandler)
     expect(api.options.ready.values).toHaveLength(1)
     expect(api.options.ready.values[0]).toBe(readyHandler)
   })
 
-  test('should \'useByPluginsConfig\' work.', () => {
+  test('useByPluginsConfig', () => {
     [
       ['a'],
       [['a']],
@@ -29,7 +29,7 @@ describe('Plugin', () => {
     })
   })
 
-  test('should \'useByPluginsConfig\' work. - disable plugin', () => {
+  test('useByPluginsConfig - disable plugin', () => {
     [
       [['a', false]],
       { a: false }
@@ -42,7 +42,7 @@ describe('Plugin', () => {
     })
   })
 
-  test('should \'useByPluginsConfig\' work. - get options', () => {
+  test('useByPluginsConfig - get options', () => {
     const pluginOptions = {};
     [
       [['a', pluginOptions]],
@@ -54,7 +54,7 @@ describe('Plugin', () => {
     })
   })
 
-  test('make sure the namesake plugin is only executed once.', () => {
+  test('ensure the namesake plugin is only executed once.', () => {
     const pluginOptions1 = {}
     const pluginOptions2 = {}
     const pluginOptions3 = {}
@@ -70,7 +70,7 @@ describe('Plugin', () => {
     expect(api.enabledPlugins[0].$$options).toBe(pluginOptions3)
   })
 
-  test('a "multuple" plugin can be applied multuple times.', () => {
+  test('ensure a "multuple" plugin can be applied multuple times.', () => {
     const pluginOptions1 = { a: 1 }
     const pluginOptions2 = { b: 1 }
     const pluginsConfig = [

packages/@vuepress/core/__test__/plugin-api/PluginAPI.spec.js

@@ -1,29 +1,29 @@
-import { hydratePlugin } from '../../lib/plugin-api/util'
+import { flattenPlugin } from '../../lib/plugin-api/util'
 
-describe('hydratePlugin', () => {
+describe('flattenPlugin', () => {
   test('shoould hydrate plugin correctly', () => {
-    const plugin = { name: 'a', shortcut: 'a', config: { enhanceAppFiles: 'file' }}
-    const hydratedPlugin = hydratePlugin(plugin, {}, {})
+    const plugin = { name: 'a', shortcut: 'a', module: { enhanceAppFiles: 'file' }}
+    const hydratedPlugin = flattenPlugin(plugin, {}, {})
     expect(hydratedPlugin.name).toBe('a')
     expect(hydratedPlugin.shortcut).toBe('a')
     expect(hydratedPlugin.enabled).toBe(true)
     expect(hydratedPlugin.enhanceAppFiles).toBe('file')
   })
 
   test('shoould set \'enabled\' to false when \'pluginOptions\' is set to false.', () => {
-    const plugin = { name: 'a', shortcut: 'a', config: {}}
-    const hydratedPlugin = hydratePlugin(plugin, false, {})
+    const plugin = { name: 'a', shortcut: 'a', module: {}}
+    const hydratedPlugin = flattenPlugin(plugin, false, {})
     expect(hydratedPlugin.name).toBe('a')
     expect(hydratedPlugin.shortcut).toBe('a')
     expect(hydratedPlugin.enabled).toBe(false)
   })
 
-  test('shoould hydrate functional plugin correctly.', () => {
+  test('shoould flatten functional plugin correctly.', () => {
     const config = jest.fn(() => ({ enhanceAppFiles: 'file' }))
-    const plugin = { name: 'a', shortcut: 'a', config }
+    const plugin = { name: 'a', shortcut: 'a', module: config }
     const pluginOptions = {}
     const pluginContext = {}
-    const hydratedPlugin = hydratePlugin(plugin, pluginOptions, pluginContext)
+    const hydratedPlugin = flattenPlugin(plugin, pluginOptions, pluginContext)
     expect(hydratedPlugin.name).toBe('a')
     expect(hydratedPlugin.shortcut).toBe('a')
     expect(hydratedPlugin.enabled).toBe(true)
@@ -33,12 +33,12 @@ describe('hydratePlugin', () => {
     expect(Object.getPrototypeOf(config.mock.calls[0][1])).toBe(pluginContext)
   })
 
-  test('shoould hydrate functional plugin correctly - options defaults to \'{}\'.', () => {
+  test('shoould flatten functional plugin correctly - options defaults to \'{}\'.', () => {
     const config = jest.fn(() => ({ enhanceAppFiles: 'file' }))
-    const plugin = { name: 'a', shortcut: 'a', config }
+    const plugin = { name: 'a', shortcut: 'a', module: config }
     const pluginOptions = undefined
     const pluginContext = {}
-    hydratePlugin(plugin, pluginOptions, pluginContext)
+    flattenPlugin(plugin, pluginOptions, pluginContext)
     expect(config.mock.calls[0][0]).toEqual({})
     expect(Object.getPrototypeOf(config.mock.calls[0][1])).toBe(pluginContext)
   })

packages/@vuepress/core/__test__/plugin-api/PluginUtil.spec.js

@@ -0,0 +1,21 @@
+const { fs } = require('@vuepress/shared-utils')
+const path = require('path')
+const prepare = require('../../lib/prepare')
+
+const docsBaseDir = path.resolve(__dirname, 'fixtures')
+const docsModeNames = fs.readdirSync(docsBaseDir)
+const docsModes = docsModeNames.map(name => {
+  const docsPath = path.resolve(docsBaseDir, name)
+  const docsTempPath = path.resolve(docsPath, '.vuepress/.temp')
+  return { name, docsPath, docsTempPath }
+})
+
+describe('prepare', () => {
+  test('should not throw error', async () => {
+    await Promise.all(docsModes.map(async ({ name, docsPath, docsTempPath }) => {
+      await fs.ensureDir(docsTempPath)
+      const context = await prepare(docsPath, { theme: '@vuepress/default', temp: docsTempPath })
+      expect(context.sourceDir).toBe(docsPath)
+    }))
+  })
+})

packages/@vuepress/test-utils/fixtures/docs-i18n/.vuepress/config.js renamed to packages/@vuepress/core/__test__/prepare/fixtures/docs-i18n/.vuepress/config.js

@@ -0,0 +1,19 @@
+import Vue from 'vue'
+
+export default class Store {
+  constructor () {
+    this.store = new Vue({
+      data: {
+        ob: {}
+      }
+    })
+  }
+
+  get (key) {
+    return this.store.ob[key]
+  }
+
+  set (key, value) {
+    Vue.set(this.store.ob, key, value)
+  }
+}

packages/@vuepress/test-utils/fixtures/docs-i18n/README.md renamed to packages/@vuepress/core/__test__/prepare/fixtures/docs-i18n/README.md

@@ -6,7 +6,8 @@ import { routes } from '@internal/routes'
 import { siteData } from '@internal/siteData'
 import appEnhancers from '@internal/app-enhancers'
 import globalUIComponents from '@internal/global-ui'
-import I18n from '@internal/i18n'
+import ClientComputedMixin from '../prepare/ClientComputedMixin'
+import Store from './Store'
 
 // generated from user config
 import('@temp/style.styl')
@@ -30,9 +31,12 @@ if (module.hot) {
 }
 
 Vue.config.productionTip = false
+
+Vue.$store = new Store()
+
 Vue.use(Router)
 // mixin for exposing $site and $page
-Vue.mixin(dataMixin(I18n, siteData))
+Vue.mixin(dataMixin(ClientComputedMixin, siteData))
 // component for rendering markdown content and setting title etc.
 Vue.component('Content', Content)
 Vue.component('OutboundLink', OutboundLink)
@@ -59,7 +63,7 @@ export function createApp (isServer) {
       if (saved) {
         return saved
       } else if (to.hash) {
-        if (Vue.$store.disableScrollBehavior) {
+        if (Vue.$store.get('disableScrollBehavior')) {
           return false
         }
         return {

packages/@vuepress/test-utils/fixtures/docs-i18n/zh/README.md renamed to packages/@vuepress/core/__test__/prepare/fixtures/docs-i18n/zh/README.md

@@ -4,22 +4,16 @@ import Vue from 'vue'
 
 export default function dataMixin (I18n, siteData) {
   prepare(siteData)
-  const store = new Vue({
-    data: {
-      siteData,
-      disableScrollBehavior: false
-    }
-  })
-  Vue.$store = store
+  Vue.$store.set('siteData', siteData)
 
   if (module.hot) {
     module.hot.accept(VUEPRESS_TEMP_PATH + '/internal/siteData.js', () => {
       prepare(siteData)
-      store.siteData = siteData
+      Vue.$store.set('siteData', siteData)
     })
   }
 
-  const I18nConstructor = I18n(store)
+  const I18nConstructor = I18n(Vue.$store.get('siteData'))
   const i18n = new I18nConstructor()
   const descriptors = Object.getOwnPropertyDescriptors(Object.getPrototypeOf(i18n))
   const computed = {}