@yh-mf/preset 0.0.0-stage → 1.0.1

package/AGENTS.md

@@ -0,0 +1,15 @@
+# AGENTS.md
+
+## Commands
+
+- `pnpm run build` - Build the library for production
+- `pnpm run dev` - Turn on watch mode, watch for changes and rebuild the library
+- `pnpm run test` - Run tests
+- `pnpm run test:watch` - Run tests in watch mode
+
+## Docs
+
+- Rslib: https://rslib.rs/llms.txt
+- Rsbuild: https://rsbuild.rs/llms.txt
+- Rspack: https://rspack.rs/llms.txt
+- Rstest: https://rstest.rs/llms.txt

package/README.md

@@ -1,3 +1,35 @@
-# Temporary Holding Version
+# Rslib project
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+## Setup
+
+Install the dependencies:
+
+```bash
+pnpm install
+```
+
+## Get started
+
+Build the library:
+
+```bash
+pnpm run build
+```
+
+Build the library in watch mode:
+
+```bash
+pnpm run dev
+```
+
+Run tests:
+
+```bash
+pnpm run test
+```
+
+Run tests in watch mode:
+
+```bash
+pnpm run test:watch
+```

package/package.json

@@ -1,6 +1,55 @@
 {
   "name": "@yh-mf/preset",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.1",
+  "description": "",
+  "main": "index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "default": "./src/index.ts"
+    }
+  },
+  "scripts": {},
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "archiver": "^8.0.0",
+    "dayjs": "^1.11.23",
+    "globby": "^16.2.4",
+    "lodash-es": "^4.18.1",
+    "picocolors": "^1.1.1",
+    "unplugin-auto-import": "^21.1.0"
+  },
+  "peerDependencies": {
+    "@module-federation/rsbuild-plugin": "2.8.1",
+    "@rsbuild/core": "^2.3.1",
+    "@rsbuild/plugin-babel": "^2.1.0",
+    "@rsbuild/plugin-sass": "^2.0.1",
+    "@rsbuild/plugin-vue": "^2.0.1",
+    "@rsbuild/plugin-vue-jsx": "^2.0.1"
+  },
+  "devDependencies": {
+    "@module-federation/rsbuild-plugin": "2.8.1",
+    "@rsbuild/core": "^2.3.1",
+    "@rsbuild/plugin-babel": "^2.1.0",
+    "@rsbuild/plugin-sass": "^2.0.1",
+    "@rsbuild/plugin-vue": "^2.0.1",
+    "@rsbuild/plugin-vue-jsx": "^2.0.1",
+    "@rslib/core": "^1.0.6",
+    "@rstest/adapter-rslib": "^0.12.5",
+    "@rstest/core": "^0.12.5",
+    "@types/archiver": "^8.0.0",
+    "@types/lodash-es": "^4.17.12",
+    "@types/node": "^26.6.6",
+    "archiver": "^8.0.0",
+    "dayjs": "^1.11.23",
+    "globby": "^16.2.4",
+    "lodash-es": "^4.18.1",
+    "picocolors": "^1.1.1",
+    "typescript": "^7.0.2",
+    "unplugin-auto-import": "^21.1.0",
+    "uuid": "^14.0.3"
+  }
+}

package/src/exposes/index.ts

@@ -0,0 +1,12 @@
+const reg = /^.*src\/views\//g
+const cwd = process.cwd();
+import { globby } from "globby";
+export const exposes = (await globby([`${cwd}/src/views/**/*.{vue,tsx,jsx}`, `!${cwd}/src/views/**/components/**/*`])).reduce(
+  (acc, curt) => {
+    const key = curt.replace(reg, "./").replace(/\.(vue|tsx|jsx)$/, "");
+    const value = curt.replace(reg, "./src/views/")
+    acc[key] = value;
+    return acc;
+  },
+  {} as Record<string, string>,
+);

package/src/index.ts

@@ -0,0 +1,3 @@
+// export * from "./createMfHostConfig"
+export * from "./useMfRemoteDefineConfig"
+// export * from "./shared"

package/src/plugins/after-build-plugin.ts

@@ -0,0 +1,55 @@
+import { type RsbuildPluginAPI } from "@rsbuild/core";
+import pc from "picocolors";
+
+
+export type Option = {
+  name: string;
+  version: string;
+  description: string;
+  prefix: string;
+  mode: string | undefined;
+  parsed: Record<string, string>;
+}
+
+
+export const afterBuildPlugin = (opt: Option) => ({
+  name: "after-build-plugin",
+  setup(api: RsbuildPluginAPI) {
+    api.onAfterBuild(async (params) => {
+      if (!params.stats?.hasErrors()) {
+        console.log('\n');
+        switch (opt.mode) {
+          case 'sit':
+            console.log("✅ sit环境构建结束");
+            console.log(pc.green(`🚀 预览地址：${opt.parsed.PUBLIC_MF_ENTRY}/${opt.name}/v${opt.version}`));
+          break;
+
+          case 'prod':
+            console.log(pc.bgRed(`⚠️  警告 如果菜单变动需要从sit环境同步到prod环境`))
+            console.log('\n');
+            console.log("✅ 生产构建结束！根据下面步骤进行部署至生产服务器并接入到微前端集群");
+            console.log(pc.green(`🚀 1、请将dist/v${opt.version}.${opt.prefix}.zip 上传至目标服务器中/www/his-platform-fe/${opt.name} 并解压`));
+            console.log(pc.red(`🚀 2、确认服务器中完整路径应该是 /www/his-platform-fe/${opt.name}/v${opt.version}.${opt.prefix}/index.html`));
+            console.log(pc.yellow(`🔗 3、进入预览地址确认您功能是否完整：${opt.parsed.PUBLIC_MF_ENTRY}/${opt.name}/v${opt.version}  注：如果是首次新增的模块是没有该项功能 请先完成步骤4`));
+            console.log(pc.blue(`👉 4、【首次新增模块】登录系统管理员账号；依次进入 系统管理-微前端管理[内]-微前端管理-点击新增按钮-弹窗填入：`));
+            console.log(pc.blue(`  -4.1、应用名称[业务]： ${opt.description}；`))  
+            console.log(pc.blue(`  -4.2、应用名称[系统]： ${opt.name}；`))  
+            console.log(pc.blue(`  -4.3、应用类型：业务子应用；`))  
+            console.log(pc.blue(`  -4.4、模块入口：${opt.parsed.PUBLIC_MF_ENTRY}/${opt.name}`))
+            console.log(pc.blue(`  -4.5、填写完成后保存`))
+            console.log(pc.blue(`  -4.6、在微前端管理页面找到${opt.description}模块并点击当前版本旁边的‘+’ 进入版本发布页面`))
+            console.log(pc.blue(`  -4.7、版本发布页面中点击新增版本`))
+            console.log(pc.blue(`  -4.8、填入版本号：‘v${opt.version}.${opt.prefix}’和你的描述内容后保存`))
+            console.log(pc.blue(`  -4.9、回到版本发布页面中发布你刚才的版本 到此你的子模块就正真的接入微前端集群`))
+            console.log(pc.magenta(`👉 5、【非首次新增模块】登录系统管理员账号；依次进入 系统管理-微前端管理[内]-微前端管理`));
+            console.log(pc.magenta(`  -5.1、在微前端管理页面找到${opt.description}模块并点击当前版本 进入版本发布页面`))
+            console.log(pc.magenta(`  -5.2、版本发布页面中点击新增版本`))
+            console.log(pc.magenta(`  -5.3、填入版本号：‘v${opt.version}.${opt.prefix}’和你的描述内容后保存`))
+            console.log(pc.magenta(`  -5.4、回到版本发布页面中发布你刚才的版本 到此你的子模块就正真的接入微前端集群`))
+          break;  
+        }
+        // 你的后置逻辑：复制文件、读取package.json、上传、版本脚本等
+      }
+    });
+  },
+});

package/src/plugins/clean-all-dist-plugin.ts

@@ -0,0 +1,15 @@
+import { type RsbuildPluginAPI } from "@rsbuild/core";
+import fs from "node:fs";
+import path from "node:path";
+
+export const cleanAllDistPlugin = () => ({
+  name: "after-build-plugin",
+  setup(api: RsbuildPluginAPI) {
+    api.onBeforeBuild(async () => {
+      const rootDist = path.resolve(process.cwd(), 'dist');
+      if (fs.existsSync(rootDist)) {
+        fs.rmSync(rootDist, { recursive: true, force: true });
+      }
+    });
+  },
+});

package/src/plugins/zip-after-build-plugin.ts

@@ -0,0 +1,66 @@
+import { type RsbuildPluginAPI } from "@rsbuild/core";
+import path from "node:path";
+import fs from "node:fs";
+import { ZipArchive } from "archiver";
+
+export type Option = {
+  name: string;
+  version: string;
+  description: string;
+  prefix: string;
+  mode: string | undefined;
+  parsed: Record<string, string>;
+};
+
+
+
+export const zipAfterBuildPlugin = (opt: Option) => ({
+  name: "zip-after-build-plugin",
+  setup(api: RsbuildPluginAPI) {
+    // 产物目录：dist/v1.0.1.11.13.11.32
+    const distRoot = path.resolve(
+      process.cwd(),
+      `dist/v${opt.version}.${opt.prefix}`,
+    );
+    // zip输出路径：dist/v1.0.1.11.13.11.32.zip
+    const zipOutPath = path.resolve(
+      process.cwd(),
+      `dist/v${opt.version}.${opt.prefix}.zip`,
+    );
+
+
+    function zipFolder(sourceDir: string, zipPath: string): Promise<void> {
+      return new Promise((resolve, reject) => {
+        const output = fs.createWriteStream(zipPath);
+        const archive = new ZipArchive({
+          zlib: { level: 9 }, // Sets the compression level.
+        });
+
+        archive.pipe(output);
+        // false：压缩包内直接是文件，外面不套一层文件夹；填字符串则套一层
+        archive.directory(sourceDir, `v${opt.version}.${opt.prefix}`);
+
+        output.on("close", () => {
+          console.log(`✅ 压缩完成：${zipPath}，大小：${archive.pointer()} bytes`);
+          resolve();
+        });
+        archive.on("error", (err: any) => reject(err));
+        archive.finalize();
+      });
+    }
+
+    api.onAfterBuild(async (params) => {
+      // params.hasError 可以判断是否构建失败
+
+      if (opt.mode !== 'prod') return
+      if (!params.stats?.hasErrors()) {
+        console.log("📦 开始压缩目录：", distRoot);
+        try {
+          await zipFolder(distRoot, zipOutPath);
+        } catch (err) {
+          console.error("压缩失败：", err);
+        }
+      }
+    });
+  },
+});

package/src/shared/index.ts

@@ -0,0 +1,14 @@
+import type { MfBaseShared } from "./../type/MfBaseShared";
+
+export const baseShared: MfBaseShared = {
+  vue: { eager: true, singleton: true },
+  pinia: { eager: true, singleton: true },
+  "vue-router": { eager: true, singleton: true },
+};
+
+export function getShared(extra: Record<string, any> = {}) {
+  return {
+    ...baseShared,
+    ...extra,
+  };
+}

package/src/type/CreateMfHostOptions.ts

@@ -0,0 +1,8 @@
+import type { RsbuildConfig } from '@rsbuild/core';
+export interface CreateMfHostOptions {
+  name: string;
+  remotes: Record<string, string>;
+  extraShared?: Record<string, any>;
+  extraPlugins?: any[];
+  rsbuild?: RsbuildConfig;
+}

package/src/type/MfBaseShared.ts

@@ -0,0 +1 @@
+export interface MfBaseShared  extends Record<string, any>{}

package/src/type/MfRemoteOptions.ts

@@ -0,0 +1,3 @@
+export interface MfRemoteOptions {
+  plugins?: any[];
+}

package/src/useMfRemoteDefineConfig/index.ts

@@ -0,0 +1,181 @@
+import { defineConfig, loadEnv, type RsbuildConfig } from "@rsbuild/core";
+import { createModuleFederationConfig, pluginModuleFederation } from "@module-federation/rsbuild-plugin";
+import fs from "node:fs";
+import path from "node:path";
+import AutoImport from "unplugin-auto-import/rspack";
+import { pluginBabel } from "@rsbuild/plugin-babel";
+import { pluginVueJsx } from "@rsbuild/plugin-vue-jsx";
+import { pluginSass } from "@rsbuild/plugin-sass";
+import { pluginVue } from "@rsbuild/plugin-vue";
+import dayjs from "dayjs"
+import { merge } from "lodash-es";
+import pc from "picocolors";
+
+import { afterBuildPlugin } from "./../plugins/after-build-plugin"
+import { MfRemoteOptions } from "../type/MfRemoteOptions";
+import { getShared } from "./../shared";
+import { cleanAllDistPlugin } from "../plugins/clean-all-dist-plugin";
+import { zipAfterBuildPlugin } from "../plugins/zip-after-build-plugin";
+import { exposes } from "./../exposes"
+
+
+export function useMfRemoteDefineConfig(mfRemoteOptions: MfRemoteOptions = {}) {
+  const cwd = process.cwd();
+  const prefix = dayjs().format("M.D.H.mm")
+  const { plugins: extraPlugins = [] } = mfRemoteOptions;
+  const pkgPath = path.join(cwd, "package.json");
+  const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+
+  console.log("exposes", exposes);
+
+  return defineConfig(({ envMode: mode }): RsbuildConfig => {
+    const { parsed, publicVars } = loadEnv({
+      mode,
+      cwd,
+      prefixes: ["PUBLIC_"],
+    });
+    const hostName = `his-platform-fe`;
+    const platName = hostName.replace(/\-/g, "_");
+    const createMfConfig = createModuleFederationConfig({
+      name: platName,
+      remotes: {
+        [platName]: `${platName}@${parsed?.PUBLIC_MF_ENTRY}/${hostName}/mf-manifest.json`,
+      },
+      exposes,
+      dts: false,
+      shared: getShared(),
+    });
+
+
+    let output = {
+      cleanDistPath: true
+    };
+
+    const { name, version, description } = pkg;
+    let assetPrefix, distPath = {}
+    switch (mode) {
+      case "sit":
+        assetPrefix = `${parsed?.PUBLIC_MF_ENTRY}/${name}/v${version}`;
+        distPath = {
+          root: `dist/${name}/v${version}`,
+        };
+
+        console.log(pc.bold(pc.bgGreen(`👏 欢迎使用亚华HIS（MF）微前端集群 ✨`)));
+        console.log('\n');
+        console.log(pc.bold(pc.bgGreen(`正在构建中 请稍后！`)));
+        console.log('\n');
+        merge(output, { assetPrefix, distPath });
+        break;
+      case "prod":
+        
+        assetPrefix = `${parsed?.PUBLIC_MF_ENTRY}/${name}/v${version}.${prefix}`;
+        distPath = {
+          root: `dist/v${version}.${prefix}`,
+        };
+
+        console.log(pc.bold(pc.bgGreen(`👏 欢迎使用亚华HIS（MF）微前端集群 ✨`)));
+        console.log('\n');
+        console.log(pc.bold(pc.bgGreen(`正在构建中 请稍后！`)));
+        console.log('\n');
+        merge(output, { assetPrefix, distPath });
+        break;
+      case "dev":
+        assetPrefix = `/`;
+        console.log(
+          pc.bold(pc.bgGreen(`👏 欢迎使用亚华HIS（MF）微前端集群 ✨`)),
+        );
+        console.log("\n");
+        console.log(
+          pc.whiteBright(
+            `🧑‍💻 当前应用 ${description}(${hostName}) 版本 v${version} `,
+          ),
+        );
+        console.log("\n");
+        console.log(`正在启动中 请稍后！`);
+        console.log("\n");
+        console.log(pc.yellow(`别问为什么这么写，当时它能跑，我就没敢动。`));
+        console.log(
+          pc.strikethrough(pc.yellow(`我不是没思路，我只是想刷会儿手机`)),
+        );
+        console.log(
+          pc.bold(pc.yellow(`联邦模块不打架，依赖不打架，今天就不脱发 🚀`)),
+        );
+        console.log(
+          pc.bold(pc.yellow(`状态同步难搞没关系，实在不行存 LocalStorage`)),
+        );
+        console.log(
+          pc.bold(pc.yellow(`架构设计天花乱坠，上线全靠 try-catch 兜底。`)),
+        );
+        console.log(pc.bold(pc.yellow(`头发珍贵，谨慎重构`)));
+        console.log(pc.bold(pc.yellow(`我不是没思路，我只是想刷会儿手机`)));
+        console.log(
+          pc.bold(pc.yellow(`Bug退散，构建随缘、头发珍贵，谨慎重构`)),
+        );
+        console.log(pc.bold(pc.yellow(`遇事不决，先清缓存`)));
+        console.log(pc.bold(pc.yellow(`调不通时，不妨摆烂十分钟`)));
+        console.log("\n");
+        console.log("\n");
+        merge(output, { assetPrefix });
+        break;
+    }
+
+
+
+    const plugins: any[] = [
+      afterBuildPlugin({ name, version, prefix , parsed, mode, description }),
+      zipAfterBuildPlugin({ name, version, prefix , parsed, mode, description }),
+      cleanAllDistPlugin(),
+      pluginBabel({
+        include: /\.(?:jsx|tsx)$/,
+      }),
+      pluginVue(),
+      pluginVueJsx(),
+      pluginSass(),
+      pluginModuleFederation(createMfConfig),
+      ...(extraPlugins ?? []),
+    ];
+
+    return {
+      plugins,
+      output,
+      performance: {
+        removeConsole: true,
+      },
+      source: {
+        define: merge(parsed, publicVars, {
+          "process.env.PUBLIC_APP_NAME": JSON.stringify(name),
+        }),
+      },
+      resolve: {
+        alias: {
+          "@": path.resolve(cwd, "./src"),
+        },
+      },
+      server: {
+        cors: {
+          origin: "*",
+          methods: ["GET", "POST", "PUT", "DELETE", "OPTIONS", "PATCH"],
+          allowedHeaders: "*",
+          maxAge: 86400,
+          credentials: false,
+        },
+      },
+      tools: {
+        rspack: {
+          plugins: [
+            AutoImport({
+              imports: ["vue", "vue-router", "pinia"],
+              dirs: ["src/composables"],
+              dts: "./src/auto-imports.d.ts",
+              vueTemplate: true,
+            }),
+          ],
+        },
+      },
+    } as RsbuildConfig;
+  });
+}
+
+
+
+

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "lib": ["ES2022"],
+    "target": "ES2022",
+    "module": "ESNext",
+    "noEmit": true,
+    "skipLibCheck": true,
+    "types": ["node"],
+    "useDefineForClassFields": true,
+    "rootDir": "src",
+
+    /* modules */
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": true,
+
+    /* type checking */
+    "noUnusedLocals": true,
+    "noUnusedParameters": true
+  },
+  "include": ["src/**/*", "types/**/*"]
+}