@halo-dev/ui-plugin-bundler-kit 2.21.1 → 2.22.0

package/README.md

@@ -273,20 +273,20 @@ Both Vite and Rsbuild are excellent build tools, but they have different strengt
 **Example with dynamic imports:**
 
 ```typescript
-import { definePlugin } from '@halo-dev/console-shared';
-import { defineAsyncComponent } from 'vue';
-import { VLoading } from '@halo-dev/components';
+import { definePlugin } from "@halo-dev/ui-shared";
+import { defineAsyncComponent } from "vue";
+import { VLoading } from "@halo-dev/components";
 
 export default definePlugin({
   routes: [
     {
-      parentName: 'Root',
+      parentName: "Root",
       route: {
-        path: 'demo',
-        name: 'DemoPage',
+        path: "demo",
+        name: "DemoPage",
         // Lazy load heavy components
         component: defineAsyncComponent({
-          loader: () => import('./views/DemoPage.vue'),
+          loader: () => import("./views/DemoPage.vue"),
           loadingComponent: VLoading,
         }),
       },
@@ -306,14 +306,14 @@ export default definePlugin({
 
 ### Summary
 
-| Feature | Vite | Rsbuild |
-|---------|------|---------|
-| Code Splitting | ❌ Limited | ✅ Excellent |
-| Vue Ecosystem | ✅ Excellent | ✅ Good |
-| Build Performance | ✅ Good | ✅ Excellent |
-| Dev Experience | ✅ Excellent | ✅ Excellent |
-| Plugin Ecosystem | ✅ Rich | ✅ Growing |
-| Configuration | ✅ Simple | ⚖️ Moderate |
+| Feature           | Vite         | Rsbuild      |
+| ----------------- | ------------ | ------------ |
+| Code Splitting    | ❌ Limited   | ✅ Excellent |
+| Vue Ecosystem     | ✅ Excellent | ✅ Good      |
+| Build Performance | ✅ Good      | ✅ Excellent |
+| Dev Experience    | ✅ Excellent | ✅ Excellent |
+| Plugin Ecosystem  | ✅ Rich      | ✅ Growing   |
+| Configuration     | ✅ Simple    | ⚖️ Moderate  |
 
 **Recommendation**: Use **Rsbuild** for complex plugins with large frontend codebases, and **Vite** for simpler plugins or when you need extensive Vue ecosystem integration.
 

package/dist/index.d.mts

@@ -1,75 +1,77 @@
-import { Plugin, UserConfig, UserConfigFnObject } from 'vite';
-import * as _rsbuild_core_dist_types_loadConfig from '@rsbuild/core/dist-types/loadConfig';
-import { RsbuildConfig, ConfigParams } from '@rsbuild/core';
+import { ConfigParams, RsbuildConfig } from "@rsbuild/core";
+import { Plugin, UserConfig, UserConfigFnObject } from "vite";
 
+//#region src/legacy.d.ts
 interface HaloUIPluginBundlerKitOptions {
-    outDir?: string | {
-        dev: string;
-        prod: string;
-    };
-    manifestPath?: string;
+  outDir?: string | {
+    dev: string;
+    prod: string;
+  };
+  manifestPath?: string;
 }
 /**
  * @deprecated Use `viteConfig` or `rsbuildConfig` instead.
  */
 declare function HaloUIPluginBundlerKit(options?: HaloUIPluginBundlerKitOptions): Plugin;
-
-interface ViteUserConfig {
-    /**
-     * Halo plugin manifest path.
-     *
-     * @default "../src/main/resources/plugin.yaml"
-     */
-    manifestPath?: string;
-    /**
-     * Custom Vite config.
-     */
-    vite: UserConfig | UserConfigFnObject;
+//#endregion
+//#region src/rsbuild.d.ts
+interface RsBuildUserConfig {
+  /**
+   * Halo plugin manifest path.
+   *
+   * @default "../src/main/resources/plugin.yaml"
+   */
+  manifestPath?: string;
+  /**
+   * Custom Rsbuild config.
+   */
+  rsbuild: RsbuildConfig | ((env: ConfigParams) => RsbuildConfig);
 }
 /**
- * Vite config for Halo UI Plugin.
+ * Rsbuild config for Halo UI Plugin.
  *
  * @example
  * ```ts
- * import { viteConfig } from "@halo-dev/ui-plugin-bundler-kit";
+ * import { rsbuildConfig } from "@halo-dev/ui-plugin-bundler-kit";
  *
- * export default viteConfig({
- *   vite: {
- *     // your custom vite config
+ * export default rsbuildConfig({
+ *   rsbuild: {
+ *     // your custom rsbuild config
  *   },
  * });
  * ```
+ * @param config
+ * @returns
  */
-declare function viteConfig(config?: ViteUserConfig): UserConfigFnObject;
-
-interface RsBuildUserConfig {
-    /**
-     * Halo plugin manifest path.
-     *
-     * @default "../src/main/resources/plugin.yaml"
-     */
-    manifestPath?: string;
-    /**
-     * Custom Rsbuild config.
-     */
-    rsbuild: RsbuildConfig | ((env: ConfigParams) => RsbuildConfig);
+declare function rsbuildConfig(config?: RsBuildUserConfig): (env: ConfigParams) => RsbuildConfig;
+//#endregion
+//#region src/vite.d.ts
+interface ViteUserConfig {
+  /**
+   * Halo plugin manifest path.
+   *
+   * @default "../src/main/resources/plugin.yaml"
+   */
+  manifestPath?: string;
+  /**
+   * Custom Vite config.
+   */
+  vite: UserConfig | UserConfigFnObject;
 }
 /**
- * Rsbuild config for Halo UI Plugin.
+ * Vite config for Halo UI Plugin.
  *
  * @example
  * ```ts
- * import { rsbuildConfig } from "@halo-dev/ui-plugin-bundler-kit";
+ * import { viteConfig } from "@halo-dev/ui-plugin-bundler-kit";
  *
- * export default rsbuildConfig({
- *   rsbuild: {
- *     // your custom rsbuild config
+ * export default viteConfig({
+ *   vite: {
+ *     // your custom vite config
  *   },
  * });
  * ```
- * @param config
- * @returns
  */
-declare function rsbuildConfig(config?: RsBuildUserConfig): _rsbuild_core_dist_types_loadConfig.RsbuildConfigSyncFn;
-
-export { HaloUIPluginBundlerKit, rsbuildConfig, viteConfig };
+declare function viteConfig(config?: ViteUserConfig): UserConfigFnObject;
+//#endregion
+export { HaloUIPluginBundlerKit, rsbuildConfig, viteConfig };

package/dist/index.mjs

@@ -1,213 +1,212 @@
-import fs from 'fs';
-import yaml from 'js-yaml';
-import { defineConfig, mergeConfig } from 'vite';
-import Vue from '@vitejs/plugin-vue';
-import { defineConfig as defineConfig$1, mergeRsbuildConfig } from '@rsbuild/core';
-import { pluginVue } from '@rsbuild/plugin-vue';
+import yaml from "js-yaml";
+import fs from "node:fs";
+import { defineConfig, mergeRsbuildConfig } from "@rsbuild/core";
+import { pluginVue } from "@rsbuild/plugin-vue";
+import Vue from "@vitejs/plugin-vue";
+import { defineConfig as defineConfig$1, mergeConfig } from "vite";
 
+//#region src/constants/build.ts
+const DEFAULT_OUT_DIR_DEV = "../build/resources/main/console";
+const DEFAULT_OUT_DIR_PROD = "./build/dist";
+
+//#endregion
+//#region src/constants/externals.ts
 const GLOBALS = {
-  vue: "Vue",
-  "vue-router": "VueRouter",
-  "@vueuse/core": "VueUse",
-  "@vueuse/components": "VueUse",
-  "@vueuse/router": "VueUse",
-  "@halo-dev/console-shared": "HaloConsoleShared",
-  "@halo-dev/components": "HaloComponents",
-  "@halo-dev/api-client": "HaloApiClient",
-  "@halo-dev/richtext-editor": "RichTextEditor",
-  axios: "axios"
+	vue: "Vue",
+	"vue-router": "VueRouter",
+	pinia: "Pinia",
+	"@vueuse/core": "VueUse",
+	"@vueuse/components": "VueUse",
+	"@vueuse/router": "VueUse",
+	"@halo-dev/ui-shared": "HaloUiShared",
+	"@halo-dev/components": "HaloComponents",
+	"@halo-dev/api-client": "HaloApiClient",
+	"@halo-dev/richtext-editor": "RichTextEditor",
+	axios: "axios"
 };
 const EXTERNALS = Object.keys(GLOBALS);
 
+//#endregion
+//#region src/constants/halo-plugin.ts
 const DEFAULT_MANIFEST_PATH = "../src/main/resources/plugin.yaml";
 
-const DEFAULT_OUT_DIR_DEV = "../build/resources/main/console";
-const DEFAULT_OUT_DIR_PROD = "./build/dist";
-
+//#endregion
+//#region src/utils/halo-plugin.ts
 function getHaloPluginManifest(manifestPath) {
-  const manifest = yaml.load(
-    fs.readFileSync(manifestPath, "utf8")
-  );
-  return manifest;
+	return yaml.load(fs.readFileSync(manifestPath, "utf8"));
 }
 
+//#endregion
+//#region src/legacy.ts
 const LEGACY_OUT_DIR_PROD = "../src/main/resources/console";
+/**
+* @deprecated Use `viteConfig` or `rsbuildConfig` instead.
+*/
 function HaloUIPluginBundlerKit(options = {}) {
-  return {
-    name: "halo-ui-plugin-bundler-kit",
-    config(config, env) {
-      const isProduction = env.mode === "production";
-      let outDir = isProduction ? LEGACY_OUT_DIR_PROD : DEFAULT_OUT_DIR_DEV;
-      if (options.outDir) {
-        if (typeof options.outDir === "string") {
-          outDir = options.outDir;
-        } else {
-          outDir = isProduction ? options.outDir.prod : options.outDir.dev;
-        }
-      }
-      const manifestPath = options.manifestPath || DEFAULT_MANIFEST_PATH;
-      const manifest = getHaloPluginManifest(manifestPath);
-      return {
-        ...config,
-        define: {
-          "process.env": process.env
-        },
-        build: {
-          outDir,
-          emptyOutDir: true,
-          lib: {
-            entry: "src/index.ts",
-            name: manifest.metadata.name,
-            formats: ["iife"],
-            fileName: () => "main.js"
-          },
-          rollupOptions: {
-            external: EXTERNALS,
-            output: {
-              globals: GLOBALS,
-              extend: true
-            }
-          }
-        }
-      };
-    }
-  };
+	return {
+		name: "halo-ui-plugin-bundler-kit",
+		config(config, env) {
+			const isProduction = env.mode === "production";
+			let outDir = isProduction ? LEGACY_OUT_DIR_PROD : DEFAULT_OUT_DIR_DEV;
+			if (options.outDir) if (typeof options.outDir === "string") outDir = options.outDir;
+			else outDir = isProduction ? options.outDir.prod : options.outDir.dev;
+			const manifest = getHaloPluginManifest(options.manifestPath || DEFAULT_MANIFEST_PATH);
+			return {
+				...config,
+				define: { "process.env": process.env },
+				build: {
+					outDir,
+					emptyOutDir: true,
+					lib: {
+						entry: "src/index.ts",
+						name: manifest.metadata.name,
+						formats: ["iife"],
+						fileName: () => "main.js"
+					},
+					rollupOptions: {
+						external: EXTERNALS,
+						output: {
+							globals: GLOBALS,
+							extend: true
+						}
+					}
+				}
+			};
+		}
+	};
 }
 
-function createVitePresetsConfig(manifestPath) {
-  const manifest = getHaloPluginManifest(manifestPath);
-  return defineConfig(({ mode }) => {
-    const isProduction = mode === "production";
-    return {
-      mode: mode || "production",
-      plugins: [Vue()],
-      define: {
-        "process.env": process.env
-      },
-      build: {
-        outDir: isProduction ? DEFAULT_OUT_DIR_PROD : DEFAULT_OUT_DIR_DEV,
-        emptyOutDir: true,
-        lib: {
-          entry: "src/index.ts",
-          name: manifest.metadata.name,
-          formats: ["iife"],
-          fileName: () => "main.js"
-        },
-        rollupOptions: {
-          external: EXTERNALS,
-          output: {
-            globals: GLOBALS,
-            extend: true
-          }
-        }
-      }
-    };
-  });
+//#endregion
+//#region src/rsbuild.ts
+function createRsbuildPresetsConfig(manifestPath) {
+	const manifest = getHaloPluginManifest(manifestPath);
+	return defineConfig(({ envMode }) => {
+		const outDir = envMode === "production" ? DEFAULT_OUT_DIR_PROD : DEFAULT_OUT_DIR_DEV;
+		return {
+			mode: envMode || "production",
+			plugins: [pluginVue()],
+			source: { entry: { main: "./src/index.ts" } },
+			dev: { hmr: false },
+			performance: { chunkSplit: { strategy: "custom" } },
+			tools: {
+				rspack: {
+					optimization: {
+						splitChunks: { chunks: "async" },
+						moduleIds: "named"
+					},
+					experiments: { rspackFuture: { bundlerInfo: { force: false } } },
+					module: { parser: { javascript: { importMeta: false } } },
+					output: {
+						publicPath: `/plugins/${manifest.metadata.name}/assets/console/`,
+						library: {
+							type: "window",
+							export: "default",
+							name: manifest.metadata.name
+						},
+						globalObject: "window",
+						iife: true
+					}
+				},
+				htmlPlugin: false
+			},
+			output: {
+				distPath: {
+					root: outDir,
+					js: "",
+					css: "",
+					jsAsync: "chunks",
+					cssAsync: "chunks"
+				},
+				cleanDistPath: true,
+				filename: {
+					css: (pathData) => {
+						if (pathData.chunk?.name === "main") return "style.css";
+						return "[name].[contenthash:8].css";
+					},
+					js: (pathData) => {
+						if (pathData.chunk?.name === "main") return "main.js";
+						return "[name].[contenthash:8].js";
+					}
+				},
+				externals: GLOBALS
+			}
+		};
+	});
 }
-function viteConfig(config) {
-  const presetsConfigFn = createVitePresetsConfig(
-    config?.manifestPath || DEFAULT_MANIFEST_PATH
-  );
-  return defineConfig((env) => {
-    const presetsConfig = presetsConfigFn(env);
-    const userConfig = typeof config?.vite === "function" ? config.vite(env) : config?.vite || {};
-    return mergeConfig(presetsConfig, userConfig);
-  });
+/**
+* Rsbuild config for Halo UI Plugin.
+*
+* @example
+* ```ts
+* import { rsbuildConfig } from "@halo-dev/ui-plugin-bundler-kit";
+*
+* export default rsbuildConfig({
+*   rsbuild: {
+*     // your custom rsbuild config
+*   },
+* });
+* ```
+* @param config
+* @returns
+*/
+function rsbuildConfig(config) {
+	const presetsConfigFn = createRsbuildPresetsConfig(config?.manifestPath || DEFAULT_MANIFEST_PATH);
+	return defineConfig((env) => {
+		return mergeRsbuildConfig(presetsConfigFn(env), typeof config?.rsbuild === "function" ? config.rsbuild(env) : config?.rsbuild || {});
+	});
 }
 
-function createRsbuildPresetsConfig(manifestPath) {
-  const manifest = getHaloPluginManifest(manifestPath);
-  return defineConfig$1(({ envMode }) => {
-    const isProduction = envMode === "production";
-    const outDir = isProduction ? DEFAULT_OUT_DIR_PROD : DEFAULT_OUT_DIR_DEV;
-    return {
-      mode: envMode || "production",
-      plugins: [pluginVue()],
-      source: {
-        entry: {
-          main: "./src/index.ts"
-        }
-      },
-      dev: {
-        hmr: false
-      },
-      performance: {
-        chunkSplit: {
-          strategy: "custom"
-        }
-      },
-      tools: {
-        rspack: {
-          optimization: {
-            splitChunks: {
-              chunks: "async"
-            },
-            moduleIds: "named"
-          },
-          experiments: {
-            rspackFuture: {
-              bundlerInfo: {
-                force: false
-              }
-            }
-          },
-          module: {
-            parser: {
-              javascript: {
-                importMeta: false
-              }
-            }
-          },
-          output: {
-            publicPath: `/plugins/${manifest.metadata.name}/assets/console/`,
-            library: {
-              type: "window",
-              export: "default",
-              name: manifest.metadata.name
-            },
-            globalObject: "window",
-            iife: true
-          }
-        },
-        htmlPlugin: false
-      },
-      output: {
-        distPath: {
-          root: outDir,
-          js: "",
-          css: "",
-          jsAsync: "chunks",
-          cssAsync: "chunks"
-        },
-        cleanDistPath: true,
-        filename: {
-          css: (pathData) => {
-            if (pathData.chunk?.name === "main") {
-              return "style.css";
-            }
-            return "[name].[contenthash:8].css";
-          },
-          js: (pathData) => {
-            if (pathData.chunk?.name === "main") {
-              return "main.js";
-            }
-            return "[name].[contenthash:8].js";
-          }
-        },
-        externals: GLOBALS
-      }
-    };
-  });
+//#endregion
+//#region src/vite.ts
+function createVitePresetsConfig(manifestPath) {
+	const manifest = getHaloPluginManifest(manifestPath);
+	return defineConfig$1(({ mode }) => {
+		const isProduction = mode === "production";
+		return {
+			mode: mode || "production",
+			plugins: [Vue()],
+			define: { "process.env.NODE_ENV": "'production'" },
+			build: {
+				outDir: isProduction ? DEFAULT_OUT_DIR_PROD : DEFAULT_OUT_DIR_DEV,
+				emptyOutDir: true,
+				lib: {
+					entry: "src/index.ts",
+					name: manifest.metadata.name,
+					formats: ["iife"],
+					fileName: () => "main.js",
+					cssFileName: "style"
+				},
+				rollupOptions: {
+					external: EXTERNALS,
+					output: {
+						globals: GLOBALS,
+						extend: true
+					}
+				}
+			}
+		};
+	});
 }
-function rsbuildConfig(config) {
-  const presetsConfigFn = createRsbuildPresetsConfig(
-    config?.manifestPath || DEFAULT_MANIFEST_PATH
-  );
-  return defineConfig$1((env) => {
-    const presetsConfig = presetsConfigFn(env);
-    const userConfig = typeof config?.rsbuild === "function" ? config.rsbuild(env) : config?.rsbuild || {};
-    return mergeRsbuildConfig(presetsConfig, userConfig);
-  });
+/**
+* Vite config for Halo UI Plugin.
+*
+* @example
+* ```ts
+* import { viteConfig } from "@halo-dev/ui-plugin-bundler-kit";
+*
+* export default viteConfig({
+*   vite: {
+*     // your custom vite config
+*   },
+* });
+* ```
+*/
+function viteConfig(config) {
+	const presetsConfigFn = createVitePresetsConfig(config?.manifestPath || DEFAULT_MANIFEST_PATH);
+	return defineConfig$1((env) => {
+		return mergeConfig(presetsConfigFn(env), typeof config?.vite === "function" ? config.vite(env) : config?.vite || {});
+	});
 }
 
-export { HaloUIPluginBundlerKit, rsbuildConfig, viteConfig };
+//#endregion
+export { HaloUIPluginBundlerKit, rsbuildConfig, viteConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@halo-dev/ui-plugin-bundler-kit",
-  "version": "2.21.1",
+  "version": "2.22.0",
   "homepage": "https://github.com/halo-dev/halo/tree/main/ui/packages/ui-plugin-bundler-kit#readme",
   "bugs": {
     "url": "https://github.com/halo-dev/halo/issues"
@@ -14,35 +14,30 @@
   "author": "@halo-dev",
   "type": "module",
   "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs"
-    }
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
   },
   "main": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "dependencies": {
-    "js-yaml": "^4.1.0",
-    "@halo-dev/api-client": "2.21.0"
+    "js-yaml": "^4.1.1",
+    "@halo-dev/api-client": "2.22.0"
   },
   "devDependencies": {
-    "@types/js-yaml": "^4.0.9",
-    "unbuild": "^3.5.0"
+    "@types/js-yaml": "^4.0.9"
   },
   "peerDependencies": {
     "@rsbuild/core": "^1.0.0",
     "@rsbuild/plugin-vue": "^1.0.0",
-    "@vitejs/plugin-vue": "^4.0.0 || ^5.0.0",
-    "vite": "^4.0.0 || ^5.0.0 || ^6.0.0"
+    "@vitejs/plugin-vue": "^5.0.0 || ^6.0.0",
+    "vite": "^5.0.0 || ^6.0.0 || ^7.0.0"
   },
   "engines": {
     "node": "^18.0.0 || >=20.0.0"
   },
   "scripts": {
-    "build": "unbuild",
-    "dev": "unbuild --stub"
+    "build": "tsdown",
+    "dev": "tsdown --watch"
   }
 }

package/src/constants/build.ts

@@ -0,0 +1,4 @@
+const DEFAULT_OUT_DIR_DEV = "../build/resources/main/console";
+const DEFAULT_OUT_DIR_PROD = "./build/dist";
+
+export { DEFAULT_OUT_DIR_DEV, DEFAULT_OUT_DIR_PROD };

package/src/constants/externals.ts

@@ -0,0 +1,17 @@
+const GLOBALS = {
+  vue: "Vue",
+  "vue-router": "VueRouter",
+  pinia: "Pinia",
+  "@vueuse/core": "VueUse",
+  "@vueuse/components": "VueUse",
+  "@vueuse/router": "VueUse",
+  "@halo-dev/ui-shared": "HaloUiShared",
+  "@halo-dev/components": "HaloComponents",
+  "@halo-dev/api-client": "HaloApiClient",
+  "@halo-dev/richtext-editor": "RichTextEditor",
+  axios: "axios",
+};
+
+const EXTERNALS = Object.keys(GLOBALS) as string[];
+
+export { EXTERNALS, GLOBALS };

package/src/constants/halo-plugin.ts

@@ -0,0 +1,3 @@
+const DEFAULT_MANIFEST_PATH = "../src/main/resources/plugin.yaml";
+
+export { DEFAULT_MANIFEST_PATH };

package/src/index.ts

@@ -0,0 +1,3 @@
+export { HaloUIPluginBundlerKit } from "./legacy";
+export { rsbuildConfig } from "./rsbuild";
+export { viteConfig } from "./vite";

package/src/legacy.ts

@@ -0,0 +1,69 @@
+import { Plugin } from "vite";
+import { DEFAULT_OUT_DIR_DEV } from "./constants/build";
+import { EXTERNALS, GLOBALS } from "./constants/externals";
+import { DEFAULT_MANIFEST_PATH } from "./constants/halo-plugin";
+import { getHaloPluginManifest } from "./utils/halo-plugin";
+
+const LEGACY_OUT_DIR_PROD = "../src/main/resources/console";
+
+interface HaloUIPluginBundlerKitOptions {
+  outDir?:
+    | string
+    | {
+        dev: string;
+        prod: string;
+      };
+  manifestPath?: string;
+}
+
+/**
+ * @deprecated Use `viteConfig` or `rsbuildConfig` instead.
+ */
+export function HaloUIPluginBundlerKit(
+  options: HaloUIPluginBundlerKitOptions = {}
+): Plugin {
+  return {
+    name: "halo-ui-plugin-bundler-kit",
+    config(config, env) {
+      const isProduction = env.mode === "production";
+
+      let outDir = isProduction ? LEGACY_OUT_DIR_PROD : DEFAULT_OUT_DIR_DEV;
+
+      if (options.outDir) {
+        if (typeof options.outDir === "string") {
+          outDir = options.outDir;
+        } else {
+          outDir = isProduction ? options.outDir.prod : options.outDir.dev;
+        }
+      }
+
+      const manifestPath = options.manifestPath || DEFAULT_MANIFEST_PATH;
+
+      const manifest = getHaloPluginManifest(manifestPath);
+
+      return {
+        ...config,
+        define: {
+          "process.env": process.env,
+        },
+        build: {
+          outDir,
+          emptyOutDir: true,
+          lib: {
+            entry: "src/index.ts",
+            name: manifest.metadata.name,
+            formats: ["iife"],
+            fileName: () => "main.js",
+          },
+          rollupOptions: {
+            external: EXTERNALS,
+            output: {
+              globals: GLOBALS,
+              extend: true,
+            },
+          },
+        },
+      };
+    },
+  };
+}

package/src/rsbuild.ts

@@ -0,0 +1,146 @@
+import {
+  defineConfig,
+  mergeRsbuildConfig,
+  type ConfigParams,
+  type RsbuildConfig,
+  type RsbuildMode,
+} from "@rsbuild/core";
+import { pluginVue } from "@rsbuild/plugin-vue";
+import { DEFAULT_OUT_DIR_DEV, DEFAULT_OUT_DIR_PROD } from "./constants/build";
+import { GLOBALS } from "./constants/externals";
+import { DEFAULT_MANIFEST_PATH } from "./constants/halo-plugin";
+import { getHaloPluginManifest } from "./utils/halo-plugin";
+
+export interface RsBuildUserConfig {
+  /**
+   * Halo plugin manifest path.
+   *
+   * @default "../src/main/resources/plugin.yaml"
+   */
+  manifestPath?: string;
+
+  /**
+   * Custom Rsbuild config.
+   */
+  rsbuild: RsbuildConfig | ((env: ConfigParams) => RsbuildConfig);
+}
+
+function createRsbuildPresetsConfig(manifestPath: string) {
+  const manifest = getHaloPluginManifest(manifestPath);
+
+  return defineConfig(({ envMode }) => {
+    const isProduction = envMode === "production";
+
+    const outDir = isProduction ? DEFAULT_OUT_DIR_PROD : DEFAULT_OUT_DIR_DEV;
+
+    return {
+      mode: (envMode as RsbuildMode) || "production",
+      plugins: [pluginVue()],
+      source: {
+        entry: {
+          main: "./src/index.ts",
+        },
+      },
+      dev: {
+        hmr: false,
+      },
+      performance: {
+        chunkSplit: {
+          strategy: "custom",
+        },
+      },
+      tools: {
+        rspack: {
+          optimization: {
+            splitChunks: {
+              chunks: "async",
+            },
+            moduleIds: "named",
+          },
+          experiments: {
+            rspackFuture: {
+              bundlerInfo: {
+                force: false,
+              },
+            },
+          },
+          module: {
+            parser: {
+              javascript: {
+                importMeta: false,
+              },
+            },
+          },
+          output: {
+            publicPath: `/plugins/${manifest.metadata.name}/assets/console/`,
+            library: {
+              type: "window",
+              export: "default",
+              name: manifest.metadata.name,
+            },
+            globalObject: "window",
+            iife: true,
+          },
+        },
+        htmlPlugin: false,
+      },
+      output: {
+        distPath: {
+          root: outDir,
+          js: "",
+          css: "",
+          jsAsync: "chunks",
+          cssAsync: "chunks",
+        },
+        cleanDistPath: true,
+        filename: {
+          css: (pathData) => {
+            if (pathData.chunk?.name === "main") {
+              return "style.css";
+            }
+            return "[name].[contenthash:8].css";
+          },
+          js: (pathData) => {
+            if (pathData.chunk?.name === "main") {
+              return "main.js";
+            }
+            return "[name].[contenthash:8].js";
+          },
+        },
+        externals: GLOBALS,
+      },
+    };
+  });
+}
+
+/**
+ * Rsbuild config for Halo UI Plugin.
+ *
+ * @example
+ * ```ts
+ * import { rsbuildConfig } from "@halo-dev/ui-plugin-bundler-kit";
+ *
+ * export default rsbuildConfig({
+ *   rsbuild: {
+ *     // your custom rsbuild config
+ *   },
+ * });
+ * ```
+ * @param config
+ * @returns
+ */
+export function rsbuildConfig(
+  config?: RsBuildUserConfig
+): (env: ConfigParams) => RsbuildConfig {
+  const presetsConfigFn = createRsbuildPresetsConfig(
+    config?.manifestPath || DEFAULT_MANIFEST_PATH
+  );
+  return defineConfig((env) => {
+    const presetsConfig = presetsConfigFn(env);
+    const userConfig =
+      typeof config?.rsbuild === "function"
+        ? config.rsbuild(env)
+        : config?.rsbuild || {};
+    return mergeRsbuildConfig(presetsConfig, userConfig);
+  });
+}

package/src/utils/halo-plugin.ts

@@ -0,0 +1,11 @@
+import type { Plugin as HaloPlugin } from "@halo-dev/api-client";
+import yaml from "js-yaml";
+import fs from "node:fs";
+
+export function getHaloPluginManifest(manifestPath: string) {
+  const manifest = yaml.load(
+    fs.readFileSync(manifestPath, "utf8")
+  ) as HaloPlugin;
+
+  return manifest;
+}

package/src/vite.ts

@@ -0,0 +1,85 @@
+import Vue from "@vitejs/plugin-vue";
+import {
+  defineConfig,
+  mergeConfig,
+  UserConfig,
+  UserConfigFnObject,
+} from "vite";
+import { DEFAULT_OUT_DIR_DEV, DEFAULT_OUT_DIR_PROD } from "./constants/build";
+import { EXTERNALS, GLOBALS } from "./constants/externals";
+import { DEFAULT_MANIFEST_PATH } from "./constants/halo-plugin";
+import { getHaloPluginManifest } from "./utils/halo-plugin";
+
+export interface ViteUserConfig {
+  /**
+   * Halo plugin manifest path.
+   *
+   * @default "../src/main/resources/plugin.yaml"
+   */
+  manifestPath?: string;
+
+  /**
+   * Custom Vite config.
+   */
+  vite: UserConfig | UserConfigFnObject;
+}
+
+function createVitePresetsConfig(manifestPath: string) {
+  const manifest = getHaloPluginManifest(manifestPath);
+
+  return defineConfig(({ mode }) => {
+    const isProduction = mode === "production";
+
+    return {
+      mode: mode || "production",
+      plugins: [Vue()],
+      define: { "process.env.NODE_ENV": "'production'" },
+      build: {
+        outDir: isProduction ? DEFAULT_OUT_DIR_PROD : DEFAULT_OUT_DIR_DEV,
+        emptyOutDir: true,
+        lib: {
+          entry: "src/index.ts",
+          name: manifest.metadata.name,
+          formats: ["iife"],
+          fileName: () => "main.js",
+          cssFileName: "style",
+        },
+        rollupOptions: {
+          external: EXTERNALS,
+          output: {
+            globals: GLOBALS,
+            extend: true,
+          },
+        },
+      },
+    };
+  });
+}
+
+/**
+ * Vite config for Halo UI Plugin.
+ *
+ * @example
+ * ```ts
+ * import { viteConfig } from "@halo-dev/ui-plugin-bundler-kit";
+ *
+ * export default viteConfig({
+ *   vite: {
+ *     // your custom vite config
+ *   },
+ * });
+ * ```
+ */
+export function viteConfig(config?: ViteUserConfig) {
+  const presetsConfigFn = createVitePresetsConfig(
+    config?.manifestPath || DEFAULT_MANIFEST_PATH
+  );
+  return defineConfig((env) => {
+    const presetsConfig = presetsConfigFn(env);
+    const userConfig =
+      typeof config?.vite === "function"
+        ? config.vite(env)
+        : config?.vite || {};
+    return mergeConfig(presetsConfig, userConfig);
+  });
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "include": ["src"],
+  "exclude": ["**/*.spec.ts"],
+  "compilerOptions": {
+    "outDir": "dist",
+    "target": "ES2020",
+    "module": "ES2020",
+    "moduleResolution": "node",
+    "strict": true,
+    "declaration": true,
+    "sourceMap": true,
+    "noImplicitOverride": true,
+    "noUnusedLocals": true,
+    "esModuleInterop": true,
+    "baseUrl": ".",
+    "resolveJsonModule": true
+  }
+}

package/tsdown.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "tsdown";
+
+export default defineConfig({
+  entry: ["./src/index.ts"],
+  format: ["esm"],
+  dts: {
+    tsgo: true,
+  },
+  exports: true,
+});

package/dist/index.d.ts

@@ -1,75 +0,0 @@
-import { Plugin, UserConfig, UserConfigFnObject } from 'vite';
-import * as _rsbuild_core_dist_types_loadConfig from '@rsbuild/core/dist-types/loadConfig';
-import { RsbuildConfig, ConfigParams } from '@rsbuild/core';
-
-interface HaloUIPluginBundlerKitOptions {
-    outDir?: string | {
-        dev: string;
-        prod: string;
-    };
-    manifestPath?: string;
-}
-/**
- * @deprecated Use `viteConfig` or `rsbuildConfig` instead.
- */
-declare function HaloUIPluginBundlerKit(options?: HaloUIPluginBundlerKitOptions): Plugin;
-
-interface ViteUserConfig {
-    /**
-     * Halo plugin manifest path.
-     *
-     * @default "../src/main/resources/plugin.yaml"
-     */
-    manifestPath?: string;
-    /**
-     * Custom Vite config.
-     */
-    vite: UserConfig | UserConfigFnObject;
-}
-/**
- * Vite config for Halo UI Plugin.
- *
- * @example
- * ```ts
- * import { viteConfig } from "@halo-dev/ui-plugin-bundler-kit";
- *
- * export default viteConfig({
- *   vite: {
- *     // your custom vite config
- *   },
- * });
- * ```
- */
-declare function viteConfig(config?: ViteUserConfig): UserConfigFnObject;
-
-interface RsBuildUserConfig {
-    /**
-     * Halo plugin manifest path.
-     *
-     * @default "../src/main/resources/plugin.yaml"
-     */
-    manifestPath?: string;
-    /**
-     * Custom Rsbuild config.
-     */
-    rsbuild: RsbuildConfig | ((env: ConfigParams) => RsbuildConfig);
-}
-/**
- * Rsbuild config for Halo UI Plugin.
- *
- * @example
- * ```ts
- * import { rsbuildConfig } from "@halo-dev/ui-plugin-bundler-kit";
- *
- * export default rsbuildConfig({
- *   rsbuild: {
- *     // your custom rsbuild config
- *   },
- * });
- * ```
- * @param config
- * @returns
- */
-declare function rsbuildConfig(config?: RsBuildUserConfig): _rsbuild_core_dist_types_loadConfig.RsbuildConfigSyncFn;
-
-export { HaloUIPluginBundlerKit, rsbuildConfig, viteConfig };