feat(core): add extendsPageOptions hook

Author: meteorlxy

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

@@ -1,24 +1,30 @@
 import { globby } from '@vuepress/utils'
 import { createPage } from '../page'
-import type { App, Page } from '../types'
+import type { App, Page, PageOptions } from '../types'
 
 /**
  * Create pages for vuepress app
  */
 export const createAppPages = async (app: App): Promise<Page[]> => {
+  // resolve page file paths according to the page patterns
   const pagePaths = await globby(app.options.pagePatterns, {
     cwd: app.dir.source(),
   })
 
-  // TODO
-  // may need to limit the max parallel tasks
-  // or change to serial tasks
+  // create pages from files
   const pages = await Promise.all(
-    pagePaths.map((filePath) =>
-      createPage(app, {
+    pagePaths.map(async (filePath) => {
+      const pageOptions: PageOptions = { filePath }
+
+      // plugin hook: extendsPageOptions
+      const extendsPageOptions = await app.pluginApi.hooks.extendsPageOptions.process(
         filePath,
-      })
-    )
+        app
+      )
+      extendsPageOptions.forEach((item) => Object.assign(pageOptions, item))
+
+      return createPage(app, pageOptions)
+    })
   )
 
   // if there is no 404 page, add one

packages/@vuepress/core/src/pluginApi/createPluginApiHooks.ts

@@ -9,6 +9,7 @@ export const createPluginApiHooks = (): PluginApi['hooks'] => ({
   onGenerated: createHookQueue('onGenerated'),
 
   // page hooks
+  extendsPageOptions: createHookQueue('extendsPageOptions'),
   extendsPageData: createHookQueue('extendsPageData'),
 
   // markdown hooks

packages/@vuepress/core/src/types/plugin-api/hooks.ts

@@ -1,6 +1,6 @@
 import type { Markdown } from '@vuepress/markdown'
 import type { App } from '../app'
-import type { Page } from '../page'
+import type { Page, PageOptions } from '../page'
 
 // util type
 type PromiseOrNot<T> = Promise<T> | T
@@ -42,6 +42,9 @@ export type ReturnObjectHook = Hook<
 export type ExtendsMarkdownHook = Hook<(md: Markdown, app: App) => void>
 
 // page hook
+export type ExtendsPageOptionsHook = Hook<
+  (filePath: string, app: App) => PromiseOrNot<PageOptions>
+>
 export type ExtendsPageDataHook = Hook<
   (page: Page, app: App) => PromiseOrNot<Record<string, any>>
 >
@@ -55,6 +58,7 @@ export interface Hooks {
   onWatched: LifeCycleHook<[watchers: Closable[], restart: () => Promise<void>]>
   onGenerated: LifeCycleHook
   extendsMarkdown: ExtendsMarkdownHook
+  extendsPageOptions: ExtendsPageOptionsHook
   extendsPageData: ExtendsPageDataHook
   clientAppEnhanceFiles: ClientFilesHook
   clientAppRootComponentFiles: ClientFilesHook