@vuepress/core 2.0.0-beta.9 → 2.0.0-rc.0

package/lib/themeApi/resolveThemeLayouts.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveThemeLayouts = void 0;
-const shared_1 = require("@vuepress/shared");
-const utils_1 = require("@vuepress/utils");
-const resolveThemeLayouts = ({ themePath, themePlugin, }) => {
-    if (!themePlugin.layouts) {
-        return [];
-    }
-    // use the layouts component map directly
-    if (shared_1.isPlainObject(themePlugin.layouts)) {
-        return Object.entries(themePlugin.layouts).map(([name, file]) => ({
-            name,
-            path: file,
-        }));
-    }
-    // resolve the layouts directory
-    if (!utils_1.fs.pathExistsSync(themePlugin.layouts)) {
-        throw utils_1.logger.createError(`layouts directory does not exist: ${utils_1.chalk.magenta(themePlugin.layouts)}`);
-    }
-    // load all files in layouts directory
-    const files = utils_1.fs.readdirSync(themePlugin.layouts);
-    // take matched files as theme layouts
-    const layouts = files
-        .filter((file) => /\.(vue|ts|js)$/.test(file))
-        .map((file) => ({
-        name: utils_1.path.trimExt(file),
-        path: utils_1.path.resolve(themePlugin.layouts, file),
-    }));
-    return layouts;
-};
-exports.resolveThemeLayouts = resolveThemeLayouts;

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

@@ -1,30 +0,0 @@
-import type { Markdown } from '@vuepress/markdown';
-import type { SiteData } from '@vuepress/shared';
-import type { BundlerDev, BundlerBuild } from '../bundler';
-import type { Page } from '../page';
-import type { Plugin, PluginOptions, PluginConfig } from '../plugin';
-import type { PluginApi } from '../pluginApi';
-import type { ThemeApi } from '../themeApi';
-import type { AppOptions } from './options';
-import type { AppDir, AppEnv, AppWriteTemp } from './utils';
-/**
- * Vuepress app
- */
-export interface App {
-    version: string;
-    options: AppOptions;
-    dir: AppDir;
-    env: AppEnv;
-    siteData: SiteData;
-    markdown: Markdown;
-    pluginApi: PluginApi;
-    themeApi: ThemeApi;
-    pages: Page[];
-    writeTemp: AppWriteTemp;
-    use: <T extends PluginOptions>(plugin: Plugin<T> | string, config?: Partial<T>) => void;
-    useByConfig: <T extends PluginOptions>(pluginConfig: PluginConfig<T>) => void;
-    init: () => Promise<void>;
-    prepare: () => Promise<void>;
-    dev: () => ReturnType<BundlerDev>;
-    build: () => ReturnType<BundlerBuild>;
-}

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,15 +0,0 @@
-"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]; } });
-}) : (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,31 +0,0 @@
-import type { MarkdownOptions } from '@vuepress/markdown';
-import type { SiteLocaleConfig, SiteLocaleData } from '@vuepress/shared';
-import type { BundlerConfig } from '../bundler';
-import type { ThemeConfig } from '../theme';
-/**
- * Vuepress app options
- */
-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>;
-    source: string;
-    dest: string;
-    temp: string;
-    cache: string;
-    public: string;
-    markdown: MarkdownOptions;
-    debug: boolean;
-    host: string;
-    port: number;
-    open: boolean;
-    pagePatterns: string[];
-    templateDev: string;
-    templateSSR: string;
-    shouldPreload: ((file: string, type: string) => boolean) | boolean;
-    shouldPrefetch: ((file: string, type: string) => boolean) | boolean;
-}
-export declare type AppConfig = Partial<AppOptions> & Pick<AppOptions, 'source'>;

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,29 +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 {
-    isProd: boolean;
-    isTest: boolean;
-    isDev: boolean;
-    isDebug: boolean;
-    nodeEnv: string | undefined;
-}
-/**
- * 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,34 +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 {
-    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;
-}

package/lib/types/bundler.js

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

package/lib/types/index.d.ts

@@ -1,9 +0,0 @@
-import type { HeadConfig, HeadTag, HeadTagEmpty, HeadTagNonEmpty, HeadAttrsConfig, 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';
-export * from './themeApi';

package/lib/types/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;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (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);
-__exportStar(require("./themeApi"), exports);

package/lib/types/page.d.ts

@@ -1,110 +0,0 @@
-import type { MarkdownLink } from '@vuepress/markdown';
-import type { PageData, PageFrontmatter } from '@vuepress/shared';
-/**
- * Vuepress Page
- */
-export interface Page extends PageData {
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * Rendered html file path
-     */
-    htmlFilePath: string;
-    /**
-     * Rendered html file path relative to dest directory
-     */
-    htmlFilePathRelative: string;
-    /**
-     * Component file path
-     */
-    componentFilePath: string;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * Page routes file path
-     */
-    routesFilePath: string;
-    /**
-     * Page routes file path relative to temp directory
-     */
-    routesFilePathRelative: string;
-    /**
-     * Content of the page
-     */
-    content: string;
-    /**
-     * Links of the page
-     */
-    links: MarkdownLink[];
-    /**
-     * Slug of the page
-     */
-    slug: string;
-    /**
-     * Date of the page, in 'yyyy-MM-dd' format
-     *
-     * @example '2020-09-09'
-     */
-    date: string;
-}
-/**
- * Options to create vuepress page
- */
-export interface PageOptions {
-    path?: string;
-    filePath?: string;
-    frontmatter?: PageFrontmatter;
-    content?: 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,48 +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 PluginOptions = PluginOptions, U extends PluginObject = PluginObject> = U | PluginFunction<T, U>;
-/**
- * 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;
-/**
- * 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
- */
-export declare type PluginConfigNormalized<T extends PluginOptions = PluginOptions> = [
-    Plugin<T> | string,
-    Partial<T> | boolean
-];

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,75 +0,0 @@
-import type { Markdown } 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 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>>>;
-/**
- * List of hooks
- */
-export interface Hooks {
-    onInitialized: LifeCycleHook;
-    onPrepared: LifeCycleHook;
-    onWatched: LifeCycleHook<[watchers: Closable[], restart: () => Promise<void>]>;
-    onGenerated: LifeCycleHook;
-    extendsMarkdown: ExtendsMarkdownHook;
-    extendsPageOptions: ExtendsPageOptionsHook;
-    extendsPageData: ExtendsPageDataHook;
-    clientAppEnhanceFiles: ClientFilesHook;
-    clientAppRootComponentFiles: ClientFilesHook;
-    clientAppSetupFiles: ClientFilesHook;
-    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][]>;
-    processSync: (...args: Parameters<HooksNormalized[T]>) => HooksResult[T][];
-}
-export {};

package/lib/types/pluginApi/hooks.js

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

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

@@ -1,2 +0,0 @@
-export * from './hooks';
-export * from './pluginApi';

package/lib/types/pluginApi/index.js

@@ -1,14 +0,0 @@
-"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]; } });
-}) : (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("./hooks"), exports);
-__exportStar(require("./pluginApi"), exports);

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

@@ -1,23 +0,0 @@
-import type { PluginObject } from '../plugin';
-import type { HookQueue, HooksName } from './hooks';
-/**
- * Vuepress plugin system
- */
-export 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;
-}

package/lib/types/pluginApi/pluginApi.js

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

package/lib/types/theme.d.ts

@@ -1,33 +0,0 @@
-import type { Plugin, PluginFunction, PluginObject } from './plugin';
-/**
- * Vuepress theme
- *
- * Theme is a special type of plugin, it should be rather:
- * - an object (`ThemeObject`)
- * - a function that returns an object (`ThemeFunction`)
- *
- * A theme package should have a `Theme` as the default export
- */
-export declare type Theme<T extends ThemeConfig = ThemeConfig> = Plugin<T, ThemeObject>;
-/**
- * Vuepress theme function
- */
-export declare type ThemeFunction<T extends ThemeConfig = ThemeConfig> = PluginFunction<T, ThemeObject>;
-/**
- * Vuepress theme object
- */
-export interface ThemeObject extends PluginObject {
-    multiple?: false;
-    extends?: string;
-    layouts?: string | Record<string, string>;
-}
-/**
- * Theme config to be used in user config file
- *
- * It will be used by a theme itself, but not by vuepress.
- *
- * Vuepress will only transfer this config to theme
- *
- * @remark suffix `Config` means this is for user config
- */
-export declare type ThemeConfig = Record<string, any>;

package/lib/types/theme.js

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

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

@@ -1 +0,0 @@
-export * from './themeApi';

package/lib/types/themeApi/index.js

@@ -1,13 +0,0 @@
-"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]; } });
-}) : (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("./themeApi"), exports);

package/lib/types/themeApi/themeApi.d.ts

@@ -1,44 +0,0 @@
-import type { ThemeObject } from '../theme';
-/**
- * Vuepress theme system
- */
-export interface ThemeApi {
-    /**
-     * Current theme
-     */
-    theme: ThemeInfo;
-    /**
-     * Parent theme
-     */
-    parentTheme: ThemeInfo | null;
-    /**
-     * Layouts
-     */
-    layouts: ThemeLayout[];
-}
-/**
- * Vuepress theme info
- */
-export interface ThemeInfo {
-    /**
-     * Theme plugin object
-     */
-    plugin: ThemeObject;
-    /**
-     * Theme layouts
-     */
-    layouts: ThemeLayout[];
-}
-/**
- * Vuepress theme layout
- */
-export interface ThemeLayout {
-    /**
-     * Path of layout
-     */
-    path: string;
-    /**
-     * Name of layout
-     */
-    name: string;
-}

package/lib/types/themeApi/themeApi.js

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