@vuepress/core 1.4.0 → 1.5.2

package/lib/client/index.ssr.html

@@ -4,7 +4,6 @@
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <title>{{ title }}</title>
-    <meta name="description" content="{{ description }}">
     <meta name="generator" content="VuePress {{ version }}">
     {{{ userHeadTags }}}
     {{{ pageMeta }}}

package/lib/client/root-mixins/updateMeta.js

@@ -1,15 +1,26 @@
+import unionBy from 'lodash/unionBy'
+
 export default {
+  // created will be called on both client and ssr
   created () {
+    this.siteMeta = this.$site.headTags
+      .filter(([headerType]) => headerType === 'meta')
+      .map(([_, headerValue]) => headerValue)
+
     if (this.$ssrContext) {
+      const mergedMetaItems = this.getMergedMetaTags()
+
       this.$ssrContext.title = this.$title
       this.$ssrContext.lang = this.$lang
-      this.$ssrContext.description = this.$page.description || this.$description
+      this.$ssrContext.pageMeta = renderPageMeta(mergedMetaItems)
     }
   },
-
+  // Other life cycles will only be called at client
   mounted () {
+    // init currentMetaTags from DOM
+    this.currentMetaTags = [...document.querySelectorAll('meta')]
+
     // update title / meta tags
-    this.currentMetaTags = new Set()
     this.updateMeta()
   },
 
@@ -17,22 +28,17 @@ export default {
     updateMeta () {
       document.title = this.$title
       document.documentElement.lang = this.$lang
-      const userMeta = this.$page.frontmatter.meta || []
-      const meta = userMeta.slice(0)
-      const useGlobalDescription = userMeta.filter(m => m.name === 'description').length === 0
-
-      // #665 Avoid duplicate description meta at runtime.
-      if (useGlobalDescription) {
-        meta.push({ name: 'description', content: this.$description })
-      }
 
-      // Including description meta coming from SSR.
-      const descriptionMetas = document.querySelectorAll('meta[name="description"]')
-      if (descriptionMetas.length) {
-        descriptionMetas.forEach(m => this.currentMetaTags.add(m))
-      }
+      const newMetaTags = this.getMergedMetaTags()
+      this.currentMetaTags = updateMetaTags(newMetaTags, this.currentMetaTags)
+    },
 
-      this.currentMetaTags = new Set(updateMetaTags(meta, this.currentMetaTags))
+    getMergedMetaTags () {
+      const pageMeta = this.$page.frontmatter.meta || []
+      // pageMetaTags have higher priority than siteMetaTags
+      // description needs special attention as it has too many entries
+      return unionBy([{ name: 'description', content: this.$description }],
+        pageMeta, this.siteMeta, metaIdentifier)
     }
   },
 
@@ -47,14 +53,20 @@ export default {
   }
 }
 
-function updateMetaTags (meta, current) {
-  if (current) {
-    [...current].forEach(c => {
-      document.head.removeChild(c)
-    })
+/**
+ * Replace currentMetaTags with newMetaTags
+ * @param {Array<Object>} newMetaTags
+ * @param {Array<HTMLElement>} currentMetaTags
+ * @returns {Array<HTMLElement>}
+ */
+function updateMetaTags (newMetaTags, currentMetaTags) {
+  if (currentMetaTags) {
+    [...currentMetaTags]
+          .filter(c => c.parentNode === document.head)
+          .forEach(c => document.head.removeChild(c))
   }
-  if (meta) {
-    return meta.map(m => {
+  if (newMetaTags) {
+    return newMetaTags.map(m => {
       const tag = document.createElement('meta')
       Object.keys(m).forEach(key => {
         tag.setAttribute(key, m[key])
@@ -64,3 +76,35 @@ function updateMetaTags (meta, current) {
     })
   }
 }
+
+/**
+ * Try to identify a meta tag by name, property or itemprop
+ *
+ * Return a complete string if none provided
+ * @param {Object} tag from frontmatter or siteMetaTags
+ * @returns {String}
+ */
+function metaIdentifier (tag) {
+  for (const item of ['name', 'property', 'itemprop']) {
+    if (tag.hasOwnProperty(item)) return tag[item] + item
+  }
+  return JSON.stringify(tag)
+}
+
+/**
+ * Render meta tags
+ *
+ * @param {Array} meta
+ * @returns {String}
+ */
+
+function renderPageMeta (meta) {
+  if (!meta) return ''
+  return meta.map(m => {
+    let res = `<meta`
+    Object.keys(m).forEach(key => {
+      res += ` ${key}="${m[key]}"`
+    })
+    return res + `>`
+  }).join('\n    ')
+}

package/lib/node/App.js

@@ -438,6 +438,7 @@ module.exports = class App {
       title: this.siteConfig.title || '',
       description: this.siteConfig.description || '',
       base: this.base,
+      headTags: this.siteConfig.head || [],
       pages: this.pages.map(page => page.toJson()),
       themeConfig: this.siteConfig.themeConfig || {},
       locales
@@ -499,4 +500,3 @@ module.exports = class App {
     return this
   }
 }
-

package/lib/node/build/index.js

@@ -77,13 +77,15 @@ module.exports = class Build extends EventEmitter {
     })
 
     // pre-render head tags from user config
+    // filter out meta tags for they will be injected in updateMeta.js
     this.userHeadTags = (this.context.siteConfig.head || [])
+      .filter(([headTagType]) => headTagType !== 'meta')
       .map(renderHeadTag)
-      .join('\n  ')
+      .join('\n    ')
 
     // if the user does not have a custom 404.md, generate the theme's default
     if (!this.context.pages.some(p => p.path === '/404.html')) {
-      this.context.addPage({ path: '/404.html' })
+      await this.context.addPage({ path: '/404.html' })
     }
 
     // render pages
@@ -134,14 +136,9 @@ module.exports = class Build extends EventEmitter {
   async renderPage (page) {
     const pagePath = decodeURIComponent(page.path)
 
-    // #565 Avoid duplicate description meta at SSR.
-    const meta = (page.frontmatter && page.frontmatter.meta || []).filter(item => item.name !== 'description')
-    const pageMeta = renderPageMeta(meta)
-
     const context = {
       url: page.path,
       userHeadTags: this.userHeadTags,
-      pageMeta,
       title: 'VuePress',
       lang: 'en',
       description: '',
@@ -221,24 +218,6 @@ function renderAttrs (attrs = {}) {
   }
 }
 
-/**
- * Render meta tags
- *
- * @param {Array} meta
- * @returns {Array<string>}
- */
-
-function renderPageMeta (meta) {
-  if (!meta) return ''
-  return meta.map(m => {
-    let res = `<meta`
-    Object.keys(m).forEach(key => {
-      res += ` ${key}="${escape(m[key])}"`
-    })
-    return res + `>`
-  }).join('')
-}
-
 /**
  * find and remove empty style chunk caused by
  * https://github.com/webpack-contrib/mini-css-extract-plugin/issues/85

package/lib/node/dev/index.js

@@ -207,8 +207,12 @@ module.exports = class DevProcess extends EventEmitter {
       publicPath: this.context.base,
       watchOptions: {
         ignored: [
-          /node_modules/,
-          `!${this.context.tempPath}/**`
+          (x) => {
+            if (x.includes(this.context.tempPath)) {
+              return false
+            }
+            return /node_modules/.test(x)
+          }
         ]
       },
       historyApiFallback: {

package/lib/node/internal-plugins/style/client.js

@@ -1,2 +1,2 @@
 // generated from user config
-import('@temp/style.styl')
+import '@temp/style.styl'

package/lib/node/theme-api/index.js

@@ -131,7 +131,7 @@ function resolveSFCs (dirs) {
 /**
  * normalize component name
  *
- * @param {strin} filename
+ * @param {string} filename
  * @returns {string}
  */
 

package/lib/node/webpack/createBaseConfig.js

@@ -137,14 +137,16 @@ module.exports = function createBaseConfig (context, isServer) {
       .rule('js')
         .test(/\.jsx?$/)
         .exclude.add(filePath => {
-          // Always transpile lib directory
+          // transpile lib directory
           if (filePath.startsWith(libDir)) {
             return false
           }
-          // always transpile js in vue files and md files
+
+          // transpile js in vue files and md files
           if (/\.(vue|md)\.js$/.test(filePath)) {
             return false
           }
+
           // transpile all core packages and vuepress related packages.
           // i.e.
           // @vuepress/*
@@ -152,7 +154,13 @@ module.exports = function createBaseConfig (context, isServer) {
           if (/(@vuepress[\/\\][^\/\\]*|vuepress-[^\/\\]*)[\/\\](?!node_modules).*\.js$/.test(filePath)) {
             return false
           }
-          // Don't transpile node_modules
+
+          // transpile @babel/runtime until fix for babel/babel#7597 is released
+          if (filePath.includes(path.join('@babel', 'runtime'))) {
+            return false
+          }
+
+          // don't transpile node_modules
           return /node_modules/.test(filePath)
         }).end()
         .use('cache-loader')
@@ -171,7 +179,11 @@ module.exports = function createBaseConfig (context, isServer) {
             // ref: http://babeljs.io/docs/en/config-files
             configFile: false,
             presets: [
-              require.resolve('@vue/babel-preset-app')
+              [require.resolve('@vue/babel-preset-app'), {
+                entryFiles: [
+                  path.resolve(__dirname, '../../client', isServer ? 'serverEntry.js' : 'clientEntry.js')
+                ]
+              }]
             ]
           })
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/core",
-  "version": "1.4.0",
+  "version": "1.5.2",
   "description": "Minimalistic doc generator with Vue component based layout system",
   "keywords": [
     "documentation",
@@ -25,11 +25,11 @@
   "dependencies": {
     "@babel/core": "^7.8.4",
     "@vue/babel-preset-app": "^4.1.2",
-    "@vuepress/markdown": "^1.4.0",
-    "@vuepress/markdown-loader": "^1.4.0",
-    "@vuepress/plugin-last-updated": "^1.4.0",
-    "@vuepress/plugin-register-components": "^1.4.0",
-    "@vuepress/shared-utils": "^1.4.0",
+    "@vuepress/markdown": "1.5.2",
+    "@vuepress/markdown-loader": "1.5.2",
+    "@vuepress/plugin-last-updated": "1.5.2",
+    "@vuepress/plugin-register-components": "1.5.2",
+    "@vuepress/shared-utils": "1.5.2",
     "autoprefixer": "^9.5.1",
     "babel-loader": "^8.0.4",
     "cache-loader": "^3.0.0",
@@ -73,6 +73,5 @@
       "name": "ULIVZ",
       "email": "chl814@foxmail.com"
     }
-  ],
-  "gitHead": "58ed07f013b7f7768094e57314f993c39dc6750e"
+  ]
 }

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2018-present, Yuxi (Evan) You
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.