import type { Plugin } from 'vite';

export type RouterOptions = {
	/**
	 * If true, all routes will be lazy loaded by default.
	 *
	 * @default false
	 */
	allLazy?: boolean;
	/**
	 * The base path that is prepended to every URL. Use `'#'` to enable hash-based routing.
	 *
	 * @default undefined
	 */
	base?: string;
	/**
	 * If true, generates the routes in a .js file instead of a .ts file.
	 *
	 * @default false
	 */
	js?: boolean;
	/**
	 * The path to the routes folder.
	 *
	 * @default 'src/routes'
	 */
	path?: string;
	/**
	 * Regular expressions for files to ignore when generating routes.
	 *
	 * @default empty array
	 */
	ignore?: RegExp[];
};

export const router: (options?: RouterOptions) => Plugin;