@halo-dev/ui-plugin-bundler-kit 2.21.0 → 2.21.2

package/src/constants/externals.ts

@@ -0,0 +1,16 @@
+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",
+};
+
+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 fs from "fs";
+import yaml from "js-yaml";
+
+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,
+});