@module-federation/treeshake-frontend 0.0.1

package/README.md

@@ -0,0 +1,101 @@
+# Treeshake Shared Bundling 可视化页面
+
+这是一个前端应用，用于可视化展示一个支持 Tree Shaking 的模块联邦（Module Federation）`shared` 产物打包服务所带来的收益。用户可以通过该页面，直观地对比完整 `shared` 包与经过按需保留导出后 Tree Shaken 的包之间在体积、模块数量和代码内容上的差异。
+
+## 功能特性
+
+- **优雅的输入表单**：支持填写 `shared` 名称、版本号，并通过 Chip/Tag 的形式轻松管理需要保留的导出列表。
+- **高级构建配置**：可展开的侧边栏或面板，允许用户精细调整构建参数，如目标环境、产物格式、是否压缩、排除的外部依赖等。所有配置都会自动持久化到本地存储（localStorage）。
+- **Mock Mode**：内置模拟模式开关。在无法连接到真实后端打包服务时，开启 Mock Mode 可以在本地模拟一次完整的 API 响应，从而无需后端也能完整地体验整个应用的核心交互和数据可视化流程。
+- **收益可视化看板**：
+  - **核心指标对比**：通过动画数字和进度条，动态展示完整 bundle 与 Tree Shaken bundle 的体积（KB）、节省的体积及百分比。
+  - **模块分析**：清晰列出两个 bundle 分别包含的导出模块名和模块数量。
+  - **代码审查器**：并排展示两个 bundle 的 JavaScript 代码，支持语法高亮、一键复制和下载到本地。
+- **伪代码加载示例**：提供一段清晰的伪代码，解释如何在不同环境（浏览器、Node.js）中加载并使用打包服务返回的 JS 产物，帮助用户理解其工作原理。
+- **现代化的 UI/UX**：采用 Glassmorphism（玻璃拟物）、流畅的动画、微交互和响应式设计，确保在桌面和移动设备上都有出色的视觉和操作体验。
+- **浅色/深色主题**：支持一键切换浅色和深色模式，并根据系统偏好自动初始化主题。
+
+## 如何使用
+
+### 1. 设置 API Base URL
+
+本应用通过一个后端服务来获取打包产物。你需要配置该服务的地址，有以下三种方式（优先级从高到低）：
+
+1.  **在页面中配置**：
+    -   在主界面的表单区域，找到并展开 “**高级构建配置**” 面板。
+    -   在 “**Server API Base URL**” 输入框中，填入你的后端服务地址（例如：`http://localhost:3000/tree-shaking-shared`）。
+    -   该配置会自动保存到浏览器的 localStorage（`treeshake_server_url`）中。
+
+2.  **通过环境变量配置**：
+    -   在项目根目录下创建一个 `.env` 文件。
+    -   在文件中添加一行：`VITE_API_BASE_URL=http://localhost:3000/tree-shaking-shared`
+    -   重新启动或构建前端应用即可生效。
+
+3.  **默认地址**：
+    -   如果以上两种方式都未配置，应用将默认尝试连接 `http://localhost:3000/tree-shaking-shared`。
+
+### 2. 使用 Mock Mode（无需后端）
+
+如果你暂时没有可用的后端服务，可以开启页面右上角的 **Mock Mode** 开关。
+
+在此模式下，应用不会发起真实的网络请求，而是使用一个内置的、结构逼真的模拟数据来驱动整个结果展示流程。这对于纯前端开发、UI 调试或功能演示非常有用。
+
+### 3. 调整高级构建配置
+
+在 “**高级构建配置**” 面板中，你可以自定义传递给后端打包服务的构建参数，例如：
+
+-   `target`、`format`、`platform`：用于 esbuild 或其他打包工具的配置。
+-   `minify`：是否开启代码压缩。
+-   `External 依赖`：需要从打包产物中排除的第三方库（例如 `react`, `react-dom`）。
+-   `请求头 (JSON)`：允许你添加自定义的 HTTP 请求头，例如用于身份验证的 `Authorization`。
+-   `额外构建配置 (JSON)`：一个灵活的 JSON 输入框，用于传递任何与后端服务约定的其他参数。
+
+## 技术栈
+
+-   **框架**: Rsbuild + React
+-   **UI**: Tailwind CSS + shadcn/ui
+-   **图表**: Recharts
+-   **状态管理**: React Hooks
+-   **图标**: Lucide React
+
+## 开发与构建
+
+```bash
+# 安装依赖
+pnpm install
+
+# 启动开发服务器
+pnpm run dev
+
+# 构建生产版本
+pnpm run build
+
+# 预览生产版本
+pnpm run preview
+
+# E2E (rstest + Playwright core)
+pnpm run test:e2e
+```
+
+## 与服务端集成（嵌入 UI）
+
+该包提供一个可注册到 `@module-federation/treeshake-server` 的前端适配器：
+
+```ts
+import { createTreeshakeFrontendAdapter } from "@module-federation/treeshake-frontend/adapter";
+import { createApp } from "@module-federation/treeshake-server";
+
+const app = createApp(
+  { objectStore },
+  {
+    frontendAdapters: [
+      createTreeshakeFrontendAdapter({
+        basePath: "/tree-shaking",
+        distDir: "/path/to/treeshake-frontend/dist",
+      }),
+    ],
+  },
+);
+```
+
+CLI 模式下，`@module-federation/treeshake-server` 会自动注册该前端并以本地文件系统作为输出。

package/adapter/index.ts

@@ -0,0 +1,121 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+export type FrontendAdapter = {
+  id: string;
+  register: (app: { get: (path: string, handler: any) => void }) => void;
+};
+
+export type TreeshakeFrontendAdapterOptions = {
+  basePath?: string;
+  distDir?: string;
+  indexFile?: string;
+  spaFallback?: boolean;
+};
+
+const defaultBasePath = '/tree-shaking';
+
+const contentTypeByExt = (filePath: string) => {
+  if (filePath.endsWith('.html')) return 'text/html; charset=utf-8';
+  if (filePath.endsWith('.js')) return 'application/javascript';
+  if (filePath.endsWith('.css')) return 'text/css';
+  if (filePath.endsWith('.json')) return 'application/json';
+  if (filePath.endsWith('.svg')) return 'image/svg+xml';
+  if (filePath.endsWith('.png')) return 'image/png';
+  if (filePath.endsWith('.jpg') || filePath.endsWith('.jpeg'))
+    return 'image/jpeg';
+  if (filePath.endsWith('.webp')) return 'image/webp';
+  if (filePath.endsWith('.ico')) return 'image/x-icon';
+  return 'application/octet-stream';
+};
+
+const resolveDistDir = (override?: string) => {
+  if (override) return override;
+  const candidate = path.resolve(__dirname, '..');
+  const candidateIndex = path.join(candidate, 'index.html');
+  if (fs.existsSync(candidateIndex)) return candidate;
+  return path.resolve(__dirname, '..', '..', 'dist');
+};
+
+const safeResolve = (rootDir: string, requestPath: string) => {
+  const rootResolved = path.resolve(rootDir);
+  const rel = requestPath.replace(/^\/+/, '');
+  const filePath = path.resolve(rootResolved, rel);
+  if (
+    filePath !== rootResolved &&
+    !filePath.startsWith(`${rootResolved}${path.sep}`)
+  ) {
+    return null;
+  }
+  return filePath;
+};
+
+export function createTreeshakeFrontendAdapter(
+  opts: TreeshakeFrontendAdapterOptions = {},
+): FrontendAdapter {
+  const basePath = opts.basePath ?? defaultBasePath;
+  const normalizedBase = basePath === '/' ? '' : basePath.replace(/\/$/, '');
+  const distDir = resolveDistDir(opts.distDir);
+  const indexFile = opts.indexFile ?? 'index.html';
+  const spaFallback = opts.spaFallback ?? true;
+
+  const handler = async (c: any) => {
+    let requestPath = c.req.path;
+    try {
+      requestPath = decodeURIComponent(requestPath);
+    } catch {
+      return c.text('Not Found', 404);
+    }
+
+    let relPath = requestPath;
+    if (normalizedBase && requestPath.startsWith(normalizedBase)) {
+      relPath = requestPath.slice(normalizedBase.length);
+    }
+    if (!relPath || relPath === '/') {
+      relPath = `/${indexFile}`;
+    }
+
+    const filePath = safeResolve(distDir, relPath);
+    if (filePath) {
+      try {
+        const stat = await fs.promises.stat(filePath);
+        if (stat.isFile()) {
+          const buf = await fs.promises.readFile(filePath);
+          return new Response(buf, {
+            status: 200,
+            headers: { 'Content-Type': contentTypeByExt(filePath) },
+          });
+        }
+      } catch {
+        // fall through to spa fallback
+      }
+    }
+
+    if (!spaFallback) {
+      return c.text('Not Found', 404);
+    }
+
+    const fallbackPath = safeResolve(distDir, `/${indexFile}`);
+    if (!fallbackPath) {
+      return c.text('Not Found', 404);
+    }
+    try {
+      const buf = await fs.promises.readFile(fallbackPath);
+      return new Response(buf, {
+        status: 200,
+        headers: { 'Content-Type': contentTypeByExt(fallbackPath) },
+      });
+    } catch {
+      return c.text('Not Found', 404);
+    }
+  };
+
+  return {
+    id: 'treeshake-frontend',
+    register(app) {
+      const base = normalizedBase || '/';
+      app.get(base, handler);
+      app.get(`${base}/*`, handler);
+    },
+  };
+}

package/dist/adapter/index.d.ts

@@ -0,0 +1,13 @@
+export type FrontendAdapter = {
+    id: string;
+    register: (app: {
+        get: (path: string, handler: any) => void;
+    }) => void;
+};
+export type TreeshakeFrontendAdapterOptions = {
+    basePath?: string;
+    distDir?: string;
+    indexFile?: string;
+    spaFallback?: boolean;
+};
+export declare function createTreeshakeFrontendAdapter(opts?: TreeshakeFrontendAdapterOptions): FrontendAdapter;

package/dist/adapter/index.js

@@ -0,0 +1,128 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.n = (module)=>{
+        var getter = module && module.__esModule ? ()=>module['default'] : ()=>module;
+        __webpack_require__.d(getter, {
+            a: getter
+        });
+        return getter;
+    };
+})();
+(()=>{
+    __webpack_require__.d = (exports1, definition)=>{
+        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+            enumerable: true,
+            get: definition[key]
+        });
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    createTreeshakeFrontendAdapter: ()=>createTreeshakeFrontendAdapter
+});
+const external_node_fs_namespaceObject = require("node:fs");
+var external_node_fs_default = /*#__PURE__*/ __webpack_require__.n(external_node_fs_namespaceObject);
+const external_node_path_namespaceObject = require("node:path");
+var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
+const defaultBasePath = '/tree-shaking';
+const contentTypeByExt = (filePath)=>{
+    if (filePath.endsWith('.html')) return 'text/html; charset=utf-8';
+    if (filePath.endsWith('.js')) return "application/javascript";
+    if (filePath.endsWith('.css')) return 'text/css';
+    if (filePath.endsWith('.json')) return 'application/json';
+    if (filePath.endsWith('.svg')) return 'image/svg+xml';
+    if (filePath.endsWith('.png')) return 'image/png';
+    if (filePath.endsWith('.jpg') || filePath.endsWith('.jpeg')) return 'image/jpeg';
+    if (filePath.endsWith('.webp')) return 'image/webp';
+    if (filePath.endsWith('.ico')) return 'image/x-icon';
+    return 'application/octet-stream';
+};
+const resolveDistDir = (override)=>{
+    if (override) return override;
+    const candidate = external_node_path_default().resolve(__dirname, '..');
+    const candidateIndex = external_node_path_default().join(candidate, 'index.html');
+    if (external_node_fs_default().existsSync(candidateIndex)) return candidate;
+    return external_node_path_default().resolve(__dirname, '..', '..', 'dist');
+};
+const safeResolve = (rootDir, requestPath)=>{
+    const rootResolved = external_node_path_default().resolve(rootDir);
+    const rel = requestPath.replace(/^\/+/, '');
+    const filePath = external_node_path_default().resolve(rootResolved, rel);
+    if (filePath !== rootResolved && !filePath.startsWith(`${rootResolved}${external_node_path_default().sep}`)) return null;
+    return filePath;
+};
+function createTreeshakeFrontendAdapter(opts = {}) {
+    const basePath = opts.basePath ?? defaultBasePath;
+    const normalizedBase = '/' === basePath ? '' : basePath.replace(/\/$/, '');
+    const distDir = resolveDistDir(opts.distDir);
+    const indexFile = opts.indexFile ?? 'index.html';
+    const spaFallback = opts.spaFallback ?? true;
+    const handler = async (c)=>{
+        let requestPath = c.req.path;
+        try {
+            requestPath = decodeURIComponent(requestPath);
+        } catch  {
+            return c.text('Not Found', 404);
+        }
+        let relPath = requestPath;
+        if (normalizedBase && requestPath.startsWith(normalizedBase)) relPath = requestPath.slice(normalizedBase.length);
+        if (!relPath || '/' === relPath) relPath = `/${indexFile}`;
+        const filePath = safeResolve(distDir, relPath);
+        if (filePath) try {
+            const stat = await external_node_fs_default().promises.stat(filePath);
+            if (stat.isFile()) {
+                const buf = await external_node_fs_default().promises.readFile(filePath);
+                return new Response(buf, {
+                    status: 200,
+                    headers: {
+                        'Content-Type': contentTypeByExt(filePath)
+                    }
+                });
+            }
+        } catch  {}
+        if (!spaFallback) return c.text('Not Found', 404);
+        const fallbackPath = safeResolve(distDir, `/${indexFile}`);
+        if (!fallbackPath) return c.text('Not Found', 404);
+        try {
+            const buf = await external_node_fs_default().promises.readFile(fallbackPath);
+            return new Response(buf, {
+                status: 200,
+                headers: {
+                    'Content-Type': contentTypeByExt(fallbackPath)
+                }
+            });
+        } catch  {
+            return c.text('Not Found', 404);
+        }
+    };
+    return {
+        id: 'treeshake-frontend',
+        register (app) {
+            const base = normalizedBase || '/';
+            app.get(base, handler);
+            app.get(`${base}/*`, handler);
+        }
+    };
+}
+exports.createTreeshakeFrontendAdapter = __webpack_exports__.createTreeshakeFrontendAdapter;
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "createTreeshakeFrontendAdapter"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/adapter/index.mjs

@@ -0,0 +1,83 @@
+import node_fs from "node:fs";
+import node_path from "node:path";
+const defaultBasePath = '/tree-shaking';
+const contentTypeByExt = (filePath)=>{
+    if (filePath.endsWith('.html')) return 'text/html; charset=utf-8';
+    if (filePath.endsWith('.js')) return "application/javascript";
+    if (filePath.endsWith('.css')) return 'text/css';
+    if (filePath.endsWith('.json')) return 'application/json';
+    if (filePath.endsWith('.svg')) return 'image/svg+xml';
+    if (filePath.endsWith('.png')) return 'image/png';
+    if (filePath.endsWith('.jpg') || filePath.endsWith('.jpeg')) return 'image/jpeg';
+    if (filePath.endsWith('.webp')) return 'image/webp';
+    if (filePath.endsWith('.ico')) return 'image/x-icon';
+    return 'application/octet-stream';
+};
+const resolveDistDir = (override)=>{
+    if (override) return override;
+    const candidate = node_path.resolve(__dirname, '..');
+    const candidateIndex = node_path.join(candidate, 'index.html');
+    if (node_fs.existsSync(candidateIndex)) return candidate;
+    return node_path.resolve(__dirname, '..', '..', 'dist');
+};
+const safeResolve = (rootDir, requestPath)=>{
+    const rootResolved = node_path.resolve(rootDir);
+    const rel = requestPath.replace(/^\/+/, '');
+    const filePath = node_path.resolve(rootResolved, rel);
+    if (filePath !== rootResolved && !filePath.startsWith(`${rootResolved}${node_path.sep}`)) return null;
+    return filePath;
+};
+function createTreeshakeFrontendAdapter(opts = {}) {
+    const basePath = opts.basePath ?? defaultBasePath;
+    const normalizedBase = '/' === basePath ? '' : basePath.replace(/\/$/, '');
+    const distDir = resolveDistDir(opts.distDir);
+    const indexFile = opts.indexFile ?? 'index.html';
+    const spaFallback = opts.spaFallback ?? true;
+    const handler = async (c)=>{
+        let requestPath = c.req.path;
+        try {
+            requestPath = decodeURIComponent(requestPath);
+        } catch  {
+            return c.text('Not Found', 404);
+        }
+        let relPath = requestPath;
+        if (normalizedBase && requestPath.startsWith(normalizedBase)) relPath = requestPath.slice(normalizedBase.length);
+        if (!relPath || '/' === relPath) relPath = `/${indexFile}`;
+        const filePath = safeResolve(distDir, relPath);
+        if (filePath) try {
+            const stat = await node_fs.promises.stat(filePath);
+            if (stat.isFile()) {
+                const buf = await node_fs.promises.readFile(filePath);
+                return new Response(buf, {
+                    status: 200,
+                    headers: {
+                        'Content-Type': contentTypeByExt(filePath)
+                    }
+                });
+            }
+        } catch  {}
+        if (!spaFallback) return c.text('Not Found', 404);
+        const fallbackPath = safeResolve(distDir, `/${indexFile}`);
+        if (!fallbackPath) return c.text('Not Found', 404);
+        try {
+            const buf = await node_fs.promises.readFile(fallbackPath);
+            return new Response(buf, {
+                status: 200,
+                headers: {
+                    'Content-Type': contentTypeByExt(fallbackPath)
+                }
+            });
+        } catch  {
+            return c.text('Not Found', 404);
+        }
+    };
+    return {
+        id: 'treeshake-frontend',
+        register (app) {
+            const base = normalizedBase || '/';
+            app.get(base, handler);
+            app.get(`${base}/*`, handler);
+        }
+    };
+}
+export { createTreeshakeFrontendAdapter };

package/dist/index.html

@@ -0,0 +1 @@
+<!DOCTYPE html><html><head><link rel="icon" href="/tree-shaking/favicon.ico"><title>Tree Shaking Visualizer</title><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><script defer src="/tree-shaking/static/js/lib-react.c59642e3.js"></script><script defer src="/tree-shaking/static/js/lib-router.75e1e689.js"></script><script defer src="/tree-shaking/static/js/954.dfe166a3.js"></script><script defer src="/tree-shaking/static/js/index.db4e73c6.js"></script><link href="/tree-shaking/static/css/index.16175e0f.css" rel="stylesheet"></head><body><div id="root"></div></body></html>