fix(core): use absolute path when creating pages (close vuepress#421)

BREAKING CHANGE: now `PageOptions` does not accept relative file path

Author: meteorlxy

packages/@vuepress/core/src/app/createAppPages.ts

@@ -10,14 +10,15 @@ const log = debug('vuepress:core/app')
 export const createAppPages = async (app: App): Promise<Page[]> => {
   log('createAppPages start')
 
-  // resolve page file paths according to the page patterns
-  const pagePaths = await globby(app.options.pagePatterns, {
+  // resolve page absolute file paths according to the page patterns
+  const pageFilePaths = await globby(app.options.pagePatterns, {
+    absolute: true,
     cwd: app.dir.source(),
   })
 
   // create pages from files
   const pages = await Promise.all(
-    pagePaths.map((filePath) => createPage(app, { filePath }))
+    pageFilePaths.map((filePath) => createPage(app, { filePath }))
   )
 
   // if there is no 404 page, add one

packages/@vuepress/core/src/page/resolvePageFilePath.ts

@@ -22,17 +22,8 @@ export const resolvePageFilePath = ({
     }
   }
 
-  // absolute file path
-  if (path.isAbsolute(filePath)) {
-    return {
-      filePath,
-      filePathRelative: path.relative(app.dir.source(), filePath),
-    }
-  }
-
-  // relative file path
   return {
-    filePath: app.dir.source(filePath),
-    filePathRelative: filePath,
+    filePath,
+    filePathRelative: path.relative(app.dir.source(), filePath),
   }
 }

packages/@vuepress/core/src/page/resolvePageOptions.ts

@@ -10,11 +10,12 @@ export const resolvePageOptions = async ({
   app: App
   optionsRaw: PageOptions
 }): Promise<PageOptions> => {
+  // avoid mutating the original options object provided by user
   const options = { ...optionsRaw }
 
   // plugin hook: extendsPageOptions
   const extendsPageOptions = await app.pluginApi.hooks.extendsPageOptions.process(
-    optionsRaw,
+    options,
     app
   )
   extendsPageOptions.forEach((item) => Object.assign(options, item))

packages/@vuepress/core/src/types/page.ts

@@ -135,8 +135,29 @@ export interface Page<T extends PageData = PageData> extends PageData {
  * Options to create vuepress page
  */
 export interface PageOptions {
-  path?: string
+  /**
+   * If `filePath` is not set, this option will be used as the raw
+   * markdown content of the page.
+   *
+   * If `filePath` is set, this option will be ignored, while the
+   * content of the file will be used.
+   */
+  content?: string
+
+  /**
+   * Absolute file path of the markdown source file.
+   */
   filePath?: string
+
+  /**
+   * Default frontmatter of the page, which could be overridden by
+   * the frontmatter of the markdown content.
+   */
   frontmatter?: PageFrontmatter
-  content?: string
+
+  /**
+   * If this option is set, it will be used as the final route path
+   * of the page, ignoring the relative path and permalink.
+   */
+  path?: string
 }