feat: enhancement and make it work

ulivz · ulivz · commit fe266e2b907b · 2019-02-21T01:20:30.000+08:00
diff --git a/packages/@vuepress/core/__tests__/theme-api/index.spec.js b/packages/@vuepress/core/__tests__/theme-api/index.spec.js
@@ -21,7 +21,7 @@ const parent = {
 describe('ThemeAPI', () => {
   test('extend', async () => {
     const themeAPI = new ThemeAPI(theme, parent)
-    console.log(themeAPI.theme.entryFile)
+    console.log(themeAPI.theme.entry)
   })
   // loadTheme('vuepress-theme-child')
 })
diff --git a/packages/@vuepress/core/lib/internal-plugins/enhanceApp.js b/packages/@vuepress/core/lib/internal-plugins/enhanceApp.js
@@ -6,13 +6,13 @@ module.exports = (options, context) => ({
   enhanceAppFiles () {
     const { sourceDir, themeAPI } = context
     const enhanceAppPath = path.resolve(sourceDir, '.vuepress/enhanceApp.js')
-    const themeEnhanceAppPath = path.resolve(themeAPI.themePath, 'enhanceApp.js')
+    const themeEnhanceAppPath = path.resolve(themeAPI.theme.path, 'enhanceApp.js')
     const files = [
       enhanceAppPath,
       themeEnhanceAppPath
     ]
     if (themeAPI.existsParentTheme) {
-      files.push(path.resolve(themeAPI.parentThemePath, 'enhanceApp.js'))
+      files.push(path.resolve(themeAPI.parentTheme.path, 'enhanceApp.js'))
     }
     return files
   }
diff --git a/packages/@vuepress/core/lib/internal-plugins/layoutComponents.js b/packages/@vuepress/core/lib/internal-plugins/layoutComponents.js
@@ -1,22 +1,13 @@
 module.exports = (options, ctx) => {
-  const { layoutComponentMap } = ctx
-  const componentNames = Object.keys(layoutComponentMap)
-
   return {
     name: '@vuepress/internal-layout-components',
 
     async clientDynamicModules () {
+      const componentNames = Object.keys(ctx.themeAPI.layoutComponentMap)
       const code = `export default {\n${componentNames
-        .map(name => `  ${JSON.stringify(name)}: () => import(${JSON.stringify(layoutComponentMap[name].path)})`)
+        .map(name => `  ${JSON.stringify(name)}: () => import(${JSON.stringify(ctx.themeAPI.layoutComponentMap[name].path)})`)
         .join(',\n')} \n}`
       return { name: 'layout-components.js', content: code, dirname: 'internal' }
-    },
-
-    chainWebpack (config, isServer) {
-      const setAlias = (alias, raw) => config.resolve.alias.set(alias, raw)
-      componentNames.forEach(name => {
-        setAlias(`@${name}`, layoutComponentMap[name].path)
-      })
     }
   }
 }
diff --git a/packages/@vuepress/core/lib/internal-plugins/palette/index.js b/packages/@vuepress/core/lib/internal-plugins/palette/index.js
@@ -20,7 +20,7 @@ module.exports = (options, ctx) => ({
     // 2. write palette.styl
     const { sourceDir, writeTemp } = ctx
 
-    const themePalette = path.resolve(ctx.themePath, 'styles/palette.styl')
+    const themePalette = path.resolve(ctx.themeAPI.theme.path, 'styles/palette.styl')
     const userPalette = path.resolve(sourceDir, '.vuepress/styles/palette.styl')
 
     const themePaletteContent = fs.existsSync(themePalette)
@@ -34,8 +34,8 @@ module.exports = (options, ctx) => ({
     // user's palette can override theme's palette.
     let paletteContent = themePaletteContent + userPaletteContent
 
-    if (ctx.parentThemePath) {
-      const parentThemePalette = path.resolve(ctx.parentThemePath, 'styles/palette.styl')
+    if (ctx.themeAPI.existsParentTheme) {
+      const parentThemePalette = path.resolve(ctx.themeAPI.parentTheme.path, 'styles/palette.styl')
       const parentThemePaletteContent = fs.existsSync(parentThemePalette)
         ? `@import(${JSON.stringify(parentThemePalette.replace(/[\\]+/g, '/'))})`
         : ''
diff --git a/packages/@vuepress/core/lib/internal-plugins/style/index.js b/packages/@vuepress/core/lib/internal-plugins/style/index.js
@@ -1,5 +1,9 @@
 const { fs, path, logger, chalk } = require('@vuepress/shared-utils')
 
+/**
+ * @param options
+ * @param {AppContext} ctx
+ */
 module.exports = (options, ctx) => ({
   name: '@vuepress/internal-style',
 
@@ -15,7 +19,7 @@ module.exports = (options, ctx) => ({
       logger.tip(`${chalk.magenta('override.styl')} has been deprecated from v1.0.0, using ${chalk.cyan('.vuepress/styles/palette.styl')} instead.\n`)
     }
 
-    const themeStyle = path.resolve(themeAPI.themePath, 'styles/index.styl')
+    const themeStyle = path.resolve(themeAPI.theme.path, 'styles/index.styl')
     const userStyle = path.resolve(sourceDir, '.vuepress/styles/index.styl')
 
     const themeStyleContent = fs.existsSync(themeStyle)
@@ -29,7 +33,7 @@ module.exports = (options, ctx) => ({
     let styleContent = themeStyleContent + userStyleContent
 
     if (themeAPI.existsParentTheme) {
-      const parentThemeStyle = path.resolve(themeAPI.parentThemePath, 'styles/index.styl')
+      const parentThemeStyle = path.resolve(themeAPI.parentTheme.path, 'styles/index.styl')
       const parentThemeStyleContent = fs.existsSync(parentThemeStyle)
         ? `@import(${JSON.stringify(parentThemeStyle.replace(/[\\]+/g, '/'))})`
         : ''
diff --git a/packages/@vuepress/core/lib/prepare/AppContext.js b/packages/@vuepress/core/lib/prepare/AppContext.js
@@ -94,9 +94,6 @@ module.exports = class AppContext {
     this.resolveConfigAndInitialize()
     this.resolveCacheLoaderOptions()
     this.normalizeHeadTagUrls()
-    /**
-     * @type {ThemeAPI}
-     */
     this.themeAPI = loadTheme(this)
     this.resolveTemplates()
     this.resolveGlobalLayout()
@@ -156,8 +153,8 @@ module.exports = class AppContext {
       .use('@vuepress/register-components', {
         componentsDir: [
           path.resolve(this.sourceDir, '.vuepress/components'),
-          path.resolve(this.themeAPI.themePath, 'global-components'),
-          this.themeAPI.existsParentTheme && path.resolve(this.themeAPI.parentThemePath, 'global-components')
+          path.resolve(this.themeAPI.theme.path, 'global-components'),
+          this.themeAPI.existsParentTheme && path.resolve(this.themeAPI.parentTheme.path, 'global-components')
         ]
       })
   }
@@ -171,10 +168,11 @@ module.exports = class AppContext {
   applyUserPlugins () {
     this.pluginAPI.useByPluginsConfig(this.cliOptions.plugins)
     if (this.themeAPI.existsParentTheme) {
-      this.pluginAPI.use(this.themeAPI.parentThemePath)
+      this.pluginAPI.use(this.themeAPI.parentTheme.entry)
     }
     this.pluginAPI
-      .use(this.themeAPI.themePath)
+      .use(this.themeAPI.theme.entry)
+      .use(this.themeAPI.vuepressPlugin)
       .use(Object.assign({}, this.siteConfig, { name: '@vuepress/internal-site-config' }))
   }
 
@@ -224,41 +222,26 @@ module.exports = class AppContext {
    */
 
   resolveTemplates () {
-    const { siteSsrTemplate, siteDevTemplate } = this.siteConfig
-
-    const templateDir = path.resolve(this.vuepressDir, 'templates')
-    const siteSsrTemplate2 = path.resolve(templateDir, 'ssr.html')
-    const siteDevTemplate2 = path.resolve(templateDir, 'dev.html')
-
-    const themeSsrTemplate = path.resolve(this.themeAPI.themePath, 'templates/ssr.html')
-    const themeDevTemplate = path.resolve(this.themeAPI.themePath, 'templates/dev.html')
-
-    const parentThemeSsrTemplate = path.resolve(this.themeAPI.parentThemePath, 'templates/ssr.html')
-    const parentThemeDevTemplate = path.resolve(this.themeAPI.parentThemePath, 'templates/dev.html')
-
-    const defaultSsrTemplate = path.resolve(__dirname, '../app/index.ssr.html')
-    const defaultDevTemplate = path.resolve(__dirname, '../app/index.dev.html')
-
-    const ssrTemplate = fsExistsFallback([
-      siteSsrTemplate,
-      siteSsrTemplate2,
-      themeSsrTemplate,
-      parentThemeSsrTemplate,
-      defaultSsrTemplate
-    ])
+    this.devTemplate = this.resolveCommonAgreementFilePath(
+      'devTemplate',
+      {
+        defaultValue: path.resolve(__dirname, '../app/index.dev.html'),
+        siteAgreement: 'templates/dev.html',
+        themeAgreement: 'templates/dev.html'
+      }
+    )
 
-    const devTemplate = fsExistsFallback([
-      siteDevTemplate,
-      siteDevTemplate2,
-      themeDevTemplate,
-      parentThemeDevTemplate,
-      defaultDevTemplate
-    ])
+    this.ssrTemplate = this.resolveCommonAgreementFilePath(
+      'ssrTemplate',
+      {
+        defaultValue: path.resolve(__dirname, '../app/index.ssr.html'),
+        siteAgreement: 'templates/ssr.html',
+        themeAgreement: 'templates/ssr.html'
+      }
+    )
 
-    logger.debug('SSR Template File: ' + chalk.gray(ssrTemplate))
-    logger.debug('DEV Template File: ' + chalk.gray(devTemplate))
-    this.devTemplate = devTemplate
-    this.ssrTemplate = ssrTemplate
+    logger.debug('SSR Template File: ' + chalk.gray(this.ssrTemplate))
+    logger.debug('DEV Template File: ' + chalk.gray(this.devTemplate))
   }
 
   /**
@@ -366,7 +349,8 @@ module.exports = class AppContext {
    */
 
   getThemeConfigValue (key) {
-    return this.themeEntryFile[key] || this.parentThemeEntryFile[key]
+    return this.themeAPI.theme.entry[key]
+      || this.themeAPI.existsParentTheme && this.themeAPI.parentTheme.entry[key]
   }
 
   /**
@@ -378,12 +362,12 @@ module.exports = class AppContext {
    */
 
   resolveThemeAgreementFile (filepath) {
-    const current = path.resolve(this.themeAPI.themePath, filepath)
+    const current = path.resolve(this.themeAPI.theme.path, filepath)
     if (fs.existsSync(current)) {
       return current
     }
     if (this.themeAPI.existsParentTheme) {
-      const parent = path.resolve(this.themeAPI.parentThemePath, filepath)
+      const parent = path.resolve(this.themeAPI.theme.path, filepath)
       if (fs.existsSync(parent)) {
         return parent
       }
diff --git a/packages/@vuepress/core/lib/prepare/loadTheme.js b/packages/@vuepress/core/lib/prepare/loadTheme.js
@@ -33,16 +33,16 @@ const ThemeAPI = require('../theme-api')
 module.exports = function loadTheme (ctx) {
   const themeResolver = getThemeResolver()
 
-  const theme = resolveTheme(themeResolver, ctx)
+  const theme = resolveTheme(ctx, themeResolver)
   if (!theme.path) {
     throw new Error(`[vuepress] You must specify a theme, or create a local custom theme. \n For more details, refer to https://vuepress.vuejs.org/guide/custom-themes.html#custom-themes. \n`)
   }
-  theme.entryFile.name = '@vuepress/internal-theme-entry-file'
+  theme.entry.name = '@vuepress/internal-theme-entry-file'
 
   let parentTheme = {}
-  if (theme.entryFile.extend) {
-    parentTheme = resolveTheme(themeResolver, ctx, true, theme.entryFile.extend)
-    parentTheme.entryFile.name = '@vuepress/internal-parent-theme-entry-file'
+  if (theme.entry.extend) {
+    parentTheme = resolveTheme(ctx, themeResolver, true, theme.entry.extend)
+    parentTheme.entry.name = '@vuepress/internal-parent-theme-entry-file'
   }
 
   return new ThemeAPI(theme, parentTheme, ctx)
@@ -63,12 +63,12 @@ function normalizeThemePath (resolved) {
 function resolveTheme (ctx, resolver, ignoreLocal, theme) {
   const { siteConfig, cliOptions, sourceDir, vuepressDir, pluginAPI } = ctx
   const localThemePath = resolve(vuepressDir, 'theme')
-  theme = siteConfig.theme || cliOptions.theme
+  theme = theme || siteConfig.theme || cliOptions.theme
 
   let path
   let name
   let shortcut
-  let entryFile = {}
+  let entry = {}
 
   // 1. From local
   if (!ignoreLocal
@@ -95,10 +95,10 @@ function resolveTheme (ctx, resolver, ignoreLocal, theme) {
   }
 
   try {
-    entryFile = pluginAPI.normalizePlugin(path, ctx.themeConfig)
+    entry = pluginAPI.normalizePlugin(path, ctx.themeConfig)
   } catch (error) {
-    entryFile = {}
+    entry = {}
   }
 
-  return { path, name, shortcut, entryFile }
+  return { path, name, shortcut, entry }
 }
diff --git a/packages/@vuepress/core/lib/theme-api/index.js b/packages/@vuepress/core/lib/theme-api/index.js
@@ -2,34 +2,28 @@ const { logger, fs, path: { resolve }} = require('@vuepress/shared-utils')
 const readdirSync = dir => fs.existsSync(dir) && fs.readdirSync(dir) || []
 
 module.exports = class ThemeAPI {
-  constructor (theme, parentTheme, ctx) {
+  constructor (theme, parentTheme) {
     this.theme = theme
     this.parentTheme = parentTheme || {}
-    this.ctx = ctx
     this.existsParentTheme = !!this.parentTheme.path
+    this.vuepressPlugin = {
+      name: '@vuepress/internal-theme-api',
+      alias: {}
+    }
     this.init()
   }
 
   setAlias (alias) {
-    this.theme.entryFile.alias = {
-      ...(this.theme.entryFile.alias || {}),
-      alias
+    this.vuepressPlugin.alias = {
+      ...this.vuepressPlugin.alias,
+      ...alias
     }
   }
 
-  get themePath () {
-    return this.theme.path
-  }
-
-  get parentThemePath () {
-    return this.parentTheme.path
-  }
-
   init () {
     const alias = {
       '@current-theme': this.theme.path
     }
-    this.setAlias()
     if (this.existsParentTheme) {
       alias['@parent-theme'] = this.parentTheme.path
     }
@@ -101,6 +95,13 @@ module.exports = class ThemeAPI {
   }
 }
 
+/**
+ * Resolve Vue SFCs, return a Map
+ *
+ * @param dirs
+ * @returns {*}
+ */
+
 function resolveSFCs (dirs) {
   return dirs.map(
     layoutDir => readdirSync(layoutDir)
@@ -125,9 +126,11 @@ function resolveSFCs (dirs) {
 
 /**
  * normalize component name
+ *
  * @param {strin} filename
  * @returns {string}
  */
+
 function getComponentName (filename) {
   filename = filename.slice(0, -4)
   if (filename === '404') {
@@ -136,6 +139,13 @@ function getComponentName (filename) {
   return filename
 }
 
+/**
+ * Whether it's agreed layout component
+ *
+ * @param name
+ * @returns {boolean}
+ */
+
 function isInternal (name) {
   return name === 'Layout' || name === 'NotFound'
 }
diff --git a/packages/@vuepress/theme-default/components/DropdownLink.vue b/packages/@vuepress/theme-default/components/DropdownLink.vue
@@ -51,7 +51,7 @@
 
 <script>
 import NavLink from '@theme/components/NavLink.vue'
-import DropdownTransition from './DropdownTransition.vue'
+import DropdownTransition from '@theme/components/DropdownTransition.vue'
 
 export default {
   components: { NavLink, DropdownTransition },
diff --git a/packages/@vuepress/theme-default/components/Home.vue b/packages/@vuepress/theme-default/components/Home.vue
@@ -50,7 +50,7 @@
 </template>
 
 <script>
-import NavLink from './NavLink.vue'
+import NavLink from '@theme/components/NavLink.vue'
 
 export default {
   components: { NavLink },
diff --git a/packages/@vuepress/theme-default/components/NavLinks.vue b/packages/@vuepress/theme-default/components/NavLinks.vue
@@ -34,9 +34,9 @@
 </template>
 
 <script>
-import DropdownLink from './DropdownLink.vue'
+import DropdownLink from '@theme/components/DropdownLink.vue'
 import { resolveNavLinkItem } from '../util'
-import NavLink from './NavLink.vue'
+import NavLink from '@theme/components/NavLink.vue'
 
 export default {
   components: { NavLink, DropdownLink },
diff --git a/packages/@vuepress/theme-default/components/Navbar.vue b/packages/@vuepress/theme-default/components/Navbar.vue
@@ -37,10 +37,10 @@
 </template>
 
 <script>
-import SidebarButton from './SidebarButton.vue'
 import AlgoliaSearchBox from '@AlgoliaSearchBox'
 import SearchBox from '@SearchBox'
-import NavLinks from './NavLinks.vue'
+import SidebarButton from '@theme/components/SidebarButton.vue'
+import NavLinks from '@theme/components/NavLinks.vue'
 
 export default {
   components: { SidebarButton, NavLinks, SearchBox, AlgoliaSearchBox },
diff --git a/packages/@vuepress/theme-default/components/Sidebar.vue b/packages/@vuepress/theme-default/components/Sidebar.vue
diff --git a/packages/@vuepress/theme-default/components/SidebarGroup.vue b/packages/@vuepress/theme-default/components/SidebarGroup.vue
diff --git a/packages/@vuepress/theme-default/components/SidebarLinks.vue b/packages/@vuepress/theme-default/components/SidebarLinks.vue
diff --git a/packages/@vuepress/theme-default/layouts/Layout.vue b/packages/@vuepress/theme-default/layouts/Layout.vue
diff --git a/packages/@vuepress/theme-vue/components/Home.vue b/packages/@vuepress/theme-vue/components/Home.vue
diff --git a/packages/@vuepress/theme-vue/layouts/Layout.vue b/packages/@vuepress/theme-vue/layouts/Layout.vue

Original file line number	Diff line number	Diff line change
`@@ -6,13 +6,13 @@ module.exports = (options, context) => ({`
`6`	`6`	`enhanceAppFiles () {`
`7`	`7`	`const { sourceDir, themeAPI } = context`
`8`	`8`	`const enhanceAppPath = path.resolve(sourceDir, '.vuepress/enhanceApp.js')`
`9`		`- const themeEnhanceAppPath = path.resolve(themeAPI.themePath, 'enhanceApp.js')`
	`9`	`+ const themeEnhanceAppPath = path.resolve(themeAPI.theme.path, 'enhanceApp.js')`
`10`	`10`	`const files = [`
`11`	`11`	`enhanceAppPath,`
`12`	`12`	`themeEnhanceAppPath`
`13`	`13`	`]`
`14`	`14`	`if (themeAPI.existsParentTheme) {`
`15`		`- files.push(path.resolve(themeAPI.parentThemePath, 'enhanceApp.js'))`
	`15`	`+ files.push(path.resolve(themeAPI.parentTheme.path, 'enhanceApp.js'))`
`16`	`16`	`}`
`17`	`17`	`return files`
`18`	`18`	`}`