@vuepress/core 2.0.0-beta.27 → 2.0.0-beta.28

package/lib/app/appInit.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.appInit = void 0;
 const utils_1 = require("@vuepress/utils");
+const createAppMarkdown_1 = require("./createAppMarkdown");
 const createAppPages_1 = require("./createAppPages");
 const log = (0, utils_1.debug)('vuepress:core/app');
 /**
@@ -15,8 +16,8 @@ const appInit = async (app) => {
     // plugins should be used before `registerHooks()`
     // hooks in plugins will take effect after `registerHooks()`
     app.pluginApi.registerHooks();
-    // plugin hook: extendsMarkdown
-    await app.pluginApi.hooks.extendsMarkdown.process(app.markdown, app);
+    // create markdown
+    app.markdown = await (0, createAppMarkdown_1.createAppMarkdown)(app);
     // create pages
     app.pages = await (0, createAppPages_1.createAppPages)(app);
     // plugin hook: onInitialized

package/lib/app/createAppMarkdown.d.ts

@@ -0,0 +1,6 @@
+import type { Markdown } from '@vuepress/markdown';
+import type { App } from '../types';
+/**
+ * Create markdown-it instance for vuepress app
+ */
+export declare const createAppMarkdown: (app: App) => Promise<Markdown>;

package/lib/app/createAppMarkdown.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAppMarkdown = void 0;
+const markdown_1 = require("@vuepress/markdown");
+/**
+ * Create markdown-it instance for vuepress app
+ */
+const createAppMarkdown = async (app) => {
+    // plugin hook: extendsMarkdownOptions
+    await app.pluginApi.hooks.extendsMarkdownOptions.process(app.options.markdown, app);
+    const markdown = (0, markdown_1.createMarkdown)(app.options.markdown);
+    // plugin hook: extendsMarkdown
+    await app.pluginApi.hooks.extendsMarkdown.process(markdown, app);
+    return markdown;
+};
+exports.createAppMarkdown = createAppMarkdown;

package/lib/app/createAppPages.js

@@ -15,7 +15,15 @@ const createAppPages = async (app) => {
         cwd: app.dir.source(),
     });
     // create pages from files
-    const pages = await Promise.all(pageFilePaths.map((filePath) => (0, page_1.createPage)(app, { filePath })));
+    const pages = await Promise.all(pageFilePaths.map(async (filePath) => {
+        const pageOptions = { filePath };
+        // plugin hook: extendsPageOptions
+        await app.pluginApi.hooks.extendsPageOptions.process(pageOptions, app);
+        const page = await (0, page_1.createPage)(app, pageOptions);
+        // plugin hook: extendsPage
+        await app.pluginApi.hooks.extendsPage.process(page, app);
+        return page;
+    }));
     // if there is no 404 page, add one
     if (!pages.some((page) => page.path === '/404.html')) {
         pages.push(await (0, page_1.createPage)(app, {

package/lib/app/createBaseApp.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createBaseApp = void 0;
-const markdown_1 = require("@vuepress/markdown");
 const pluginApi_1 = require("../pluginApi");
 const appInit_1 = require("./appInit");
 const appPrepare_1 = require("./appPrepare");
@@ -23,7 +22,6 @@ const createBaseApp = (config, isBuild = false) => {
     const dir = (0, createAppDir_1.createAppDir)(options);
     const env = (0, createAppEnv_1.createAppEnv)(options, isBuild);
     const siteData = (0, createAppSiteData_1.createAppSiteData)(options);
-    const markdown = (0, markdown_1.createMarkdown)(options.markdown);
     const pluginApi = (0, pluginApi_1.createPluginApi)();
     const writeTemp = (0, createAppWriteTemp_1.createAppWriteTemp)(dir);
     const app = {
@@ -32,7 +30,6 @@ const createBaseApp = (config, isBuild = false) => {
         dir,
         env,
         siteData,
-        markdown,
         pluginApi,
         writeTemp,
         use: (...args) => (0, appUse_1.appUse)(app, ...args),

package/lib/app/prepare/preparePagesRoutes.js

@@ -11,9 +11,9 @@ import { Vuepress } from '@vuepress/client/lib/components/Vuepress'
 
 const routeItems = [\
 ${app.pages
-        .map(({ key, path, pathInferred, filePathRelative, title }) => {
+        .map(({ key, path, pathInferred, filePathRelative, routeMeta }) => {
         const redirects = [];
-        const routeItem = [key, path, title, redirects];
+        const routeItem = [key, path, routeMeta, redirects];
         // paths that should redirect to this page
         const redirectsSet = new Set();
         // redirect from decoded path
@@ -47,13 +47,13 @@ ${app.pages
 ]
 
 export const pagesRoutes = routeItems.reduce(
-  (result, [name, path, title, redirects]) => {
+  (result, [name, path, meta, redirects]) => {
     result.push(
       {
         name,
         path,
         component: Vuepress,
-        meta: { title },
+        meta,
       },
       ...redirects.map((item) => ({
         path: item,

package/lib/page/createPage.d.ts

@@ -1,2 +1,2 @@
 import type { App, Page, PageOptions } from '../types';
-export declare const createPage: (app: App, optionsRaw: PageOptions) => Promise<Page>;
+export declare const createPage: (app: App, options: PageOptions) => Promise<Page>;

package/lib/page/createPage.js

@@ -6,7 +6,6 @@ const renderPageContent_1 = require("./renderPageContent");
 const renderPageExcerpt_1 = require("./renderPageExcerpt");
 const resolvePageComponentInfo_1 = require("./resolvePageComponentInfo");
 const resolvePageContent_1 = require("./resolvePageContent");
-const resolvePageData_1 = require("./resolvePageData");
 const resolvePageDataInfo_1 = require("./resolvePageDataInfo");
 const resolvePageDate_1 = require("./resolvePageDate");
 const resolvePageFileContent_1 = require("./resolvePageFileContent");
@@ -15,13 +14,11 @@ const resolvePageFrontmatter_1 = require("./resolvePageFrontmatter");
 const resolvePageHtmlInfo_1 = require("./resolvePageHtmlInfo");
 const resolvePageKey_1 = require("./resolvePageKey");
 const resolvePageLang_1 = require("./resolvePageLang");
-const resolvePageOptions_1 = require("./resolvePageOptions");
 const resolvePagePath_1 = require("./resolvePagePath");
 const resolvePagePermalink_1 = require("./resolvePagePermalink");
+const resolvePageRouteMeta_1 = require("./resolvePageRouteMeta");
 const resolvePageSlug_1 = require("./resolvePageSlug");
-const createPage = async (app, optionsRaw) => {
-    // resolve page options from raw options
-    const options = await (0, resolvePageOptions_1.resolvePageOptions)({ app, optionsRaw });
+const createPage = async (app, options) => {
     // resolve page file absolute path and relative path
     const { filePath, filePathRelative } = (0, resolvePageFilePath_1.resolvePageFilePath)({
         app,
@@ -44,13 +41,15 @@ const createPage = async (app, optionsRaw) => {
         frontmatter,
     });
     // render page content and extract information
-    const { contentRendered, deps, headers, hoistedTags, links, title, } = await (0, renderPageContent_1.renderPageContent)({
+    const { contentRendered, deps, headers, hoistedTags, links, title } = await (0, renderPageContent_1.renderPageContent)({
         app,
         content,
         filePath,
         filePathRelative,
         frontmatter,
     });
+    // resolve route meta from frontmatter
+    const routeMeta = (0, resolvePageRouteMeta_1.resolvePageRouteMeta)({ frontmatter });
     // resolve slug from file path
     const slug = (0, resolvePageSlug_1.resolvePageSlug)({ filePathRelative });
     // resolve date from file path
@@ -69,7 +68,7 @@ const createPage = async (app, optionsRaw) => {
     });
     // resolve page path
     const path = (0, resolvePagePath_1.resolvePagePath)({ permalink, pathInferred, options });
-    // resolve path key
+    // resolve page key
     const key = (0, resolvePageKey_1.resolvePageKey)({ path });
     // resolve page rendered html file path
     const { htmlFilePath, htmlFilePathRelative } = (0, resolvePageHtmlInfo_1.resolvePageHtmlInfo)({
@@ -83,8 +82,18 @@ const createPage = async (app, optionsRaw) => {
         htmlFilePathRelative,
         key,
     });
-    const { dataFilePath, dataFilePathRelative, dataFileChunkName, } = (0, resolvePageDataInfo_1.resolvePageDataInfo)({ app, htmlFilePathRelative, key });
+    const { dataFilePath, dataFilePathRelative, dataFileChunkName } = (0, resolvePageDataInfo_1.resolvePageDataInfo)({ app, htmlFilePathRelative, key });
     const page = {
+        // page data
+        data: {
+            key,
+            path,
+            title,
+            lang,
+            frontmatter,
+            excerpt,
+            headers,
+        },
         // base fields
         key,
         path,
@@ -103,6 +112,7 @@ const createPage = async (app, optionsRaw) => {
         pathInferred,
         pathLocale,
         permalink,
+        routeMeta,
         slug,
         // file info
         filePath,
@@ -116,8 +126,6 @@ const createPage = async (app, optionsRaw) => {
         htmlFilePath,
         htmlFilePathRelative,
     };
-    // resolve page data
-    page.data = await (0, resolvePageData_1.resolvePageData)({ app, page });
     return page;
 };
 exports.createPage = createPage;

package/lib/page/index.d.ts

@@ -5,7 +5,6 @@ export * from './renderPageExcerpt';
 export * from './resolvePageComponentInfo';
 export * from './resolvePageContent';
 export * from './resolvePageDataInfo';
-export * from './resolvePageData';
 export * from './resolvePageDate';
 export * from './resolvePageFileContent';
 export * from './resolvePageFilePath';
@@ -13,7 +12,7 @@ export * from './resolvePageFrontmatter';
 export * from './resolvePageHtmlInfo';
 export * from './resolvePageKey';
 export * from './resolvePageLang';
-export * from './resolvePageOptions';
 export * from './resolvePagePath';
 export * from './resolvePagePermalink';
+export * from './resolvePageRouteMeta';
 export * from './resolvePageSlug';

package/lib/page/index.js

@@ -17,7 +17,6 @@ __exportStar(require("./renderPageExcerpt"), exports);
 __exportStar(require("./resolvePageComponentInfo"), exports);
 __exportStar(require("./resolvePageContent"), exports);
 __exportStar(require("./resolvePageDataInfo"), exports);
-__exportStar(require("./resolvePageData"), exports);
 __exportStar(require("./resolvePageDate"), exports);
 __exportStar(require("./resolvePageFileContent"), exports);
 __exportStar(require("./resolvePageFilePath"), exports);
@@ -25,7 +24,7 @@ __exportStar(require("./resolvePageFrontmatter"), exports);
 __exportStar(require("./resolvePageHtmlInfo"), exports);
 __exportStar(require("./resolvePageKey"), exports);
 __exportStar(require("./resolvePageLang"), exports);
-__exportStar(require("./resolvePageOptions"), exports);
 __exportStar(require("./resolvePagePath"), exports);
 __exportStar(require("./resolvePagePermalink"), exports);
+__exportStar(require("./resolvePageRouteMeta"), exports);
 __exportStar(require("./resolvePageSlug"), exports);

package/lib/page/resolvePageContent.js

@@ -15,7 +15,7 @@ const resolvePageContent = ({ contentRaw, }) => {
         };
     }
     /* istanbul ignore next */
-    const { data, content, excerpt = '' } = matter(contentRaw, {
+    const { data, content, excerpt = '', } = matter(contentRaw, {
         excerpt_separator: '<!-- more -->',
         engines: {
             toml: toml.parse.bind(toml),

package/lib/page/resolvePageRouteMeta.d.ts

@@ -0,0 +1,7 @@
+import type { PageFrontmatter } from '../types';
+/**
+ * Resolve page route meta
+ */
+export declare const resolvePageRouteMeta: ({ frontmatter, }: {
+    frontmatter: PageFrontmatter;
+}) => Record<string, unknown>;

package/lib/page/resolvePageRouteMeta.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolvePageRouteMeta = void 0;
+/**
+ * Resolve page route meta
+ */
+const resolvePageRouteMeta = ({ frontmatter, }) => { var _a; return (_a = frontmatter.routeMeta) !== null && _a !== void 0 ? _a : {}; };
+exports.resolvePageRouteMeta = resolvePageRouteMeta;

package/lib/pluginApi/createPluginApiHooks.js

@@ -8,11 +8,11 @@ const createPluginApiHooks = () => ({
     onPrepared: (0, createHookQueue_1.createHookQueue)('onPrepared'),
     onWatched: (0, createHookQueue_1.createHookQueue)('onWatched'),
     onGenerated: (0, createHookQueue_1.createHookQueue)('onGenerated'),
-    // page hooks
-    extendsPageOptions: (0, createHookQueue_1.createHookQueue)('extendsPageOptions'),
-    extendsPageData: (0, createHookQueue_1.createHookQueue)('extendsPageData'),
-    // markdown hooks
+    // extends hooks
+    extendsMarkdownOptions: (0, createHookQueue_1.createHookQueue)('extendsMarkdownOptions'),
     extendsMarkdown: (0, createHookQueue_1.createHookQueue)('extendsMarkdown'),
+    extendsPageOptions: (0, createHookQueue_1.createHookQueue)('extendsPageOptions'),
+    extendsPage: (0, createHookQueue_1.createHookQueue)('extendsPage'),
     // client files hooks
     clientAppEnhanceFiles: (0, createHookQueue_1.createHookQueue)('clientAppEnhanceFiles'),
     clientAppRootComponentFiles: (0, createHookQueue_1.createHookQueue)('clientAppRootComponentFiles'),

package/lib/types/app/app.d.ts

@@ -30,10 +30,6 @@ export interface App {
      * Site data, which will be used in client side
      */
     siteData: SiteData;
-    /**
-     * Markdown-it instance
-     */
-    markdown: Markdown;
     /**
      * Plugin system
      */
@@ -65,6 +61,12 @@ export interface App {
      * Only available after initialization
      */
     layouts: Record<string, string>;
+    /**
+     * Markdown-it instance.
+     *
+     * Only available after initialization
+     */
+    markdown: Markdown;
     /**
      * Page objects.
      *

package/lib/types/page.d.ts

@@ -3,11 +3,11 @@ import type { PageData, PageFrontmatter } from '@vuepress/shared';
 /**
  * Vuepress Page
  */
-export interface Page<T extends PageData = PageData> extends PageData {
+export declare type Page<ExtraPageData extends Record<any, any> = Record<never, never>, ExtraPageFields extends Record<any, any> = Record<never, never>> = PageData & ExtraPageFields & {
     /**
      * Data of the page, which will be available in client code
      */
-    data: T;
+    data: PageData<ExtraPageData>;
     /**
      * Raw Content of the page
      */
@@ -56,6 +56,12 @@ export interface Page<T extends PageData = PageData> extends PageData {
      * If the page does not have a permalink, it would be `null`
      */
     permalink: string | null;
+    /**
+     * Custom data to be attached to the page route record of vue-router
+     *
+     * @see https://next.router.vuejs.org/api/#meta
+     */
+    routeMeta: Record<string, unknown>;
     /**
      * Slug of the page
      */
@@ -108,7 +114,7 @@ export interface Page<T extends PageData = PageData> extends PageData {
      * Rendered html file path relative to dest directory
      */
     htmlFilePathRelative: string;
-}
+};
 /**
  * Options to create vuepress page
  */

package/lib/types/pluginApi/hooks.d.ts

@@ -1,4 +1,4 @@
-import type { Markdown } from '@vuepress/markdown';
+import type { Markdown, MarkdownOptions } from '@vuepress/markdown';
 import type { App } from '../app';
 import type { Page, PageOptions } from '../page';
 declare type PromiseOrNot<T> = Promise<T> | T;
@@ -11,11 +11,9 @@ export declare type Hook<Exposed, Normalized = Exposed, Result = Normalized exte
     result: Result;
 };
 export declare type LifeCycleHook<T extends unknown[] = []> = Hook<(app: App, ...args: T) => PromiseOrNot<void>>;
+export declare type ExtendsHook<T> = Hook<(extendable: T, app: App) => PromiseOrNot<void>>;
 export declare type ClientFilesHook = Hook<string | string[] | ((app: App) => PromiseOrNot<string | string[]>), (app: App) => Promise<string[]>>;
 export declare type ReturnObjectHook = Hook<Record<string, any> | ((app: App) => PromiseOrNot<Record<string, any>>), (app: App) => Promise<Record<string, any>>>;
-export declare type ExtendsMarkdownHook = Hook<(md: Markdown, app: App) => PromiseOrNot<void>>;
-export declare type ExtendsPageOptionsHook = Hook<(options: PageOptions, app: App) => PromiseOrNot<PageOptions>>;
-export declare type ExtendsPageDataHook = Hook<(page: Omit<Page, 'data'>, app: App) => PromiseOrNot<Record<string, any>>>;
 /**
  * List of hooks
  */
@@ -24,9 +22,10 @@ export interface Hooks {
     onPrepared: LifeCycleHook;
     onWatched: LifeCycleHook<[watchers: Closable[], restart: () => Promise<void>]>;
     onGenerated: LifeCycleHook;
-    extendsMarkdown: ExtendsMarkdownHook;
-    extendsPageOptions: ExtendsPageOptionsHook;
-    extendsPageData: ExtendsPageDataHook;
+    extendsMarkdownOptions: ExtendsHook<MarkdownOptions>;
+    extendsMarkdown: ExtendsHook<Markdown>;
+    extendsPageOptions: ExtendsHook<PageOptions>;
+    extendsPage: ExtendsHook<Page>;
     clientAppEnhanceFiles: ClientFilesHook;
     clientAppRootComponentFiles: ClientFilesHook;
     clientAppSetupFiles: ClientFilesHook;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/core",
-  "version": "2.0.0-beta.27",
+  "version": "2.0.0-beta.28",
   "description": "Core package of VuePress",
   "keywords": [
     "vuepress",
@@ -26,15 +26,15 @@
     "clean": "rimraf lib *.tsbuildinfo"
   },
   "dependencies": {
-    "@vuepress/client": "2.0.0-beta.27",
-    "@vuepress/markdown": "2.0.0-beta.27",
-    "@vuepress/shared": "2.0.0-beta.27",
-    "@vuepress/utils": "2.0.0-beta.27",
+    "@vuepress/client": "2.0.0-beta.28",
+    "@vuepress/markdown": "2.0.0-beta.28",
+    "@vuepress/shared": "2.0.0-beta.28",
+    "@vuepress/utils": "2.0.0-beta.28",
     "gray-matter": "^4.0.3",
     "toml": "^3.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2671a94fe6864e215eb84f318b7e657744a0bc5d"
+  "gitHead": "71c34816a79263c7dcba3ff0c103e264abdbf0d2"
 }

package/lib/page/resolvePageData.d.ts

@@ -1,8 +0,0 @@
-import type { App, Page, PageData } from '../types';
-/**
- * Resolve page data
- */
-export declare const resolvePageData: ({ app, page, }: {
-    app: App;
-    page: Page;
-}) => Promise<PageData>;

package/lib/page/resolvePageData.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolvePageData = void 0;
-/**
- * Resolve page data
- */
-const resolvePageData = async ({ app, page, }) => {
-    const { key, path, title, lang, frontmatter, excerpt, headers } = page;
-    const data = {
-        key,
-        path,
-        title,
-        lang,
-        frontmatter,
-        excerpt,
-        headers,
-    };
-    // plugin hook: extendsPageData
-    const extendsPageData = await app.pluginApi.hooks.extendsPageData.process(page, app);
-    extendsPageData.forEach((item) => Object.assign(data, item));
-    return data;
-};
-exports.resolvePageData = resolvePageData;

package/lib/page/resolvePageOptions.d.ts

@@ -1,8 +0,0 @@
-import type { App, PageOptions } from '../types';
-/**
- * Render page content and extract related info
- */
-export declare const resolvePageOptions: ({ app, optionsRaw, }: {
-    app: App;
-    optionsRaw: PageOptions;
-}) => Promise<PageOptions>;

package/lib/page/resolvePageOptions.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolvePageOptions = void 0;
-/**
- * Render page content and extract related info
- */
-const resolvePageOptions = async ({ app, optionsRaw, }) => {
-    // avoid mutating the original options object provided by user
-    const options = { ...optionsRaw };
-    // plugin hook: extendsPageOptions
-    const extendsPageOptions = await app.pluginApi.hooks.extendsPageOptions.process(options, app);
-    extendsPageOptions.forEach((item) => Object.assign(options, item));
-    return options;
-};
-exports.resolvePageOptions = resolvePageOptions;