@vuepress/core 2.0.0-beta.48 → 2.0.0-beta.50-pre

package/lib/pluginApi/createPluginApiRegisterHooks.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPluginApiRegisterHooks = void 0;
-const normalizeClientConfigFileHook_1 = require("./normalizeClientConfigFileHook");
-const normalizeReturnObjectHook_1 = require("./normalizeReturnObjectHook");
-const createPluginApiRegisterHooks = (plugins, hooks) => () => {
-    plugins.forEach(({ name: pluginName, alias, define, clientConfigFile, ...commonHooks }) => {
-        /**
-         * hooks that need to be normalized
-         */
-        if (alias) {
-            hooks.alias.add({
-                pluginName,
-                hook: (0, normalizeReturnObjectHook_1.normalizeReturnObjectHook)(alias),
-            });
-        }
-        if (define) {
-            hooks.define.add({
-                pluginName,
-                hook: (0, normalizeReturnObjectHook_1.normalizeReturnObjectHook)(define),
-            });
-        }
-        if (clientConfigFile) {
-            hooks.clientConfigFile.add({
-                pluginName,
-                hook: (0, normalizeClientConfigFileHook_1.normalizeClientConfigFileHook)(clientConfigFile),
-            });
-        }
-        /**
-         * common hooks
-         */
-        Object.entries(commonHooks).forEach(([key, hook]) => {
-            if (hooks[key] && hook) {
-                hooks[key].add({
-                    pluginName,
-                    hook,
-                });
-            }
-        });
-    });
-};
-exports.createPluginApiRegisterHooks = createPluginApiRegisterHooks;

package/lib/pluginApi/index.d.ts

@@ -1,6 +0,0 @@
-export * from './createHookQueue';
-export * from './createPluginApi';
-export * from './createPluginApiHooks';
-export * from './createPluginApiRegisterHooks';
-export * from './normalizeClientConfigFileHook';
-export * from './normalizeReturnObjectHook';

package/lib/pluginApi/index.js

@@ -1,22 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = 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];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./createHookQueue"), exports);
-__exportStar(require("./createPluginApi"), exports);
-__exportStar(require("./createPluginApiHooks"), exports);
-__exportStar(require("./createPluginApiRegisterHooks"), exports);
-__exportStar(require("./normalizeClientConfigFileHook"), exports);
-__exportStar(require("./normalizeReturnObjectHook"), exports);

package/lib/pluginApi/normalizeClientConfigFileHook.d.ts

@@ -1,5 +0,0 @@
-import type { ClientConfigFileHook } from '../types';
-/**
- * Normalize hook for client config file
- */
-export declare const normalizeClientConfigFileHook: (hook: ClientConfigFileHook['exposed']) => ClientConfigFileHook['normalized'];

package/lib/pluginApi/normalizeClientConfigFileHook.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeClientConfigFileHook = void 0;
-const shared_1 = require("@vuepress/shared");
-const utils_1 = require("@vuepress/utils");
-/**
- * Normalize hook for client config file
- */
-const normalizeClientConfigFileHook = (hook) => async (app) => {
-    // resolve clientConfigFile result
-    const clientConfigFileResult = (0, shared_1.isFunction)(hook) ? await hook(app) : hook;
-    // filter files that do not exist
-    const isExisted = await utils_1.fs.pathExists(clientConfigFileResult);
-    if (!isExisted) {
-        throw utils_1.logger.createError(`client config file does not exist: ${clientConfigFileResult}`);
-    }
-    return clientConfigFileResult;
-};
-exports.normalizeClientConfigFileHook = normalizeClientConfigFileHook;

package/lib/pluginApi/normalizeReturnObjectHook.d.ts

@@ -1,5 +0,0 @@
-import type { ReturnObjectHook } from '../types';
-/**
- * Normalize hook that returns an object
- */
-export declare const normalizeReturnObjectHook: (hook: ReturnObjectHook['exposed']) => ReturnObjectHook['normalized'];

package/lib/pluginApi/normalizeReturnObjectHook.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeReturnObjectHook = void 0;
-const shared_1 = require("@vuepress/shared");
-/**
- * Normalize hook that returns an object
- */
-const normalizeReturnObjectHook = (hook) => async (app) => (0, shared_1.isFunction)(hook) ? hook(app) : hook;
-exports.normalizeReturnObjectHook = normalizeReturnObjectHook;

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

@@ -1,98 +0,0 @@
-import type { Markdown } from '@vuepress/markdown';
-import type { SiteData } from '@vuepress/shared';
-import type { Bundler } from '../bundler';
-import type { Page } from '../page';
-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 {
-    /**
-     * 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>;
-    /**
-     * 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/app.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,3 +0,0 @@
-export * from './app';
-export * from './options';
-export * from './utils';

package/lib/types/app/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = 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];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./app"), exports);
-__exportStar(require("./options"), exports);
-__exportStar(require("./utils"), exports);

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

@@ -1,84 +0,0 @@
-import type { MarkdownOptions } from '@vuepress/markdown';
-import type { SiteData } from '@vuepress/shared';
-import type { Bundler } from '../bundler';
-import type { PluginConfig } from '../plugin';
-import type { Theme } from '../theme';
-/**
- * Vuepress app common config that shared between dev and build
- */
-export 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;
-}
-/**
- * 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;
-}
-/**
- * Vuepress app config
- */
-export declare type AppConfig = AppConfigCommon & AppConfigDev & AppConfigBuild;
-/**
- * Vuepress app options
- */
-export declare type AppOptions = Required<AppConfig>;

package/lib/types/app/options.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,36 +0,0 @@
-/**
- * Directory util function
- */
-export declare type AppDirFunction = (...args: string[]) => string;
-/**
- * Directory utils
- */
-export interface AppDir {
-    cache: AppDirFunction;
-    temp: AppDirFunction;
-    source: AppDirFunction;
-    dest: AppDirFunction;
-    public: AppDirFunction;
-    client: AppDirFunction;
-}
-/**
- * Environment flags
- */
-export 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;
-}
-/**
- * Write temp file util
- */
-export declare type AppWriteTemp = (file: string, content: string) => Promise<string>;

package/lib/types/app/utils.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/bundler.d.ts

@@ -1,13 +0,0 @@
-import type { App } from './app';
-/**
- * Vuepress bundler
- *
- * It provides abilities to:
- * - dev: run dev server for development
- * - build: bundle assets for deployment
- */
-export interface Bundler {
-    name: string;
-    dev: (app: App) => Promise<() => Promise<void>>;
-    build: (app: App) => Promise<void>;
-}

package/lib/types/bundler.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/index.d.ts

@@ -1,8 +0,0 @@
-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 './pluginApi';
-export * from './theme';

package/lib/types/index.js

@@ -1,22 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = 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];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./app"), exports);
-__exportStar(require("./bundler"), exports);
-__exportStar(require("./page"), exports);
-__exportStar(require("./plugin"), exports);
-__exportStar(require("./pluginApi"), exports);
-__exportStar(require("./theme"), exports);

package/lib/types/page.d.ts

@@ -1,144 +0,0 @@
-import type { MarkdownLink } from '@vuepress/markdown';
-import type { PageBase, PageData, PageFrontmatter } from '@vuepress/shared';
-/**
- * Vuepress Page
- */
-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
-     *
-     * 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 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;
-    /**
-     * 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;
-    /**
-     * Component file chunk name
-     *
-     * Only take effect in webpack
-     */
-    componentFileChunkName: string;
-    /**
-     * Page data file path
-     */
-    dataFilePath: string;
-    /**
-     * Page data file path relative to temp directory
-     */
-    dataFilePathRelative: string;
-    /**
-     * Page data file chunk name
-     *
-     * Only take effect in webpack
-     */
-    dataFileChunkName: string;
-    /**
-     * Rendered html file path
-     */
-    htmlFilePath: string;
-    /**
-     * Rendered html file path relative to dest directory
-     */
-    htmlFilePathRelative: string;
-};
-/**
- * Options to create vuepress page
- */
-export 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;
-}

package/lib/types/page.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/plugin.d.ts

@@ -1,29 +0,0 @@
-import type { App } from './app';
-import type { HooksExposed } from './pluginApi';
-/**
- * Vuepress plugin
- *
- * A plugin should be rather:
- * - an object (`PluginObject`)
- * - a function that returns an object (`PluginFunction`)
- *
- * A plugin package should have a `Plugin` as the default export
- */
-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 PluginObject = PluginObject> = (app: App) => T;
-/**
- * Vuepress plugin object
- */
-export interface PluginObject extends Partial<HooksExposed> {
-    name: string;
-    multiple?: boolean;
-}
-/**
- * Config field for plugins
- */
-export declare type PluginConfig = (Plugin | Plugin[])[];

package/lib/types/plugin.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,72 +0,0 @@
-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;
-declare type Closable = {
-    close(): void;
-};
-export declare type 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;
-};
-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 ClientConfigFileHook = Hook<string | ((app: App) => PromiseOrNot<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>>>;
-/**
- * List of hooks
- */
-export 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: ReturnObjectHook;
-    define: ReturnObjectHook;
-}
-/**
- * Name of hooks
- */
-export declare type HooksName = keyof Hooks;
-/**
- * Exposed hooks API that can be accessed by a plugin
- */
-export declare type HooksExposed = {
-    [K in HooksName]: Hooks[K]['exposed'];
-};
-/**
- * Normalized hooks
- */
-export declare type HooksNormalized = {
-    [K in HooksName]: Hooks[K]['normalized'];
-};
-/**
- * Result of hooks
- */
-export declare type HooksResult = {
-    [K in HooksName]: Hooks[K]['result'];
-};
-/**
- * Hook item
- */
-export interface HookItem<T extends HooksName> {
-    pluginName: string;
-    hook: HooksNormalized[T];
-}
-/**
- * Hook items queue
- */
-export interface HookQueue<T extends HooksName> {
-    name: T;
-    items: HookItem<T>[];
-    add: (item: HookItem<T>) => void;
-    process: (...args: Parameters<HooksNormalized[T]>) => Promise<HooksResult[T][]>;
-}
-export {};