@vuepress/core 2.0.0-rc.3 → 2.0.0-rc.31

package/dist/index.d.ts

@@ -1,8 +1,12 @@
-import { MarkdownLink, MarkdownSfcBlocks, MarkdownOptions, Markdown, MarkdownHeader } from '@vuepress/markdown';
-import { PageBase, PageData, PageFrontmatter, SiteData } from '@vuepress/shared';
-export { HeadAttrsConfig, HeadConfig, HeadTag, HeadTagEmpty, HeadTagNonEmpty, LocaleConfig, LocaleData, PageData, PageFrontmatter, PageHeader, SiteData, SiteLocaleConfig } from '@vuepress/shared';
-import { TemplateRenderer } from '@vuepress/utils';
-
+import { HeadAttrsConfig, HeadConfig, HeadTag, HeadTagEmpty, HeadTagNonEmpty, LocaleConfig, LocaleData, PageBase, PageData, PageData as PageData$1, PageFrontmatter, PageFrontmatter as PageFrontmatter$1, PageHeader, PageHeader as PageHeader$1, SiteData, SiteData as SiteData$1, SiteLocaleConfig } from "@vuepress/shared";
+import { TemplateRenderer } from "@vuepress/utils";
+import { Markdown, MarkdownLink, MarkdownOptions, MarkdownSfcBlocks } from "@vuepress/markdown";
+//#region src/types/helpers.d.ts
+type DeepPartialArray<T> = DeepPartial<T>[];
+type DeepPartialObject<T> = { [P in keyof T]?: DeepPartial<T[P]>; };
+type DeepPartial<T> = T extends Function ? T : T extends (infer U)[] ? DeepPartialArray<U> : T extends object ? DeepPartialObject<T> : T | undefined;
+//#endregion
+//#region src/types/bundler.d.ts
 /**
  * Vuepress bundler
  *
@@ -11,179 +15,196 @@ import { TemplateRenderer } from '@vuepress/utils';
  * - build: bundle assets for deployment
  */
 interface Bundler {
-    name: string;
-    dev: (app: App) => Promise<() => Promise<void>>;
-    build: (app: App) => Promise<void>;
+  /**
+   * Name of the bundler
+   */
+  name: string;
+  /**
+   * Type of the bundler, e.g. 'vite' or 'webpack'
+   */
+  type: string;
+  /**
+   * Method to run vuepress app in dev mode, starting dev server
+   */
+  dev: (app: App) => Promise<() => Promise<void>>;
+  /**
+   * Method to run vuepress app in build mode, generating static pages and assets
+   */
+  build: (app: App) => Promise<void>;
+  /**
+   * Merge config helper for current bundler.
+   */
+  mergeConfig: <Config extends Record<string, unknown> = Record<string, unknown>>(currentConfig: Config, newConfig: DeepPartial<Config>) => Config;
 }
-
+type BundlerOptions = Record<string, unknown>;
+//#endregion
+//#region src/types/page.d.ts
 /**
  * Vuepress Page
  */
-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[];
-    /**
-     * Links of the page
-     */
-    links: MarkdownLink[];
-    /**
-     * Markdown env object of the page
-     */
-    markdownEnv: Record<string, unknown>;
-    /**
-     * Path of the page that inferred from file path
-     *
-     * If the page does not come from a file, it would be `null`
-     *
-     * @example '/guide/index.html'
-     */
-    pathInferred: string | null;
-    /**
-     * Locale path prefix of the page
-     *
-     * @example '/getting-started.html' -> '/'
-     * @example '/en/getting-started.html' -> '/en/'
-     * @example '/zh/getting-started.html' -> '/zh/'
-     */
-    pathLocale: string;
-    /**
-     * 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 route record
-     */
-    routeMeta: Record<string, unknown>;
-    /**
-     * Extracted sfc blocks of the page
-     */
-    sfcBlocks: MarkdownSfcBlocks;
-    /**
-     * 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;
-    /**
-     * Source file path relative to source directory
-     *
-     * If the page does not come from a file, it would be `null`
-     */
-    filePathRelative: string | null;
-    /**
-     * Component file path
-     */
-    componentFilePath: string;
-    /**
-     * Component file path relative to temp directory
-     */
-    componentFilePathRelative: string;
-    /**
-     * Chunk file path
-     */
-    chunkFilePath: string;
-    /**
-     * Chunk file path relative to temp directory
-     */
-    chunkFilePathRelative: string;
-    /**
-     * Chunk name
-     *
-     * This will only take effect in webpack
-     */
-    chunkName: string;
-    /**
-     * Rendered html file path
-     */
-    htmlFilePath: string;
-    /**
-     * Rendered html file path relative to dest directory
-     */
-    htmlFilePathRelative: string;
+type Page<ExtraPageData extends Record<string, unknown> = Record<string, unknown>, ExtraPageFrontmatter extends Record<string, unknown> = Record<string, unknown>, ExtraPageFields extends Record<string, unknown> = Record<string, unknown>> = ExtraPageFields & PageBase<ExtraPageFrontmatter> & {
+  /**
+   * Data of the page, which will be available in client code
+   */
+  data: PageData$1<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[];
+  /**
+   * Headers of the page
+   */
+  headers: PageHeader$1[];
+  /**
+   * Links of the page
+   */
+  links: MarkdownLink[];
+  /**
+   * Markdown env object of the page
+   */
+  markdownEnv: Record<string, unknown>;
+  /**
+   * Path of the page that inferred from file path
+   *
+   * If the page does not come from a file, it would be `null`
+   *
+   * @example '/guide/index.html'
+   */
+  pathInferred: string | null;
+  /**
+   * Locale path prefix of the page
+   *
+   * @example '/getting-started.html' -> '/'
+   * @example '/en/getting-started.html' -> '/en/'
+   * @example '/zh/getting-started.html' -> '/zh/'
+   */
+  pathLocale: string;
+  /**
+   * 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 route record
+   */
+  routeMeta: Record<string, unknown>;
+  /**
+   * Extracted sfc blocks of the page
+   */
+  sfcBlocks: MarkdownSfcBlocks;
+  /**
+   * 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;
+  /**
+   * Source file path relative to source directory
+   *
+   * If the page does not come from a file, it would be `null`
+   */
+  filePathRelative: string | null;
+  /**
+   * Chunk file path
+   */
+  chunkFilePath: string;
+  /**
+   * Chunk file path relative to temp directory
+   */
+  chunkFilePathRelative: string;
+  /**
+   * Chunk name
+   *
+   * This will only take effect in webpack
+   */
+  chunkName: string;
+  /**
+   * Rendered html file path
+   */
+  htmlFilePath: string;
+  /**
+   * Rendered html file path relative to dest directory
+   */
+  htmlFilePathRelative: string;
 };
 /**
  * Options to create vuepress page
  */
 interface PageOptions {
-    /**
-     * 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;
-    /**
-     * 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;
+  /**
+   * The raw markdown content of the page.
+   *
+   * If `content` is not provided, the file content of the `filePath`
+   * 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$1;
+  /**
+   * 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;
 }
-
+//#endregion
+//#region src/types/pluginApi/hooks.d.ts
 type PromiseOrNot<T> = Promise<T> | T;
 interface Closable {
-    close(): void;
+  close(): void;
 }
-interface Hook<Exposed, Normalized = Exposed, Result = Normalized extends (...args: any) => infer U ? U extends Promise<infer V> ? V : U : void> {
-    exposed: Exposed;
-    normalized: Normalized;
-    result: Result;
+interface Hook<Exposed, Normalized = Exposed, Result = Normalized extends ((...args: any) => infer U) ? U extends Promise<infer V> ? V : U : never> {
+  exposed: Exposed;
+  normalized: Normalized;
+  result: Result;
 }
 type LifeCycleHook<T extends unknown[] = []> = Hook<(app: App, ...args: T) => PromiseOrNot<void>>;
 type ExtendsHook<T> = Hook<(extendable: T, app: App) => PromiseOrNot<void>>;
 type ClientConfigFileHook = Hook<string | ((app: App) => PromiseOrNot<string>), (app: App) => Promise<string>>;
-type AliasDefineHook = Hook<Record<string, any> | ((app: App, isServer: boolean) => PromiseOrNot<Record<string, any>>), (app: App, isServer: boolean) => Promise<Record<string, any>>>;
+type AliasHook = Hook<Record<string, string> | ((app: App, isServer: boolean) => PromiseOrNot<Record<string, string>>), (app: App, isServer: boolean) => Promise<Record<string, string>>>;
+type DefineHook = Hook<Record<string, unknown> | ((app: App, isServer: boolean) => PromiseOrNot<Record<string, unknown>>), (app: App, isServer: boolean) => Promise<Record<string, unknown>>>;
 /**
  * List of hooks
  */
 interface Hooks {
-    onInitialized: LifeCycleHook;
-    onPrepared: LifeCycleHook;
-    onWatched: LifeCycleHook<[watchers: Closable[], restart: () => Promise<void>]>;
-    onGenerated: LifeCycleHook;
-    extendsMarkdownOptions: ExtendsHook<MarkdownOptions>;
-    extendsMarkdown: ExtendsHook<Markdown>;
-    extendsPageOptions: ExtendsHook<PageOptions>;
-    extendsPage: ExtendsHook<Page>;
-    extendsBundlerOptions: ExtendsHook<any>;
-    clientConfigFile: ClientConfigFileHook;
-    alias: AliasDefineHook;
-    define: AliasDefineHook;
+  onInitialized: LifeCycleHook;
+  onPrepared: LifeCycleHook;
+  onWatched: LifeCycleHook<[watchers: Closable[], restart: () => Promise<void>]>;
+  onPageUpdated: LifeCycleHook<[type: 'create', newPage: Page, oldPage: null] | [type: 'delete', newPage: null, oldPage: Page] | [type: 'update', newPage: Page, oldPage: Page]>;
+  onGenerated: LifeCycleHook;
+  extendsMarkdownOptions: ExtendsHook<MarkdownOptions>;
+  extendsMarkdown: ExtendsHook<Markdown>;
+  extendsPageOptions: ExtendsHook<PageOptions>;
+  extendsPage: ExtendsHook<Page>;
+  extendsBundlerOptions: ExtendsHook<BundlerOptions>;
+  clientConfigFile: ClientConfigFileHook;
+  alias: AliasHook;
+  define: DefineHook;
 }
 /**
  * Name of hooks
@@ -192,60 +213,54 @@ type HooksName = keyof Hooks;
 /**
  * Exposed hooks API that can be accessed by a plugin
  */
-type HooksExposed = {
-    [K in HooksName]: Hooks[K]['exposed'];
-};
+type HooksExposed = { [K in HooksName]: Hooks[K]['exposed']; };
 /**
  * Normalized hooks
  */
-type HooksNormalized = {
-    [K in HooksName]: Hooks[K]['normalized'];
-};
+type HooksNormalized = { [K in HooksName]: Hooks[K]['normalized']; };
 /**
  * Result of hooks
  */
-type HooksResult = {
-    [K in HooksName]: Hooks[K]['result'];
-};
+type HooksResult = { [K in HooksName]: Hooks[K]['result']; };
 /**
  * Hook item
  */
 interface HookItem<T extends HooksName> {
-    pluginName: string;
-    hook: HooksNormalized[T];
+  pluginName: string;
+  hook: HooksNormalized[T];
 }
 /**
  * Hook items queue
  */
 interface HookQueue<T extends HooksName> {
-    name: T;
-    items: HookItem<T>[];
-    add: (item: HookItem<T>) => void;
-    process: (...args: Parameters<HooksNormalized[T]>) => Promise<HooksResult[T][]>;
+  name: T;
+  items: HookItem<T>[];
+  add: (item: HookItem<T>) => void;
+  process: (...args: Parameters<HooksNormalized[T]>) => Promise<HooksResult[T][]>;
 }
-
+//#endregion
+//#region src/types/pluginApi/pluginApi.d.ts
 /**
  * Vuepress plugin system
  */
 interface PluginApi {
-    /**
-     * Plugins that have been used
-     */
-    plugins: PluginObject[];
-    /**
-     * All available hooks
-     */
-    hooks: {
-        [K in HooksName]: HookQueue<K>;
-    };
-    /**
-     * Register hooks of plugins
-     *
-     * Should be invoked before applying a hook
-     */
-    registerHooks: () => void;
+  /**
+   * Plugins that have been used
+   */
+  plugins: PluginObject[];
+  /**
+   * All available hooks
+   */
+  hooks: { [K in HooksName]: HookQueue<K>; };
+  /**
+   * Register hooks of plugins
+   *
+   * Should be invoked before applying a hook
+   */
+  registerHooks: () => void;
 }
-
+//#endregion
+//#region src/types/plugin.d.ts
 /**
  * Vuepress plugin
  *
@@ -255,7 +270,7 @@ interface PluginApi {
  *
  * A plugin package should have a `Plugin` as the default export
  */
-type Plugin<T extends PluginObject = PluginObject> = T | PluginFunction<T>;
+type Plugin<T extends PluginObject = PluginObject> = PluginFunction<T> | T;
 /**
  * Vuepress plugin function
  *
@@ -266,14 +281,21 @@ type PluginFunction<T extends PluginObject = PluginObject> = (app: App) => T;
  * Vuepress plugin object
  */
 interface PluginObject extends Partial<HooksExposed> {
-    name: string;
-    multiple?: boolean;
+  /**
+   * Name of the plugin
+   */
+  name: string;
+  /**
+   * Allow the plugin to be used multiple times or not
+   */
+  multiple?: boolean;
 }
 /**
  * Config field for plugins
  */
 type PluginConfig = (Plugin | Plugin[])[];
-
+//#endregion
+//#region src/types/theme.d.ts
 /**
  * Vuepress theme
  *
@@ -292,135 +314,233 @@ type ThemeFunction = PluginFunction<ThemeObject>;
  * Vuepress theme object
  */
 interface ThemeObject extends Omit<PluginObject, 'multiple'> {
-    /**
-     * Extended parent theme
-     */
-    extends?: Theme;
-    /**
-     * Allow using plugins in theme
-     */
-    plugins?: PluginConfig;
-    /**
-     * Allow overriding default templateBuild
-     */
-    templateBuild?: string;
-    /**
-     * Allow specifying custom template renderer
-     */
-    templateBuildRenderer?: TemplateRenderer;
-    /**
-     * Allow overriding default templateDev
-     */
-    templateDev?: string;
+  /**
+   * Extended parent theme
+   */
+  extends?: Theme;
+  /**
+   * Allow using plugins in theme
+   */
+  plugins?: PluginConfig;
+  /**
+   * Allow overriding default templateBuild
+   */
+  templateBuild?: string;
+  /**
+   * Allow specifying custom template renderer
+   */
+  templateBuildRenderer?: TemplateRenderer;
+  /**
+   * Allow overriding default templateDev
+   */
+  templateDev?: string;
+  /**
+   * Allow specifying user styles, which will be injected into client at the bottom
+   */
+  userStyle?: string;
 }
 /**
  * Resolved theme info
  */
 interface ThemeInfo {
-    /**
-     * Plugins, including theme itself and plugins used by theme
-     */
-    plugins: PluginConfig;
-    /**
-     * Default build template
-     */
-    templateBuild?: string;
-    /**
-     * Default build template renderer
-     */
-    templateBuildRenderer?: TemplateRenderer;
-    /**
-     * Default dev template
-     */
-    templateDev?: string;
+  /**
+   * Plugins, including theme itself and plugins used by theme
+   */
+  plugins: PluginConfig;
+  /**
+   * Default build template
+   */
+  templateBuild?: string;
+  /**
+   * Default build template renderer
+   */
+  templateBuildRenderer?: TemplateRenderer;
+  /**
+   * Default dev template
+   */
+  templateDev?: string;
+  /**
+   * Allow specifying user styles, which will be injected into client at the bottom
+   */
+  userStyle?: string;
 }
-
+//#endregion
+//#region src/types/app/options.d.ts
 /**
  * Vuepress app common config that shared between dev and build
  */
-interface AppConfigCommon extends Partial<SiteData> {
-    source: string;
-    dest?: string;
-    temp?: string;
-    cache?: string;
-    public?: string;
-    debug?: boolean;
-    markdown?: MarkdownOptions;
-    pagePatterns?: string[];
-    permalinkPattern?: string | null;
-    bundler: Bundler;
-    theme: Theme;
-    plugins?: PluginConfig;
+interface AppConfigCommon extends Partial<SiteData$1> {
+  /**
+   * Source directory of the markdown files.
+   *
+   * Vuepress will load markdown files from this directory.
+   *
+   * @required
+   */
+  source: string;
+  /**
+   * Destination directory of the output files.
+   *
+   * Vuepress will output the static site files to this directory.
+   *
+   * @default `${source}/.vuepress/dist`
+   */
+  dest?: string;
+  /**
+   * Temp files directory.
+   *
+   * Vuepress will write temp files to this directory.
+   *
+   * @default `${source}/.vuepress/.temp`
+   */
+  temp?: string;
+  /**
+   * Cache files directory.
+   *
+   * Vuepress will write cache files to this directory.
+   *
+   * @default `${source}/.vuepress/.cache`
+   */
+  cache?: string;
+  /**
+   * Public files directory.
+   *
+   * Vuepress will copy the files from public directory to the output directory.
+   *
+   * @default `${source}/.vuepress/public`
+   */
+  public?: string;
+  /**
+   * Whether to enable debug mode
+   *
+   * @default false
+   */
+  debug?: boolean;
+  /**
+   * Markdown options
+   *
+   * @default {}
+   */
+  markdown?: MarkdownOptions;
+  /**
+   * Patterns to match the markdown files as pages
+   *
+   * @default ['**\/*.md', '!.vuepress']
+   */
+  pagePatterns?: string[];
+  /**
+   * Pattern to generate permalink for pages
+   *
+   * @default null
+   */
+  permalinkPattern?: string | null;
+  /**
+   * Allow specifying user styles, which will be injected into client at the bottom
+   */
+  userStyle?: string | null;
+  /**
+   * Vuepress bundler
+   *
+   * @required
+   */
+  bundler: Bundler;
+  /**
+   * Vuepress theme
+   *
+   * @required
+   */
+  theme: Theme;
+  /**
+   * Vuepress plugins
+   *
+   * @default []
+   */
+  plugins?: PluginConfig;
 }
 /**
  * Vuepress app config for dev
  */
 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;
+  /**
+   * 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
  */
 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 true
-     */
-    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;
-    /**
-     * Specify the HTML template renderer to be used for build
-     *
-     * @default templateRenderer from '@vuepress/utils'
-     */
-    templateBuildRenderer?: TemplateRenderer;
+  /**
+   * Determine what resource files should be preloaded.
+   *
+   * - `false` disables preloading.
+   * - `true` preloads script and style resource files used by the current page.
+   * - A function preloads a candidate file when it returns `true`. It receives
+   *   the output file name and inferred resource type.
+   *
+   * @default true
+   */
+  shouldPreload?: boolean | ((file: string, type: string) => boolean);
+  /**
+   * Determine what resource files should be prefetched.
+   *
+   * - `false` disables prefetching.
+   * - `true` prefetches all async resource files not used by the current page.
+   * - `'as-needed'` prefetches async resource files only for pages linked from
+   *   the current page's Markdown content.
+   * - A function prefetches a candidate file when it returns `true`. It receives
+   *   the output file name and inferred resource type.
+   *
+   * @default 'as-needed'
+   */
+  shouldPrefetch?: boolean | 'as-needed' | ((file: string, type: string) => boolean);
+  /**
+   * Specify the path of the HTML template to be used for build
+   *
+   * @default '@vuepress/client/templates/build.html'
+   */
+  templateBuild?: string;
+  /**
+   * Specify the HTML template renderer to be used for build
+   *
+   * @default `import { templateRenderer } from '@vuepress/utils'`
+   */
+  templateBuildRenderer?: TemplateRenderer;
 }
 /**
- * Vuepress app config
+ * Vuepress app user config.
+ *
+ * It would be provided by user, typically via a config file.
  */
-type AppConfig = AppConfigCommon & AppConfigDev & AppConfigBuild;
+type AppConfig = AppConfigBuild & AppConfigCommon & AppConfigDev;
 /**
- * Vuepress app options
+ * Vuepress app options that resolved from user config.
+ *
+ * It fills all optional fields with a default value.
  */
 type AppOptions = Required<AppConfig>;
-
+//#endregion
+//#region src/types/app/utils.d.ts
 /**
  * Directory util function
  */
@@ -429,389 +549,210 @@ type AppDirFunction = (...args: string[]) => string;
  * Directory utils
  */
 interface AppDir {
-    cache: AppDirFunction;
-    temp: AppDirFunction;
-    source: AppDirFunction;
-    dest: AppDirFunction;
-    public: AppDirFunction;
-    client: AppDirFunction;
+  /**
+   * Resolve file path in cache directory
+   */
+  cache: AppDirFunction;
+  /**
+   * Resolve file path in temp directory
+   */
+  temp: AppDirFunction;
+  /**
+   * Resolve file path in source directory
+   */
+  source: AppDirFunction;
+  /**
+   * Resolve file path in dest directory
+   */
+  dest: AppDirFunction;
+  /**
+   * Resolve file path in public directory
+   */
+  public: AppDirFunction;
+  /**
+   * Resolve file path in client directory
+   */
+  client: AppDirFunction;
 }
 /**
  * Environment flags
  */
 interface AppEnv {
-    /**
-     * 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;
+  /**
+   * 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;
 }
 /**
  * Write temp file util
  */
-type AppWriteTemp = (file: string, content: string) => Promise<string>;
-
-/**
- * Vuepress app
- */
-interface App {
-    /**
-     * Directory utils
-     */
-    dir: AppDir;
-    /**
-     * Environment flags
-     */
-    env: AppEnv;
-    /**
-     * Options that filled all optional fields with a default value
-     */
-    options: AppOptions;
-    /**
-     * Plugin system
-     */
-    pluginApi: PluginApi;
-    /**
-     * 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>;
-    /**
-     * Markdown-it instance.
-     *
-     * Only available after initialization
-     */
-    markdown: Markdown;
-    /**
-     * Page objects.
-     *
-     * Only available after initialization
-     */
-    pages: Page[];
+interface AppWriteTemp {
+  (file: string, content: string): Promise<string>;
+  /**
+   * Clean up the internal write temp cache.
+   *
+   * This should be called when the dev server restarts
+   * to avoid stale cache and to release references to any
+   * in-memory write state so that pending write promises can
+   * complete and be garbage-collected naturally.
+   */
+  cleanup: () => void;
 }
+//#endregion
+//#region src/types/app/app.d.ts
+/**
+ * App base properties, will be available after creation, even before initialization
+ */
+interface AppPropertiesBase {
+  /**
+   * Directory utils.
+   */
+  dir: AppDir;
+  /**
+   * Environment flags.
+   */
+  env: AppEnv;
+  /**
+   * Options that filled all optional fields with a default value.
+   */
+  options: AppOptions;
+  /**
+   * Plugin system.
+   */
+  pluginApi: PluginApi;
+  /**
+   * Site data, which will be used in client side.
+   */
+  siteData: SiteData$1;
+  /**
+   * Version of vuepress core.
+   */
+  version: string;
+  /**
+   * 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>;
+  /**
+   * Use a plugin.
+   *
+   * Should be called before `app.init()`.
+   */
+  use: (plugin: Plugin) => this;
+  /**
+   * Util to write temp file
+   */
+  writeTemp: AppWriteTemp;
+}
+/**
+ * App initialized properties, will only be available after initialization
+ */
+interface AppPropertiesInitialized {
+  /**
+   * Markdown-it instance.
+   *
+   * Only available after initialization
+   */
+  markdown: Markdown;
+  /**
+   * Page objects.
+   *
+   * Only available after initialization
+   */
+  pages: Page[];
+  /**
+   * Page source filepath map.
+   *
+   * Only available after initialization
+   */
+  pagesMap: Record<string, Page | undefined>;
+}
+/**
+ * Vuepress app instance
+ */
+type App = AppPropertiesBase & AppPropertiesInitialized;
 /**
  * Vuepress dev app
  */
 interface DevApp extends App {
-    /**
-     * Start dev server
-     *
-     * Should be called after `app.prepare()`.
-     */
-    dev: () => ReturnType<Bundler['dev']>;
+  /**
+   * Start dev server
+   *
+   * Should be called after `app.prepare()`.
+   */
+  dev: () => ReturnType<Bundler['dev']>;
 }
 /**
  * Vuepress build app
  */
 interface BuildApp extends App {
-    /**
-     * Build static files
-     *
-     * Should be called after `app.prepare()`.
-     */
-    build: () => ReturnType<Bundler['build']>;
+  /**
+   * Build static files
+   *
+   * Should be called after `app.prepare()`.
+   */
+  build: () => ReturnType<Bundler['build']>;
 }
-
-/**
- * Generate client configs temp file
- */
-declare const prepareClientConfigs: (app: App) => Promise<void>;
-
+//#endregion
+//#region src/app/prepare/preparePageChunk.d.ts
 /**
- * Generate page chunk temp file of a single page
+ * Generate temp file if the page does not have a source file
  */
 declare const preparePageChunk: (app: App, page: Page) => Promise<void>;
-
-/**
- * Generate page component temp file of a single page
- */
-declare const preparePageComponent: (app: App, page: Page) => Promise<void>;
-
+//#endregion
+//#region src/app/prepare/prepareRoutes.d.ts
 /**
  * Generate routes temp file
  */
 declare const prepareRoutes: (app: App) => Promise<void>;
-
+//#endregion
+//#region src/app/createBuildApp.d.ts
 /**
- * Generate site data temp file
- */
-declare const prepareSiteData: (app: App) => Promise<void>;
-
-/**
- * Initialize a vuepress app
- *
- * Plugins should be used before initialization.
- */
-declare const appInit: (app: App) => Promise<void>;
-
-/**
- * Prepare files for development or build
- *
- * - page components
- * - routes
- * - site data
- * - other files that generated by plugins
- */
-declare const appPrepare: (app: App) => Promise<void>;
-
-declare const appUse: (app: App, rawPlugin: Plugin) => App;
-
-/**
- * Create vuepress app
- */
-declare const createBaseApp: (config: AppConfig, isBuild?: boolean) => App;
-
-/**
- * Create vuepress build app
+ * Create vuepress build app.
  */
 declare const createBuildApp: (config: AppConfig) => BuildApp;
-
+//#endregion
+//#region src/app/createDevApp.d.ts
 /**
- * Create vuepress dev app
+ * Create vuepress dev app.
  */
 declare const createDevApp: (config: AppConfig) => DevApp;
-
-/**
- * Create directory util function
- */
-declare const createAppDirFunction: (baseDir: string) => AppDirFunction;
+//#endregion
+//#region src/app/resolveAppDir.d.ts
 /**
  * Resolve directory utils for vuepress app
  */
 declare const resolveAppDir: (options: AppOptions) => AppDir;
-
-/**
- * Resolve environment flags for vuepress app
- */
-declare const resolveAppEnv: (options: AppOptions, isBuild: boolean) => AppEnv;
-
-/**
- * Create app options with default values
- */
-declare const resolveAppOptions: ({ base, lang, title, description, head, locales, source, dest, temp, cache, public: publicDir, host, port, open, templateDev, shouldPreload, shouldPrefetch, templateBuild, bundler, debug, markdown, pagePatterns, permalinkPattern, plugins, theme, }: AppConfig) => AppOptions;
-
-/**
- * Resolve pages for vuepress app
- */
-declare const resolveAppPages: (app: App) => Promise<Page[]>;
-
-/**
- * Resolve site data for vuepress app
- *
- * Site data will also be used in client
- */
-declare const resolveAppSiteData: (options: AppOptions) => SiteData;
-
+//#endregion
+//#region src/page/createPage.d.ts
 /**
- * Resolve version of vuepress app
+ * Create vuepress page object
  */
-declare const resolveAppVersion: () => string;
-
-/**
- * Resolve write temp file util for vuepress app
- */
-declare const resolveAppWriteTemp: (dir: AppDir) => AppWriteTemp;
-
-/**
- * Resolve a plugin object according to name / path / module and config
- */
-declare const resolvePluginObject: <T extends PluginObject = PluginObject>(app: App, plugin: Plugin<T>) => T;
-
-/**
- * Resolve theme info and its parent theme info
- */
-declare const resolveThemeInfo: (app: App, theme: Theme) => ThemeInfo;
-
 declare const createPage: (app: App, options: PageOptions) => Promise<Page>;
-
-/**
- * Infer page path according to file path
- */
-declare const inferPagePath: ({ app, filePathRelative, }: {
-    app: App;
-    filePathRelative: string | null;
-}) => {
-    pathInferred: string | null;
-    pathLocale: string;
-};
-
-/**
- * Render page content and extract related info
- */
-declare const renderPageContent: ({ app, content, filePath, filePathRelative, options, }: {
-    app: App;
-    content: string;
-    filePath: string | null;
-    filePathRelative: string | null;
-    options: PageOptions;
-}) => {
-    contentRendered: string;
-    deps: string[];
-    markdownEnv: Record<string, unknown>;
-    frontmatter: PageFrontmatter;
-    headers: MarkdownHeader[];
-    links: MarkdownLink[];
-    sfcBlocks: MarkdownSfcBlocks;
-    title: string;
-};
-
-/**
- * Resolve page data file path
- */
-declare const resolvePageChunkInfo: ({ app, htmlFilePathRelative, }: {
-    app: App;
-    htmlFilePathRelative: string;
-}) => {
-    chunkFilePath: string;
-    chunkFilePathRelative: string;
-    chunkName: string;
-};
-
-/**
- * Resolve page component and related info
- */
-declare const resolvePageComponentInfo: ({ app, htmlFilePathRelative, }: {
-    app: App;
-    htmlFilePathRelative: string;
-}) => Promise<{
-    componentFilePath: string;
-    componentFilePathRelative: string;
-}>;
-
-/**
- * Resolve page date according to frontmatter or file path
- *
- * It will be resolved as 'yyyy-MM-dd' format
- */
-declare const resolvePageDate: ({ frontmatter, filePathRelative, }: {
-    frontmatter: PageFrontmatter;
-    filePathRelative: string | null;
-}) => string;
-
-/**
- * Resolve page file content according to filePath or options content
- */
-declare const resolvePageFileContent: ({ filePath, options, }: {
-    filePath: string | null;
-    options: PageOptions;
-}) => Promise<string>;
-
-/**
- * Resolve absolute and relative path of page file
- */
-declare const resolvePageFilePath: ({ app, options, }: {
-    app: App;
-    options: PageOptions;
-}) => {
-    filePath: string | null;
-    filePathRelative: string | null;
-};
-
-/**
- * Resolve page rendered html file path
- */
-declare const resolvePageHtmlInfo: ({ app, path: pagePath, }: {
-    app: App;
-    path: string;
-}) => {
-    htmlFilePath: string;
-    htmlFilePathRelative: string;
-};
-
-/**
- * Resolve language of page
- */
-declare const resolvePageLang: ({ app, frontmatter, pathLocale, }: {
-    app: App;
-    frontmatter: PageFrontmatter;
-    pathLocale: string;
-}) => string;
-
-/**
- * Resolve the final route path of a page
- */
-declare const resolvePagePath: ({ permalink, pathInferred, options, }: {
-    permalink: string | null;
-    pathInferred: string | null;
-    options: PageOptions;
-}) => string;
-
-/**
- * Resolve page permalink from frontmatter / options / pattern
- */
-declare const resolvePagePermalink: ({ app, frontmatter, slug, date, pathInferred, pathLocale, }: {
-    app: App;
-    frontmatter: PageFrontmatter;
-    slug: string;
-    date: string;
-    pathInferred: string | null;
-    pathLocale: string;
-}) => string | null;
-
-/**
- * Resolve page route meta
- */
-declare const resolvePageRouteMeta: ({ frontmatter, }: {
-    frontmatter: PageFrontmatter;
-}) => Record<string, unknown>;
-
-/**
- * Resolve page slug from filename
- */
-declare const resolvePageSlug: ({ filePathRelative, }: {
-    filePathRelative: string | null;
-}) => string;
-
-/**
- * Create hook queue for plugin system
- */
-declare const createHookQueue: <T extends keyof Hooks>(name: T) => HookQueue<T>;
-
-declare const createPluginApi: () => PluginApi;
-
-declare const createPluginApiHooks: () => PluginApi['hooks'];
-
-declare const createPluginApiRegisterHooks: (plugins: PluginApi['plugins'], hooks: PluginApi['hooks']) => PluginApi['registerHooks'];
-
-/**
- * Normalize alias and define hook
- */
-declare const normalizeAliasDefineHook: (hook: AliasDefineHook['exposed']) => AliasDefineHook['normalized'];
-
+//#endregion
+//#region src/page/renderPageToVue.d.ts
 /**
- * Normalize hook for client config file
+ * Render page to vue component
  */
-declare const normalizeClientConfigFileHook: (hook: ClientConfigFileHook['exposed']) => ClientConfigFileHook['normalized'];
-
-export { type AliasDefineHook, type App, type AppConfig, type AppConfigBuild, type AppConfigCommon, type AppConfigDev, type AppDir, type AppDirFunction, type AppEnv, type AppOptions, type AppWriteTemp, type BuildApp, type Bundler, type ClientConfigFileHook, type DevApp, type ExtendsHook, type Hook, type HookItem, type HookQueue, type Hooks, type HooksExposed, type HooksName, type HooksNormalized, type HooksResult, type LifeCycleHook, type Page, type PageOptions, type Plugin, type PluginApi, type PluginConfig, type PluginFunction, type PluginObject, type Theme, type ThemeFunction, type ThemeInfo, type ThemeObject, appInit, appPrepare, appUse, createAppDirFunction, createBaseApp, createBuildApp, createDevApp, createHookQueue, createPage, createPluginApi, createPluginApiHooks, createPluginApiRegisterHooks, inferPagePath, normalizeAliasDefineHook, normalizeClientConfigFileHook, prepareClientConfigs, preparePageChunk, preparePageComponent, prepareRoutes, prepareSiteData, renderPageContent, resolveAppDir, resolveAppEnv, resolveAppOptions, resolveAppPages, resolveAppSiteData, resolveAppVersion, resolveAppWriteTemp, resolvePageChunkInfo, resolvePageComponentInfo, resolvePageDate, resolvePageFileContent, resolvePageFilePath, resolvePageHtmlInfo, resolvePageLang, resolvePagePath, resolvePagePermalink, resolvePageRouteMeta, resolvePageSlug, resolvePluginObject, resolveThemeInfo };
+declare const renderPageToVue: (app: App, page: Page) => string;
+//#endregion
+//#region src/constants.d.ts
+declare const DEFAULT_IGNORE_PATTERNS: string[];
+//#endregion
+export { type AliasHook, type App, type AppConfig, type AppConfigBuild, type AppConfigCommon, type AppConfigDev, type AppDir, type AppDirFunction, type AppEnv, type AppOptions, type AppPropertiesBase, type AppPropertiesInitialized, type AppWriteTemp, type BuildApp, type Bundler, type BundlerOptions, type ClientConfigFileHook, DEFAULT_IGNORE_PATTERNS, type DefineHook, type DevApp, type ExtendsHook, type HeadAttrsConfig, type HeadConfig, type HeadTag, type HeadTagEmpty, type HeadTagNonEmpty, type Hook, type HookItem, type HookQueue, type Hooks, type HooksExposed, type HooksName, type HooksNormalized, type HooksResult, type LifeCycleHook, type LocaleConfig, type LocaleData, type Page, type PageData, type PageFrontmatter, type PageHeader, type PageOptions, type Plugin, type PluginApi, type PluginConfig, type PluginFunction, type PluginObject, type SiteData, type SiteLocaleConfig, type Theme, type ThemeFunction, type ThemeInfo, type ThemeObject, createBuildApp, createDevApp, createPage, preparePageChunk, prepareRoutes, renderPageToVue, resolveAppDir };