Merge remote-tracking branch 'upstream/master'

Author: shigma

.eslintrc.js

@@ -6,6 +6,7 @@ module.exports = {
   ],
   rules: {
     indent: ['error', 2, { MemberExpression: 'off' }],
-    "no-undef": ["error"]
+    "no-undef": ["error"],
+    'operator-linebreak': ["error", "before"]
   }
 }

CHANGELOG.md

@@ -1,3 +1,53 @@
+
+<a name="1.0.0-alpha.37"></a>
+# [1.0.0-alpha.37](https://github.com/vuejs/vuepress/compare/v1.0.0-alpha.36...v1.0.0-alpha.37) (2019-02-08)
+
+
+### Features
+
+* **$core:** redirects for clean urls ([#1269](https://github.com/vuejs/vuepress/issues/1269)) ([213bb34](https://github.com/vuejs/vuepress/commit/213bb34))
+* **$theme-default:** fallback current group node to page node if children doesn't exist ([11ce576](https://github.com/vuejs/vuepress/commit/11ce576))
+* **$theme-default:** highlight sidebar link text at root level like sidebar group heading text ([05e793f](https://github.com/vuejs/vuepress/commit/05e793f))
+* **$theme-default:** unify the text color of sidebar heading text and root-level sidebar link ([3e47a20](https://github.com/vuejs/vuepress/commit/3e47a20))
+
+
+
+<a name="1.0.0-alpha.36"></a>
+# [1.0.0-alpha.36](https://github.com/vuejs/vuepress/compare/v1.0.0-alpha.35...v1.0.0-alpha.36) (2019-02-03)
+
+
+### Bug Fixes
+
+* **$core:** SFC page compile error (close: [#1110](https://github.com/vuejs/vuepress/issues/1110)) ([8f5b0cd](https://github.com/vuejs/vuepress/commit/8f5b0cd))
+
+
+### Features
+
+* **$theme-default:** refine sidebar groups ([#1257](https://github.com/vuejs/vuepress/issues/1257)) ([01dd45b](https://github.com/vuejs/vuepress/commit/01dd45b)), closes [#814](https://github.com/vuejs/vuepress/issues/814) [#783](https://github.com/vuejs/vuepress/issues/783) [#287](https://github.com/vuejs/vuepress/issues/287)
+  - `sidebarDepth` for a specified sidebar group.
+  - Nested sidebar groups.
+  - Clickable heading for sidebar groups.
+
+
+
+<a name="1.0.0-alpha.35"></a>
+# [1.0.0-alpha.35](https://github.com/vuejs/vuepress/compare/v1.0.0-alpha.34...v1.0.0-alpha.35) (2019-01-30)
+
+
+### Bug Fixes
+
+* **$core:** bust cache of extra watching files ([075f470](https://github.com/vuejs/vuepress/commit/075f470))
+* **$core:** never throw error if layout component does not exist ([#1247](https://github.com/vuejs/vuepress/issues/1247)) ([49c5983](https://github.com/vuejs/vuepress/commit/49c5983))
+* **$core:** style and platte path sep on windows ([#1246](https://github.com/vuejs/vuepress/issues/1246)) ([592918a](https://github.com/vuejs/vuepress/commit/592918a))
+* **$theme-default:** bitbucket edit link goes to wrong link (close: [#1235](https://github.com/vuejs/vuepress/issues/1235)) ([#1248](https://github.com/vuejs/vuepress/issues/1248)) ([3c5b3a6](https://github.com/vuejs/vuepress/commit/3c5b3a6))
+
+
+### Features
+
+* **$core:** exclude temp dir from being ignored watching ([c6797dd](https://github.com/vuejs/vuepress/commit/c6797dd))
+
+
+
 <a name="1.0.0-alpha.34"></a>
 # [1.0.0-alpha.34](https://github.com/vuejs/vuepress/compare/v1.0.0-alpha.33...v1.0.0-alpha.34) (2019-01-29)
 

README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://vuepress.vuejs.org/" target="_blank">
-    <img width="280" src="https://raw.githubusercontent.com/vuejs/vuepress/master/packages/docs/docs/.vuepress/public/hero.png" alt="logo">
+    <img width="180" src="https://raw.githubusercontent.com/vuejs/vuepress/master/packages/docs/docs/.vuepress/public/hero.png" alt="logo">
   </a>
 </p>
 
@@ -12,7 +12,7 @@
   <a href="https://discordapp.com/invite/HBherRA"><img src="https://img.shields.io/badge/Discord-join%20chat-738bd7.svg" alt="vuepress channel on Discord"></a>
 </p>
 
-> This is the branch for `VuePress Next`.
+> This is the branch for `VuePress Next` and docs are available at https://vuepress.vuejs.org.
 
 ## Status: alpha
 
@@ -22,84 +22,22 @@ For 0.x, it's moved to [0.x branch](https://github.com/vuejs/vuepress/tree/0.x)
 
 > Note that we are working hard to improve the documentation and contributions welcome if you keep up with the latest changes.
 
-# VuePress
-
-> Minimalistic docs generator with Vue component based layout system
-
-https://vuepress.vuejs.org/
-
 ## Install
 
 ```bash
 yarn add vuepress -D       # Install 0.x.x.
 yarn add vuepress@next -D  # Install next.
 ```
 
-## Features
-
-**Built-in markdown extensions**
-
-* [Table of Contents](https://vuepress.vuejs.org/guide/markdown.html#table-of-contents)
-* [Custom Containers](https://vuepress.vuejs.org/guide/markdown.html#custom-containers)
-* [Line Highlighting](https://vuepress.vuejs.org/guide/markdown.html#line-highlighting-in-code-blocks)
-* [Line Numbers](https://vuepress.vuejs.org/guide/markdown.html#line-numbers)
-* [Import Code Snippets](https://vuepress.vuejs.org/guide/markdown.html#import-code-snippets)
-
-**Using Vue in Markdown**
-
-* [Templating](https://vuepress.vuejs.org/guide/using-vue.html#templating)
-* [Using Components](https://vuepress.vuejs.org/guide/using-vue.html#using-components)
-
-**Vue-powered custom theme system**
-
-* [Metadata](https://vuepress.vuejs.org/theme/writing-a-theme.html#site-and-page-metadata)
-* [Content Excerpt](https://vuepress.vuejs.org/theme/writing-a-theme.html#content-excerpt)
-
-**Default theme**
-
-* Responsive layout
-* [Optional Homepage](https://vuepress.vuejs.org/theme/default-theme-config.html#homepage)
-* [Simple out-of-the-box header-based search](https://vuepress.vuejs.org/theme/default-theme-config.html#built-in-search)
-* [Algolia Search](https://vuepress.vuejs.org/theme/default-theme-config.html#algolia-search)
-* Customizable [navbar](https://vuepress.vuejs.org/theme/default-theme-config.html#navbar) and [sidebar](https://vuepress.vuejs.org/theme/default-theme-config.html#sidebar)
-* [Auto-generated GitHub link and page edit links](https://vuepress.vuejs.org/theme/default-theme-config.html#git-repo-and-edit-links)
-* [PWA: Popup UI to refresh contents](https://vuepress.vuejs.org/theme/default-theme-config.html#popup-ui-to-refresh-contents)
-* [Last Updated](https://vuepress.vuejs.org/theme/default-theme-config.html#last-updated)
-
-**Miscellaneous**
-
-* [Multi-Language Support](https://vuepress.vuejs.org/guide/i18n.html)
-* [Service Worker](https://vuepress.vuejs.org/config/#serviceworker)
-* [Google Analytics](https://vuepress.vuejs.org/config/#ga)
-
 ## Showcase
 
-Websites built with VuePress:
-
-**Vue Ecosystem**
-
-* [vue-cli](https://cli.vuejs.org/)
-* [vuex](https://vuex.vuejs.org/)
-* [vue-server-renderer](https://ssr.vuejs.org/)
-* [vue-router](https://router.vuejs.org/)
-* [vue-test-utils](https://vue-test-utils.vuejs.org/)
-* [vue-loader](https://vue-loader.vuejs.org/)
-* [vetur](https://vuejs.github.io/vetur/)
-* [rollup-plugin-vue](https://rollup-plugin-vue.vuejs.org/)
-
-**Community**
-
-* [cr-vue](https://cr-vue.mio3io.com/)
-* [vuesax](https://lusaxweb.github.io/vuesax/)
-* [vuemeetups](https://vuemeetups.org)
-
+Check out [Awesome Vuepress](https://github.com/ulivz/awesome-vuepress) to find awesome things related to VuePress.
 
 ## Development
 
 > Please make sure your version of Node.js is greater than 8.
 
 ``` bash
-yarn
 yarn dev  # serves VuePress' own docs with itself
 yarn test # make sure your code change pass the test
 ```

lerna.json

@@ -2,5 +2,5 @@
   "lerna": "2.5.1",
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "1.0.0-alpha.34"
+  "version": "1.0.0-alpha.37"
 }

packages/@vuepress/core/lib/app/app.js

@@ -8,6 +8,7 @@ import appEnhancers from '@internal/app-enhancers'
 import globalUIComponents from '@internal/global-ui'
 import ClientComputedMixin from '@transform/ClientComputedMixin'
 import VuePress from './plugins/VuePress'
+import { handleRedirectForCleanUrls } from './redirect.js'
 
 // built-in components
 import Content from './components/Content.js'
@@ -21,8 +22,8 @@ if (module.hot) {
   module.hot.accept(VUEPRESS_TEMP_PATH + '/internal/siteData.js', () => {
     if (siteData.base !== prevBase) {
       window.alert(
-        `[vuepress] Site base has changed. ` +
-        `Please restart dev server to ensure correct asset paths.`
+        `[vuepress] Site base has changed. `
+        + `Please restart dev server to ensure correct asset paths.`
       )
     }
   })
@@ -74,16 +75,7 @@ export function createApp (isServer) {
     }
   })
 
-  // redirect /foo to /foo/
-  router.beforeEach((to, from, next) => {
-    if (!/(\/|\.html)$/.test(to.path)) {
-      next(Object.assign({}, to, {
-        path: to.path + '/'
-      }))
-    } else {
-      next()
-    }
-  })
+  handleRedirectForCleanUrls(router)
 
   const options = {}
 

packages/@vuepress/core/lib/app/redirect.js

@@ -0,0 +1,54 @@
+// In VuePress, we have following convention about routing:
+//
+//   - `/foo/` means source file is `/foo/{README|index}.md`
+//   - `/foo.html` means your source file is `/foo.md`
+//
+// The original design of VuePress relied on above two styles
+// of routing, especially the calculation involved of routes at
+// default theme. so we can't easily modify `/foo.html` directly
+// to `/foo` (i.e. remove html suffix)
+//
+// This "temporary" utility handles redirect of clean urls, with
+// this utility, you'll get:
+//
+// For unknown request `/foo`
+//   - redirect to `/foo.html` if it exists
+//   - redirect to `/foo/` if it exists
+//
+// For unknown request `/foo/`
+//   - redirect to `/foo.html` if it exists
+//
+// If all the above redirect rules don't exist, you'll get a 404
+
+export function handleRedirectForCleanUrls (router) {
+  router.beforeEach((to, from, next) => {
+    if (isRouteExists(router, to.path)) {
+      next()
+    } else {
+      if (!/(\/|\.html)$/.test(to.path)) {
+        const endingSlashUrl = to.path + '/'
+        const endingHtmlUrl = to.path + '.html'
+        if (isRouteExists(router, endingHtmlUrl)) {
+          next(endingHtmlUrl)
+        } else if (isRouteExists(router, endingSlashUrl)) {
+          next(endingSlashUrl)
+        } else {
+          next()
+        }
+      } else if (/\/$/.test(to.path)) {
+        const endingHtmlUrl = to.path.replace(/\/$/, '') + '.html'
+        if (isRouteExists(router, endingHtmlUrl)) {
+          next(endingHtmlUrl)
+        } else {
+          next()
+        }
+      } else {
+        next()
+      }
+    }
+  })
+}
+
+function isRouteExists (router, path) {
+  return router.options.routes.filter(route => route.path === path).length > 0
+}

packages/@vuepress/core/lib/dev.js

@@ -37,8 +37,12 @@ async function prepareServer (sourceDir, cliOptions = {}, context) {
   }
 
   // Curry update handler by update type
-  const spawnUpdate = (updateType) =>
-    file => update(`${chalk.red(updateType)} ${chalk.cyan(file)}`)
+  const spawnUpdate = updateType => file => {
+    const target = path.join(sourceDir, file)
+    // Bust cache.
+    delete require.cache[target]
+    update(`${chalk.red(updateType)} ${chalk.cyan(file)}`)
+  }
 
   // watch add/remove of files
   const pagesWatcher = chokidar.watch([
@@ -97,8 +101,8 @@ async function prepareServer (sourceDir, cliOptions = {}, context) {
   const { host, displayHost } = await resolveHost(cliOptions.host || ctx.siteConfig.host)
 
   // debug in a running dev process.
-  process.stdin &&
-  process.stdin.on('data', chunk => {
+  process.stdin
+  && process.stdin.on('data', chunk => {
     const parsed = chunk.toString('utf-8').trim()
     if (parsed === '*') {
       console.log(Object.keys(ctx))
@@ -135,7 +139,10 @@ async function prepareServer (sourceDir, cliOptions = {}, context) {
     },
     publicPath: ctx.base,
     watchOptions: {
-      ignored: /node_modules/
+      ignored: [
+        /node_modules/,
+        `!${ctx.tempPath}/**`
+      ]
     },
     historyApiFallback: {
       disableDotRule: true,

packages/@vuepress/core/lib/internal-plugins/frontmatterBlock/loader.js

@@ -12,11 +12,11 @@ module.exports = function (source, map) {
     const cached = cache.get(file)
     const parsed = parseStrippedFrontmatter(source)
 
-    if (cached &&
-      cached.data &&
-      parsed &&
-      parsed.data &&
-      JSON.stringify(cached.data) !== JSON.stringify(parsed.data)
+    if (cached
+      && cached.data
+      && parsed
+      && parsed.data
+      && JSON.stringify(cached.data) !== JSON.stringify(parsed.data)
     ) {
       frontmatterEmitter.emit('update')
     }

packages/@vuepress/core/lib/internal-plugins/palette/index.js

@@ -22,14 +22,13 @@ module.exports = (options, ctx) => ({
 
     const themePalette = path.resolve(ctx.themePath, 'styles/palette.styl')
     const userPalette = path.resolve(sourceDir, '.vuepress/styles/palette.styl')
-      .replace(/[\\]+/g, '/')
 
     const themePaletteContent = fs.existsSync(themePalette)
-      ? `@import(${JSON.stringify(themePalette)})`
+      ? `@import(${JSON.stringify(themePalette.replace(/[\\]+/g, '/'))})`
       : ''
 
     const userPaletteContent = fs.existsSync(userPalette)
-      ? `@import(${JSON.stringify(userPalette)})`
+      ? `@import(${JSON.stringify(userPalette.replace(/[\\]+/g, '/'))})`
       : ''
 
     // user's palette can override theme's palette.
@@ -38,7 +37,7 @@ module.exports = (options, ctx) => ({
     if (ctx.parentThemePath) {
       const parentThemePalette = path.resolve(ctx.parentThemePath, 'styles/palette.styl')
       const parentThemePaletteContent = fs.existsSync(parentThemePalette)
-        ? `@import(${JSON.stringify(parentThemePalette)})`
+        ? `@import(${JSON.stringify(parentThemePalette.replace(/[\\]+/g, '/'))})`
         : ''
       paletteContent = parentThemePaletteContent + paletteContent
     }

packages/@vuepress/core/lib/internal-plugins/style/index.js

@@ -17,22 +17,21 @@ module.exports = (options, ctx) => ({
 
     const themeStyle = path.resolve(ctx.themePath, 'styles/index.styl')
     const userStyle = path.resolve(sourceDir, '.vuepress/styles/index.styl')
-      .replace(/[\\]+/g, '/')
 
     const themeStyleContent = fs.existsSync(themeStyle)
-      ? `@import(${JSON.stringify(themeStyle)})`
+      ? `@import(${JSON.stringify(themeStyle.replace(/[\\]+/g, '/'))})`
       : ''
 
     const userStyleContent = fs.existsSync(userStyle)
-      ? `@import(${JSON.stringify(userStyle)})`
+      ? `@import(${JSON.stringify(userStyle.replace(/[\\]+/g, '/'))})`
       : ''
 
     let styleContent = themeStyleContent + userStyleContent
 
     if (ctx.parentThemePath) {
       const parentThemeStyle = path.resolve(ctx.parentThemePath, 'styles/index.styl')
       const parentThemeStyleContent = fs.existsSync(parentThemeStyle)
-        ? `@import(${JSON.stringify(parentThemeStyle)})`
+        ? `@import(${JSON.stringify(parentThemeStyle.replace(/[\\]+/g, '/'))})`
         : ''
       styleContent = parentThemeStyleContent + styleContent
     }

packages/@vuepress/core/lib/plugin-api/index.js

@@ -169,8 +169,8 @@ module.exports = class PluginAPI {
       this.options[option.name].add(pluginName, value)
     } else if (value !== undefined) {
       logger.warn(
-        `${chalk.gray(pluginName)} ` +
-        `Invalid value for "option" ${chalk.cyan(option.name)}: ${warnMsg}`
+        `${chalk.gray(pluginName)} `
+        + `Invalid value for "option" ${chalk.cyan(option.name)}: ${warnMsg}`
       )
     }
     return this

packages/@vuepress/core/lib/plugin-api/override/EnhanceAppFilesOption.js

@@ -67,8 +67,8 @@ module.exports = class EnhanceAppFilesOption extends AsyncOption {
           }
         } else {
           logger.developer(
-            chalk.gray(`[${pluginName}] `) +
-            `${chalk.cyan(enhanceAppFile)} Not Found.`
+            chalk.gray(`[${pluginName}] `)
+            + `${chalk.cyan(enhanceAppFile)} Not Found.`
           )
         }
       }