@vuepress/core 2.0.0-beta.4 → 2.0.0-beta.42

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

@@ -1,30 +1,98 @@
 import type { Markdown } from '@vuepress/markdown';
 import type { SiteData } from '@vuepress/shared';
-import type { BundlerDev, BundlerBuild } from '../bundler';
+import type { Bundler } from '../bundler';
 import type { Page } from '../page';
-import type { Plugin, PluginOptions, PluginConfig } from '../plugin';
-import type { PluginApi } from '../plugin-api';
-import type { ThemeApi } from '../theme-api';
+import type { Plugin } from '../plugin';
+import type { PluginApi } from '../pluginApi';
 import type { AppOptions } from './options';
 import type { AppDir, AppEnv, AppWriteTemp } from './utils';
 /**
  * Vuepress app
  */
 export interface App {
-    version: string;
-    options: AppOptions;
+    /**
+     * Directory utils
+     */
     dir: AppDir;
+    /**
+     * Environment flags
+     */
     env: AppEnv;
-    siteData: SiteData;
-    markdown: Markdown;
+    /**
+     * Options that filled all optional fields with a default value
+     */
+    options: AppOptions;
+    /**
+     * Plugin system
+     */
     pluginApi: PluginApi;
-    use: <T extends PluginOptions>(plugin: Plugin<T> | string, config?: Partial<T>) => void;
-    useByConfig: <T extends PluginOptions>(pluginConfig: PluginConfig<T>) => void;
+    /**
+     * Site data, which will be used in client side
+     */
+    siteData: SiteData;
+    /**
+     * Version of vuepress core
+     */
+    version: string;
+    /**
+     * Write temp file
+     */
+    writeTemp: AppWriteTemp;
+    /**
+     * Use a plugin
+     */
+    use: (plugin: Plugin) => this;
+    /**
+     * Initialize app.
+     *
+     * - Theme and plugin will be loaded.
+     * - Layouts and pages will be resolved.
+     */
     init: () => Promise<void>;
+    /**
+     * Prepare data for client and write temp files.
+     *
+     * Should be called after `app.init()`.
+     */
     prepare: () => Promise<void>;
-    dev: () => ReturnType<BundlerDev>;
-    build: () => ReturnType<BundlerBuild>;
-    writeTemp: AppWriteTemp;
-    themeApi: ThemeApi;
+    /**
+     * Layout components.
+     *
+     * Only available after initialization
+     */
+    layouts: Record<string, string>;
+    /**
+     * Markdown-it instance.
+     *
+     * Only available after initialization
+     */
+    markdown: Markdown;
+    /**
+     * Page objects.
+     *
+     * Only available after initialization
+     */
     pages: Page[];
 }
+/**
+ * Vuepress dev app
+ */
+export interface DevApp extends App {
+    /**
+     * Start dev server
+     *
+     * Should be called after `app.prepare()`.
+     */
+    dev: () => ReturnType<Bundler['dev']>;
+}
+/**
+ * Vuepress build app
+ */
+export interface BuildApp extends App {
+    /**
+     * Build static files
+     *
+     * Should be called after `app.prepare()`.
+     */
+    build: () => ReturnType<Bundler['build']>;
+}

package/lib/types/app/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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

@@ -1,32 +1,83 @@
 import type { MarkdownOptions } from '@vuepress/markdown';
-import type { SiteLocaleConfig, SiteLocaleData } from '@vuepress/shared';
-import type { BundlerConfig } from '../bundler';
-import type { ThemeConfig } from '../theme';
+import type { SiteData } from '@vuepress/shared';
+import type { Bundler } from '../bundler';
+import type { PluginConfig } from '../plugin';
+import type { Theme } from '../theme';
 /**
- * Vuepress app options
+ * Vuepress app common config that shared between dev and build
  */
-export interface AppOptions<T extends ThemeConfig = ThemeConfig, U extends BundlerConfig = BundlerConfig> extends SiteLocaleData {
-    base: string;
-    locales: SiteLocaleConfig;
-    theme: string;
-    themeConfig: Partial<T>;
-    bundler: string;
-    bundlerConfig: Partial<U>;
+export interface AppConfigCommon extends Partial<SiteData> {
     source: string;
-    dest: string;
-    temp: string;
-    cache: string;
-    public: string;
-    markdown: MarkdownOptions;
-    debug: boolean;
-    host: string;
-    port: number;
-    open: boolean;
-    evergreen: boolean;
-    pagePatterns: string[];
-    templateDev: string;
-    templateSSR: string;
-    shouldPreload: ((file: string, type: string) => boolean) | boolean;
-    shouldPrefetch: ((file: string, type: string) => boolean) | boolean;
+    dest?: string;
+    temp?: string;
+    cache?: string;
+    public?: string;
+    debug?: boolean;
+    markdown?: MarkdownOptions;
+    pagePatterns?: string[];
+    bundler: Bundler;
+    theme: Theme;
+    plugins?: PluginConfig;
+}
+/**
+ * Vuepress app config for dev
+ */
+export interface AppConfigDev {
+    /**
+     * Specify the host to use for the dev server
+     *
+     * @default '0.0.0.0'
+     */
+    host?: string;
+    /**
+     * Specify the port to use for the dev server
+     *
+     * @default 8080
+     */
+    port?: number;
+    /**
+     * Whether to open the browser after dev-server had been started
+     *
+     * @default false
+     */
+    open?: boolean;
+    /**
+     * Specify the path of the HTML template to be used for dev
+     *
+     * @default '@vuepress/client/templates/dev.html'
+     */
+    templateDev?: string;
+}
+/**
+ * Vuepress app config for build
+ */
+export interface AppConfigBuild {
+    /**
+     * Determine what resource files should be preloaded. Use boolean value to
+     * totally enable / disable.
+     *
+     * @default true
+     */
+    shouldPreload?: ((file: string, type: string) => boolean) | boolean;
+    /**
+     * Determine what resource files should be prefetched. Use boolean value to
+     * totally enable / disable.
+     *
+     * @default false
+     */
+    shouldPrefetch?: ((file: string, type: string) => boolean) | boolean;
+    /**
+     * Specify the path of the HTML template to be used for build
+     *
+     * @default '@vuepress/client/templates/build.html'
+     */
+    templateBuild?: string;
 }
-export declare type AppConfig = Partial<AppOptions> & Pick<AppOptions, 'source'>;
+/**
+ * Vuepress app config
+ */
+export declare type AppConfig = AppConfigCommon & AppConfigDev & AppConfigBuild;
+/**
+ * Vuepress app options
+ */
+export declare type AppOptions = Required<AppConfig>;

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

@@ -17,11 +17,18 @@ export interface AppDir {
  * Environment flags
  */
 export interface AppEnv {
-    isProd: boolean;
-    isTest: boolean;
+    /**
+     * Is running in build mode or not
+     */
+    isBuild: boolean;
+    /**
+     * Is running in dev mode or not
+     */
     isDev: boolean;
+    /**
+     * Is debug mode enabled or not
+     */
     isDebug: boolean;
-    nodeEnv: string | undefined;
 }
 /**
  * Write temp file util

package/lib/types/bundler.d.ts

@@ -7,28 +7,7 @@ import type { App } from './app';
  * - build: bundle assets for deployment
  */
 export interface Bundler {
-    dev: BundlerDev;
-    build: BundlerBuild;
-}
-export declare type BundlerDev = (app: App) => Promise<() => Promise<void>>;
-export declare type BundlerBuild = (app: App) => Promise<void>;
-/**
- * A function that returns a bundler instance
- *
- * A bundler package should have a `CreateBundlerFunction` as the default export
- */
-export declare type CreateBundlerFunction<BundlerOptions extends BundlerConfig = Partial<BundlerConfig>> = (options: BundlerOptions) => Bundler;
-/**
- * Bundler entry type
- */
-export interface BundlerEntry {
-    createBundler: CreateBundlerFunction;
-}
-/**
- * User config type of bundler
- *
- * @remark suffix `Config` means this is for user config
- */
-export interface BundlerConfig {
-    [key: string]: any;
+    name: string;
+    dev: (app: App) => Promise<() => Promise<void>>;
+    build: (app: App) => Promise<void>;
 }

package/lib/types/index.d.ts

@@ -1,9 +1,8 @@
-import type { HeadConfig, HeadTag, HeadTagEmpty, HeadTagNonEmpty, HeadAttrsConfig, LocaleConfig, LocaleData, PageData, PageFrontmatter, PageHeader, SiteData, SiteLocaleConfig } from '@vuepress/shared';
+import type { HeadAttrsConfig, HeadConfig, HeadTag, HeadTagEmpty, HeadTagNonEmpty, LocaleConfig, LocaleData, PageData, PageFrontmatter, PageHeader, SiteData, SiteLocaleConfig } from '@vuepress/shared';
 export type { HeadConfig, HeadTag, HeadTagEmpty, HeadTagNonEmpty, HeadAttrsConfig, LocaleConfig, LocaleData, PageData, PageFrontmatter, PageHeader, SiteData, SiteLocaleConfig, };
 export * from './app';
 export * from './bundler';
 export * from './page';
 export * from './plugin';
-export * from './plugin-api';
+export * from './pluginApi';
 export * from './theme';
-export * from './theme-api';

package/lib/types/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -14,6 +18,5 @@ __exportStar(require("./app"), exports);
 __exportStar(require("./bundler"), exports);
 __exportStar(require("./page"), exports);
 __exportStar(require("./plugin"), exports);
-__exportStar(require("./plugin-api"), exports);
+__exportStar(require("./pluginApi"), exports);
 __exportStar(require("./theme"), exports);
-__exportStar(require("./theme-api"), exports);

package/lib/types/page.d.ts

@@ -1,9 +1,39 @@
 import type { MarkdownLink } from '@vuepress/markdown';
-import type { PageData, PageFrontmatter } from '@vuepress/shared';
+import type { PageBase, PageData, PageFrontmatter } from '@vuepress/shared';
 /**
  * Vuepress Page
  */
-export interface Page extends PageData {
+export declare type Page<ExtraPageData extends Record<any, any> = Record<never, never>, ExtraPageFrontmatter extends Record<any, any> = Record<string, unknown>, ExtraPageFields extends Record<any, any> = Record<never, never>> = PageBase<ExtraPageFrontmatter> & ExtraPageFields & {
+    /**
+     * Data of the page, which will be available in client code
+     */
+    data: PageData<ExtraPageData, ExtraPageFrontmatter>;
+    /**
+     * Raw Content of the page
+     */
+    content: string;
+    /**
+     * Rendered content of the page
+     */
+    contentRendered: string;
+    /**
+     * Date of the page, in 'yyyy-MM-dd' format
+     *
+     * @example '2020-09-09'
+     */
+    date: string;
+    /**
+     * Dependencies of the page
+     */
+    deps: string[];
+    /**
+     * Hoisted tags of the page
+     */
+    hoistedTags: string[];
+    /**
+     * Links of the page
+     */
+    links: MarkdownLink[];
     /**
      * Path of the page that inferred from file path
      *
@@ -21,13 +51,29 @@ export interface Page extends PageData {
      */
     pathLocale: string;
     /**
-     * Absolute path of the source file
+     * Permalink of the page
+     *
+     * 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://router.vuejs.org/api/#meta
+     */
+    routeMeta: Record<string, unknown>;
+    /**
+     * Slug of the page
+     */
+    slug: string;
+    /**
+     * Source file path
      *
      * If the page does not come from a file, it would be `null`
      */
     filePath: string | null;
     /**
-     * Relative path of the source file
+     * Source file path relative to source directory
      *
      * If the page does not come from a file, it would be `null`
      */
@@ -37,15 +83,13 @@ export interface Page extends PageData {
      */
     componentFilePath: string;
     /**
-     * Component relative file path
+     * Component file path relative to temp directory
      */
     componentFilePathRelative: string;
-    /**
-     * Component file content that generated from the source file
-     */
-    componentFileContent: string;
     /**
      * Component file chunk name
+     *
+     * Only take effect in webpack
      */
     componentFileChunkName: string;
     /**
@@ -53,46 +97,48 @@ export interface Page extends PageData {
      */
     dataFilePath: string;
     /**
-     * Page data relative file path
+     * Page data file path relative to temp directory
      */
     dataFilePathRelative: string;
     /**
      * Page data file chunk name
+     *
+     * Only take effect in webpack
      */
     dataFileChunkName: string;
     /**
-     * Page routes file path
+     * Rendered html file path
      */
-    routesFilePath: string;
+    htmlFilePath: string;
     /**
-     * Page routes relative file path
+     * Rendered html file path relative to dest directory
      */
-    routesFilePathRelative: string;
+    htmlFilePathRelative: string;
+};
+/**
+ * Options to create vuepress page
+ */
+export interface PageOptions {
     /**
-     * Content of the page
+     * 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;
+    content?: string;
     /**
-     * Links of the page
+     * Absolute file path of the markdown source file.
      */
-    links: MarkdownLink[];
+    filePath?: string;
     /**
-     * Slug of the page
+     * Default frontmatter of the page, which could be overridden by
+     * the frontmatter of the markdown content.
      */
-    slug: string;
+    frontmatter?: PageFrontmatter;
     /**
-     * Date of the page, in 'yyyy-MM-dd' format
-     *
-     * @example '2020-09-09'
+     * If this option is set, it will be used as the final route path
+     * of the page, ignoring the relative path and permalink.
      */
-    date: string;
-}
-/**
- * Options to create vuepress page
- */
-export interface PageOptions {
     path?: string;
-    filePath?: string;
-    frontmatter?: PageFrontmatter;
-    content?: string;
 }

package/lib/types/plugin.d.ts

@@ -1,5 +1,5 @@
 import type { App } from './app';
-import type { HooksExposed } from './plugin-api';
+import type { HooksExposed } from './pluginApi';
 /**
  * Vuepress plugin
  *
@@ -9,40 +9,21 @@ import type { HooksExposed } from './plugin-api';
  *
  * A plugin package should have a `Plugin` as the default export
  */
-export declare type Plugin<T extends PluginOptions = PluginOptions, U extends PluginObject = PluginObject> = U | PluginFunction<T, U>;
+export declare type Plugin<T extends PluginObject = PluginObject> = T | PluginFunction<T>;
 /**
  * Vuepress plugin function
  *
  * It accepts plugin options and vuepress app, returns plugin object
  */
-export declare type PluginFunction<T extends PluginOptions = PluginOptions, U extends PluginObject = PluginObject> = (pluginConfig: Partial<T>, app: App) => U;
+export declare type PluginFunction<T extends PluginObject = PluginObject> = (app: App) => T;
 /**
  * Vuepress plugin object
  */
 export interface PluginObject extends Partial<HooksExposed> {
     name: string;
     multiple?: boolean;
-    plugins?: PluginConfig[];
 }
 /**
- * Vuepress plugin options
- *
- * It can be set by user in user config, and will be passed to plugin function
- */
-export declare type PluginOptions = Record<string, any>;
-/**
- * Plugin config to be used in user config file
- *
- * Users can use this config to control which plugins to be used,
- * and set the plugin options
- *
- * @remark suffix `Config` means this is for user config
- */
-export declare type PluginConfig<T extends PluginOptions = PluginOptions> = string | Plugin<T> | [string | Plugin<T>] | [string | Plugin<T>, Partial<T> | boolean];
-/**
- * Normalized plugin config
+ * Config field for plugins
  */
-export declare type PluginConfigNormalized<T extends PluginOptions = PluginOptions> = [
-    Plugin<T> | string,
-    Partial<T> | boolean
-];
+export declare type PluginConfig = (Plugin | Plugin[])[];

package/lib/types/{plugin-api → 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) => Record<string, any>), (app: App) => Record<string, any>>;
-export declare type ExtendsMarkdownHook = Hook<(md: Markdown, app: App) => void>;
-export declare type ExtendsPageOptionsHook = Hook<(filePath: string, app: App) => PromiseOrNot<PageOptions>>;
-export declare type ExtendsPageDataHook = Hook<(page: Page, app: App) => PromiseOrNot<Record<string, any>>>;
+export declare type ReturnObjectHook = Hook<Record<string, any> | ((app: App) => PromiseOrNot<Record<string, any>>), (app: App) => Promise<Record<string, any>>>;
 /**
  * List of hooks
  */
@@ -24,9 +22,11 @@ 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>;
+    extendsBundlerOptions: ExtendsHook<any>;
     clientAppEnhanceFiles: ClientFilesHook;
     clientAppRootComponentFiles: ClientFilesHook;
     clientAppSetupFiles: ClientFilesHook;
@@ -70,6 +70,5 @@ export interface HookQueue<T extends HooksName> {
     items: HookItem<T>[];
     add: (item: HookItem<T>) => void;
     process: (...args: Parameters<HooksNormalized[T]>) => Promise<HooksResult[T][]>;
-    processSync: (...args: Parameters<HooksNormalized[T]>) => HooksResult[T][];
 }
 export {};

package/lib/types/{plugin-api → pluginApi}/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];