@lemon-fe/vite-plugin-micro-frontend 1.0.3 → 1.0.5

package/dist/index.d.ts

@@ -20,14 +20,29 @@ interface FederationConfig {
     name: string;
     /** 远程入口文件名 */
     filename?: string;
-    /** 暴露的模块 */
+    /**
+     * 暴露的模块（手动配置）
+     * 会与自动扫描的 exposes 合并，手动配置优先级更高
+     */
     exposes?: Record<string, string>;
+    /**
+     * exposes 目录路径，默认为 src/exposes
+     * 插件会自动扫描该目录下的子目录作为暴露的模块
+     * 例如：src/exposes/Button -> { './Button': './src/exposes/Button/index.tsx' }
+     */
+    exposesDir?: string;
     /** 远程模块配置 */
-    remotes?: Record<string, RemoteConfig>;
+    remotes?: RemoteConfig[];
     /** 共享依赖 */
     shared?: string[];
     /** 生成的文件路径，默认为 src/utils/mf.tsx */
     outputPath?: string;
+    /**
+     * 开发服务器地址，用于拼接远程模块入口
+     * 例如：'http://localhost:5173'
+     * 如果不设置，将使用 remotes 中的 entry 作为完整 URL
+     */
+    devHost?: string;
 }
 /**
  * 路由配置
@@ -85,7 +100,7 @@ interface RoutesTemplateOptions {
  */
 interface MfGeneratorOptions {
     /** 远程模块配置 */
-    remotes: Record<string, RemoteConfig>;
+    remotes: RemoteConfig[];
     /** 生成的文件路径，默认为 src/utils/mf.tsx */
     outputPath?: string;
 }
@@ -130,6 +145,12 @@ declare function pagesRoutesPlugin(options?: RoutesPluginOptions): VitePlugin;
  */
 declare function mfGeneratorPlugin(options: MfGeneratorOptions): VitePlugin;
 
+/**
+ * 模块联邦插件
+ * 整合了 federation 配置、exposes 自动扫描、remotes URL 构建等功能
+ */
+declare function federationPlugin(federationOptions: FederationConfig): PluginOption[];
+
 interface DynamicOptions<P = Record<string, unknown>> {
     /** 动态加载函数，返回一个包含 default 导出的 Promise */
     loader: () => Promise<{
@@ -158,69 +179,52 @@ interface DynamicOptions<P = Record<string, unknown>> {
  */
 declare function dynamic<P = Record<string, unknown>>(options: DynamicOptions<P>): ComponentType<P>;
 
+type WithFalse<T> = {
+  [P in keyof T]?: T[P] | false;
+};
+
+interface BaseIConfig {
+  singular?: boolean;
+  outputPath?: string;
+  publicPath?: string;
+  title?: string;
+  mountElementId?: string;
+  routes?: IRoute[];
+  exportStatic?: {
+    htmlSuffix?: boolean;
+    dynamicRoot?: boolean;
+    supportWin?: boolean;
+  };
+}
+
+type IConfig = WithFalse<BaseIConfig>;
+
+interface IRoute {
+  component?: any;
+  exact?: boolean;
+  path?: string;
+  routes?: IRoute[];
+  wrappers?: string[];
+  title?: string;
+  __toMerge?: boolean;
+  __isDynamic?: boolean;
+  [key: string]: any;
+}
+
+interface IOpts {
+    root: string;
+    relDir?: string;
+    componentPrefix?: string;
+    config: IConfig;
+}
+declare function getRoutes(opts: IOpts): IRoute[];
+
 /**
  * 微前端插件集合
- *
- * 整合了以下功能：
- * 1. HTML 转换 - 移除开发环境下的 React Refresh 脚本
- * 2. 路由自动生成 - 根据 pages 目录自动生成路由配置
- * 3. mf.tsx 生成器 - 自动生成模块联邦工具文件
- * 4. 模块联邦配置 - 使用 @originjs/vite-plugin-federation
- * 5. qiankun 微前端配置
- *
- * @example
- * ```ts
- * // vite.config.ts
- * import { microFrontendPlugins, createMfAlias } from '@anthropic/vite-plugin-micro-frontend';
- *
- * export default defineConfig({
- *   plugins: [
- *     ...microFrontendPlugins({
- *       appName: 'wms',
- *       useDevMode: process.env.NODE_ENV === 'development',
- *       federation: {
- *         name: 'wms',
- *         filename: 'remote.js',
- *         exposes: {
- *           './ProcessingInboundDetail': './src/exposes/processing-inbound-detail/index.tsx',
- *         },
- *         remotes: {
- *           ama: {
- *             aliasName: 'ama',
- *             remoteName: 'ama',
- *             entry: '/app-ama/remote.js',
- *           },
- *           whs: {
- *             aliasName: 'whs',
- *             remoteName: 'whs',
- *             entry: '/app-whs/remote.js',
- *           },
- *         },
- *       },
- *       routes: {
- *         pagesDir: 'src/pages',
- *         outputPath: 'src/routes.ts',
- *       },
- *       qiankun: {
- *         enabled: true,
- *         name: 'wms',
- *       },
- *     }),
- *   ],
- *   resolve: {
- *     alias: {
- *       ...createMfAlias(),
- *     },
- *   },
- * });
- * ```
+ * @param options 微前端插件选项
+ * @returns 插件数组
  */
 declare function microFrontendPlugins(options: MicroFrontendPluginOptions): PluginOption[];
-/**
- * 创建 resolve.alias 配置
- * 用于配置 mf.tsx 的别名
- */
-declare function createMfAlias(mfPath?: string): Record<string, string>;
 
-export { createMfAlias, dynamic, htmlRemoveFreshPlugin, mfGeneratorPlugin, microFrontendPlugins, pagesRoutesPlugin };
-export type { ComponentMetadata, DynamicOptions, FederationConfig, MfGeneratorOptions, MicroFrontendPluginOptions, RemoteConfig, RouteConfig, RoutesPluginOptions, RoutesTemplateOptions, VitePlugin };
+export { dynamic, federationPlugin, getRoutes, htmlRemoveFreshPlugin, mfGeneratorPlugin, microFrontendPlugins, pagesRoutesPlugin };
+export type { ComponentMetadata, DynamicOptions, FederationConfig, IRoute, MfGeneratorOptions, MicroFrontendPluginOptions, RemoteConfig, RouteConfig, RoutesPluginOptions, RoutesTemplateOptions, VitePlugin };