vite-plugin-mpa/dist/index.d.ts

MPA for vite

import { Plugin } from 'vite';
import { Rewrite } from 'connect-history-api-fallback';

/**
 * MPA Plugin options.
 */

interface MpaOptions {
    /**
     * open path for viteDevServer
     * this plugin will try to open first page for you, but you can still custom, e.g. /index#/about
     * @default firstPagePath
     */
    open: string | boolean;
    /**
     * where to scan
     * @default 'src/pages'
     */
    scanDir: string;
    /**
     * scanFile
     * @default 'main.{js,ts,jsx,tsx}'
     */
    scanFile: string;
    /**
     * html filename, yarn crate @vitejs/app => projectRoot/index.html or MPA projectRoot/pages/${pageName}/index.html
     * @default 'index.html'
     */
    filename: string;
    /**
     * default included entry
     * @default ''
     */
    defaultEntries: string;
    /**
     * rewrite rule list
     * @default []
     */
    rewrites: Rewrite[];
}
declare type UserOptions = Partial<MpaOptions>;

declare function mpa(userOptions?: UserOptions): Plugin;

export { UserOptions as MpaOptions, mpa as default };