generator-mico-cli 0.2.30 → 0.2.32

package/generators/subapp-h5/templates/eslint.config.ts

@@ -0,0 +1,12 @@
+import baseConfig from '<%= packageScope %>/eslint/react';
+import { defineConfig } from 'eslint/config';
+export default defineConfig([
+  ...baseConfig,
+  {
+    languageOptions: {
+      parserOptions: {
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+]);

package/generators/subapp-h5/templates/mock/user.ts

@@ -0,0 +1,34 @@
+import mockjs from 'mockjs';
+import { z } from 'zod';
+import { defineMock } from 'umi';
+import { baseUrl, tryProxy, validateBody } from '<%= packageScope %>/utils/mock';
+
+export default defineMock({
+  [`POST ${baseUrl}/user`]: async (req, res) => {
+    // 参数校验
+    const schema = z.object({
+      email: z.string(),
+    })
+    if (!validateBody(req.body, schema, res)) return;
+
+    if (await tryProxy(req, res)) return;
+
+    setTimeout(() => {
+      res.json(mockjs.mock({
+        'code': 200,
+        'message': '@cword(10, 20)',
+        'content': {
+          'token': {
+            'accessToken': '@guid()',
+            'refreshToken': '@guid()',
+          },
+          'thirdProfile': {
+            'name': '@cname()',
+            'email': '@email()',
+            'phone': /^1(3|5|8|7|9)\d{9}$/,
+          },
+        },
+      }));
+    }, 500);
+  },
+});

package/generators/subapp-h5/templates/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "<%= appName %>",
+  "version": "0.0.1",
+  "private": true,
+  "author": "<%= author %>",
+  "scripts": {
+    "dev": "umi dev",
+    "build": "npm run build:production",
+    "build:development": "cross-env UMI_ENV=development umi build",
+    "build:production": "cross-env UMI_ENV=production umi build",
+    "build:testing": "cross-env UMI_ENV=testing umi build",
+    "postinstall": "umi setup",
+    "setup": "umi setup",
+    "start": "npm run dev",
+    "lint": "eslint && stylelint \"**/*.{css,less}\"",
+    "lint:fix": "eslint --fix && stylelint \"**/*.{css,less}\" --fix"
+  },
+  "dependencies": {
+    "<%= packageScope %>/common-intl": "workspace:^",
+    "<%= packageScope %>/components": "workspace:^",
+    "<%= packageScope %>/constant": "workspace:^",
+    "<%= packageScope %>/deeplink": "workspace:^",
+    "<%= packageScope %>/domain": "workspace:^",
+    "<%= packageScope %>/js-bridge": "workspace:^",
+    "<%= packageScope %>/request": "workspace:^",
+    "<%= packageScope %>/umi-config": "workspace:^",
+    "<%= packageScope %>/utils": "workspace:^",
+    "react": "catalog:",
+    "react-dom": "catalog:",
+    "umi": "catalog:"
+  },
+  "devDependencies": {
+    "@common-web/sentry": "catalog:",
+    "<%= packageScope %>/eslint": "workspace:^",
+    "@types/react": "catalog:",
+    "@types/react-dom": "catalog:",
+    "@umijs/plugins": "catalog:",
+    "cross-env": "catalog:",
+    "tailwindcss": "catalog:",
+    "tailwindcss-safe-area": "catalog:"
+  }
+}

package/generators/subapp-h5/templates/src/app.tsx

@@ -0,0 +1,14 @@
+import { fetchMultilingualData } from '@/intl';
+
+export function render(oldRender: () => void) {
+  /**
+   * 在应用渲染前加载多语言数据，可根据需要自己调整逻辑
+   */
+  fetchMultilingualData()
+    .then(oldRender)
+    .catch((error: Error) => {
+      console.error('获取多语言文案失败', error);
+      // 即使失败也继续渲染，使用兜底文案
+      oldRender();
+    });
+}

package/generators/subapp-h5/templates/src/intl.ts

@@ -0,0 +1,37 @@
+import { addIntl, init } from '<%= packageScope %>/common-intl';
+
+const { fetchMultilingualData, i18n } = init({
+  tag: '<%= appName %>',
+  indexedDBParams: { dbName: 'i18n_<%= appName %>' },
+});
+
+/**
+ * 1. 调用方法
+ * fetchMultilingualData();
+ *
+ * 2. 使用文案
+ * import intl from '@/intl';
+ * intl.common_hello();
+ * intl.common_welcome_aa('张三');
+ */
+const intl = addIntl(
+  {
+    // ============ 示例文案（可删除） ============
+    common_hello: () =>
+      i18n({
+        key: 'common_hello',
+        defaultMessage: '你好',
+      }),
+    common_welcome_aa: (name: string) =>
+      i18n({
+        key: 'common_welcome_aa',
+        interpolations: [name],
+        defaultMessage: `欢迎, ${name}`,
+      }),
+  },
+  i18n,
+);
+
+export { fetchMultilingualData };
+
+export default intl;

package/generators/subapp-h5/templates/src/layouts/index.tsx

@@ -0,0 +1,10 @@
+import { SentryErrorBoundary } from '@common-web/sentry';
+import { Outlet } from 'umi';
+
+export default function Layout() {
+  return (
+    <SentryErrorBoundary>
+      <Outlet />
+    </SentryErrorBoundary>
+  );
+}

package/generators/subapp-h5/templates/src/pages/index.tsx

@@ -0,0 +1,22 @@
+import intl from '@/intl';
+import { fetchUserInfo, type UserResponse } from '@/services/user';
+import Layout from '<%= packageScope %>/components/Layout';
+import { cn } from '<%= packageScope %>/utils/tailwind';
+import { useState } from 'react';
+
+export default function HomePage() {
+  const [userInfo, setUserInfo] = useState<UserResponse | null>(null);
+
+  const loadUserInfo = async () => {
+    const res = await fetchUserInfo();
+    setUserInfo(res);
+  };
+
+  return (
+    <Layout immersive={false}>
+      <h2 className={cn('text-2xl font-bold text-[16px]')}>app name: <%= appName %></h2>
+      <div onClick={loadUserInfo}>{intl.common_hello()}</div>
+      <div>{JSON.stringify(userInfo)}</div>
+    </Layout>
+  );
+}

package/generators/subapp-h5/templates/src/services/user.ts

@@ -0,0 +1,38 @@
+import { request } from '<%= packageScope %>/request';
+
+//ts
+export interface UserRequest {
+  email: string;
+}
+
+export interface UserResponse {
+  code: number;
+  message: string;
+  content: UserResponseContent;
+}
+
+export interface UserResponseContent {
+  token: UserResponseContentToken;
+  thirdProfile: UserResponseContentThirdProfile;
+}
+
+export interface UserResponseContentToken {
+  accessToken: string;
+  refreshToken: string;
+}
+
+export interface UserResponseContentThirdProfile {
+  name: string;
+  email: string;
+  phone: string;
+}
+
+export async function fetchUserInfo() {
+  const res = await request<UserResponse, UserRequest>('/user', {
+    method: 'POST',
+    data: {
+      email: 'test@micous.com',
+    },
+  });
+  return res;
+}

package/generators/subapp-h5/templates/tailwind.config.js

@@ -0,0 +1,16 @@
+import safeAreaConfig from "tailwindcss-safe-area"
+
+const config = {
+  content: [
+    "./src/**/*.{js,jsx,ts,tsx,less,css}",
+    // 排除 .umi 目录，避免 Tailwind 重建时触发自己的 watch，导致无限循环
+    "!./src/.umi/**",
+    "!./src/.umi-production/**",
+    "./README.md",
+    "./docs/**/*.{md,mdx}",
+    "../../packages/components/src/**/*.{ts,tsx}",
+  ],
+  plugins: [safeAreaConfig],
+}
+
+export default config

package/generators/subapp-h5/templates/tailwind.css

@@ -0,0 +1,7 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+html { font-size: 16px; }
+@supports (font-size: calc(1px + 1vw)) {
+  html { font-size: calc(100vw / 375 * 16); }
+}

package/generators/subapp-h5/templates/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./src/.umi/tsconfig.json"
+}

package/generators/subapp-h5/templates/typings.d.ts

@@ -0,0 +1 @@
+import 'umi/typings';

package/generators/subapp-react/README.md

@@ -0,0 +1,43 @@
+# subapp-react 生成器
+
+在已有 Monorepo 的 `apps/` 下创建 React 子应用。详细说明见 [docs/generators.md#subapp-react](../../docs/generators.md#subapp-react)。
+
+## 快速索引
+
+| 文件 | 职责 |
+|---|---|
+| `index.js` | 生成器主体；含三处对主应用的联动修改 |
+| `meta.json` | `mico list` 展示信息 |
+| `ignore-list.json` | 模板过滤清单 |
+| `templates/homepage/` | 模板根，本生成器以 `homepage` 作为模板目录名 |
+
+## 使用
+
+```bash
+cd <monorepo-root>
+mico create subapp-react
+```
+
+要求 monorepo 根包含 `apps/` 目录。
+
+## 联动修改
+
+非 dry-run 时会尝试原位修改主应用以下文件（任一缺失静默跳过）：
+
+| 文件 | 修改 |
+|---|---|
+| `dev.preset.json` | 向 `presets.full.apps` 追加 `appName` |
+| `apps/layout/mock/pages.ts` | 在兜底路由前插入页面项（`routeKey = cs_web_menu_<snake>_page`） |
+| `apps/layout/mock/api.mock.ts` | 将 `routeKey` 加入 `menu_perms` |
+
+修改完成后 prettier 仅格式化这两个 mock 文件。
+
+## 模板同步
+
+从源仓库的 `apps/homepage` 同步模板：
+
+```bash
+pnpm sync:subapp-react-template -- <source-project-root>
+```
+
+详见 [docs/scripts.md](../../docs/scripts.md)。

package/generators/subapp-react/index.js

@@ -168,6 +168,8 @@ module.exports = class extends Generator {
       const templateData = {
         appName: this.appName,
         AppName: this.appNamePascal,
+        // 用于 MFSU mfName 等需要合法 JS 标识符的场景（不允许 `-`）
+        appNameSnake: this.appName.replace(/-/g, '_'),
         packageScope: this.packageScope,
         devPort: this.devPort,
         micoUiVersion: `^${micoUiVer}`,

package/generators/subapp-react/templates/homepage/README.md

@@ -64,7 +64,7 @@ PORT=8001
 │   ├── app.tsx              # Umi 运行时配置
 │   ├── assets/              # 静态资源
 │   ├── common/              # 公共模块
-│   │   ├── logger.ts        # 日志工具
+│   │   ├── logger.ts        # 日志工具（与 layout 一致：生产首屏 `?debug=1` 可开全量 log/info/warn）
 │   │   ├── mainApp.ts       # 主应用通信
 │   │   └── request.ts       # 请求封装
 │   ├── pages/               # 页面组件
@@ -75,6 +75,10 @@ PORT=8001
 └── tsconfig.json
 ```
 
+## 日志（logger）
+
+与 monorepo 内 **layout** 的 `src/common/logger.ts` 规则对齐：生产默认静默 `log`/`info`/`warn`，`error` 仍输出；首屏 URL 带 **`?debug=1`**（或 `debug=true` / `yes`）可在模块加载时打开全量日志。详见主应用文档 `apps/layout/docs/arch-日志与常量.md`（生成项目后路径以仓库为准）。
+
 ## 微前端配置
 
 本应用作为 qiankun 子应用运行，关键配置：

package/generators/subapp-react/templates/homepage/config/config.dev.ts

@@ -61,6 +61,26 @@ const config: ReturnType<typeof defineConfig> = {
     // @mico-platform/ui 基础样式（使用运行时解析的最新版本号，避免 latest 标签）
     `https://cdn-portal.micoplatform.com/portal-center/mico-ui/${MICO_UI_VERSION}/ui/dist/css/mico-ui.min.css`,
   ],
+
+  /**
+   * @name MFSU 配置
+   * @description
+   * - mfName: 唯一名隔离微前端 runtime，避免多应用共存时 MFSU 容器冲突
+   * - exclude:
+   *   - `@mico-platform/theme`：theme 子路径解析
+   *   - `@mico-platform/ui`：尽量与主应用一起编译
+   *   - `<%= packageScope %>/*`：workspace 包走 webpack 编译，开发态可在 DevTools 直接定位到 packages/* 源码
+   * - shared: React 单例，确保 MFSU 预打包里的组件（如 UI 库）与应用共用同一份 React，否则 useContext 报 null
+   * @doc https://umijs.org/docs/api/config#mfsu
+   */
+  mfsu: {
+    mfName: 'mf_<%= appNameSnake %>',
+    exclude: ['@mico-platform/theme', '@mico-platform/ui', /^<%= packageScope %>\//],
+    shared: {
+      react: { singleton: true },
+      'react-dom': { singleton: true },
+    },
+  },
 };
 
 export default defineConfig(config);

package/generators/subapp-react/templates/homepage/config/config.ts

@@ -118,21 +118,6 @@ const config: ReturnType<typeof defineConfig> = {
    * @description 使用 @mico-platform/ui 的 babel preset，实现组件与图标的按需加载
    */
   extraBabelPresets: ['@mico-platform/ui/babel-preset'],
-
-  /**
-   * @name MFSU 配置
-   * @description
-   * - exclude: theme 子路径解析；ui 尽量与主应用一起编译
-   * - shared: React 单例，确保 MFSU 预打包里的组件（如 UI 库）与应用共用同一份 React，否则 useContext 报 null
-   * @doc https://umijs.org/docs/guides/mfsu
-   */
-  mfsu: {
-    exclude: ['@mico-platform/theme', '@mico-platform/ui'],
-    shared: {
-      react: { singleton: true },
-      'react-dom': { singleton: true },
-    },
-  },
 };
 
 export default defineConfig(config);

package/generators/subapp-react/templates/homepage/src/common/logger.ts

@@ -1,38 +1,70 @@
 /**
  * 日志工具
- * 仅在开发环境下输出日志，生产环境自动静默
+ * - 开发环境：全量输出
+ * - 生产环境：默认仅 `error` 带前缀输出；可在**首屏 URL** 带 query 打开全量 `log` / `info` / `warn`（与 layout `apps/layout` 的 logger 行为一致）
  *
- * 使用 bind 保持原始调用位置，避免错误栈指向 logger 内部
+ * 生产开启方式：首次进入页面时地址栏带 `?debug=1`（或 `debug=true` / `yes`），
+ * 在**本 JS 模块加载时刻**解析一次并固定，后续路由或 query 变更**不会**再切换日志级别（需整页刷新带参 URL）。
+ *
+ * **安全与合规**：`debug` 仅用于临时排障；全量日志可能在控制台暴露业务或个人信息，**勿长期公开或转发**带 `debug` 的生产链接；若接入日志采集需自行脱敏。
+ *
+ * 使用 bind 保持原始调用位置，避免错误栈指向 logger 内部（在开启详细日志时）
  */
 
 const isDev = process.env.NODE_ENV === 'development';
 
-// 空操作函数（生产环境使用）
-const noop = (): void => {};
+/** Query 参数名；与主应用 layout 一致，勿随意改名以免已分享的排障链接失效 */
+export const DEBUG_LOGS_QUERY_KEY = 'debug';
 
-/**
- * 创建带前缀的日志函数
- * 使用 bind 绑定前缀，保持控制台显示正确的调用位置
- */
-const createLogger = (prefix: string) => {
-  if (!isDev) {
-    // 生产环境返回空操作
-    return {
-      log: noop,
-      info: noop,
-      warn: noop,
-      error: noop,
-    };
+/** 模块初始化时读取一次 `location.search`，之后不变 */
+function readVerboseDebugQueryOnce(): boolean {
+  if (typeof window === 'undefined') {
+    return false;
+  }
+  try {
+    const v = new URLSearchParams(window.location.search).get(DEBUG_LOGS_QUERY_KEY);
+    if (v == null || v === '') {
+      return false;
+    }
+    const normalized = v.toLowerCase();
+    return normalized === '1' || normalized === 'true' || normalized === 'yes';
+  } catch {
+    return false;
   }
+}
 
-  const formattedPrefix = `[${prefix}]`;
+/** 开发环境，或生产环境首屏 URL 已带 `debug` 开关（模块加载时确定）；供业务侧按需分支 */
+export const isAppDebugLogsEnabled: boolean = isDev || readVerboseDebugQueryOnce();
+
+const noop = (): void => {};
 
+function createVerboseHandlers(formattedPrefix: string) {
   return {
     log: console.log.bind(console, formattedPrefix),
     info: console.info.bind(console, formattedPrefix),
     warn: console.warn.bind(console, formattedPrefix),
     error: console.error.bind(console, formattedPrefix),
   };
+}
+
+function createQuietHandlers(formattedPrefix: string) {
+  return {
+    log: noop,
+    info: noop,
+    warn: noop,
+    error: console.error.bind(console, formattedPrefix),
+  };
+}
+
+/**
+ * 创建带前缀的日志函数
+ * 使用 bind 绑定前缀，保持控制台显示正确的调用位置（在开启详细日志时）
+ */
+const createLogger = (prefix: string) => {
+  const formattedPrefix = `[${prefix}]`;
+  return isAppDebugLogsEnabled
+    ? createVerboseHandlers(formattedPrefix)
+    : createQuietHandlers(formattedPrefix);
 };
 
 // 预定义的日志实例

package/generators/subapp-umd/README.md

@@ -0,0 +1,37 @@
+# subapp-umd 生成器
+
+在已有 Monorepo 的 `packages/` 下创建 UMD 组件包（Webpack 构建）。详见 [docs/generators.md#subapp-umd](../../docs/generators.md#subapp-umd)。
+
+## 快速索引
+
+| 文件 | 职责 |
+|---|---|
+| `index.js` | 生成器主体；无跨模块联动修改 |
+| `meta.json` | `mico list` 展示信息 |
+| `ignore-list.json` | 模板过滤清单 |
+| `templates/` | 模板根 |
+
+## 使用
+
+```bash
+cd <monorepo-root>
+mico create subapp-umd
+```
+
+要求 monorepo 根包含 `packages/` 目录。
+
+## Prompt 默认值
+
+| name | 默认 |
+|---|---|
+| `appName` | `.micorc.defaultUmdName` ?? `'my-widget'` |
+| `umdGlobalName` | `toPascal(appName)` |
+| `packageScope` | `.micorc.packageScope` ?? `detectPackageScope()` ?? `'@my-project'` |
+| `devPort` | `.micorc.umdDevPort` ?? `'9100'` |
+
+## 运行产物
+
+| URL | 说明 |
+|---|---|
+| `http://localhost:<devPort>/` | HTML 预览页 |
+| `http://localhost:<devPort>/<appName>.umd.js` | UMD JS，供主应用通过 `jsUrls` 接入 |

package/lib/setup-multica-desktop.js

@@ -0,0 +1,154 @@
+'use strict';
+
+/**
+ * 为 Multica Desktop 写入自托管配置文件 `~/.multica/desktop.json`。
+ *
+ * 跨平台路径（统一由 os.homedir() 解析）：
+ *   macOS:   /Users/<Username>/.multica/desktop.json
+ *   Linux:   /home/<Username>/.multica/desktop.json
+ *   Windows: C:\Users\<Username>\.multica\desktop.json
+ *
+ * 参考：
+ *   https://github.com/multica-ai/multica/blob/main/apps/docs/content/docs/desktop-app.zh.mdx
+ *   https://github.com/multica-ai/multica/pull/2012
+ */
+
+const fs = require('node:fs');
+const os = require('node:os');
+const path = require('node:path');
+
+const DEFAULT_CONFIG = Object.freeze({
+  schemaVersion: 1,
+  apiUrl: 'https://multica-api.micoplatform.com',
+  appUrl: 'https://multica.micoplatform.com',
+});
+
+/**
+ * 解析配置文件路径。
+ * @param {string} [homedir] 可注入的 home 目录（便于测试）
+ * @returns {{ home: string, dir: string, file: string }}
+ */
+function resolvePaths(homedir = os.homedir()) {
+  if (!homedir) {
+    throw new Error('无法解析当前用户的 home 目录（请检查 HOME / USERPROFILE 环境变量）');
+  }
+  const dir = path.join(homedir, '.multica');
+  const file = path.join(dir, 'desktop.json');
+  return { home: homedir, dir, file };
+}
+
+/**
+ * 基于默认值与覆盖项构造最终配置对象。
+ * @param {{ apiUrl?: string, appUrl?: string, wsUrl?: string }} overrides
+ * @returns {{ schemaVersion: 1, apiUrl: string, appUrl: string, wsUrl?: string }}
+ */
+function buildConfig(overrides = {}) {
+  const config = { ...DEFAULT_CONFIG };
+  if (overrides.apiUrl) config.apiUrl = overrides.apiUrl;
+  if (overrides.appUrl) config.appUrl = overrides.appUrl;
+  if (overrides.wsUrl) config.wsUrl = overrides.wsUrl;
+  return config;
+}
+
+function formatBackupSuffix(date = new Date()) {
+  const pad = (n) => String(n).padStart(2, '0');
+  return [
+    date.getFullYear(),
+    pad(date.getMonth() + 1),
+    pad(date.getDate()),
+    pad(date.getHours()),
+    pad(date.getMinutes()),
+    pad(date.getSeconds()),
+  ].join('');
+}
+
+/**
+ * 执行 `~/.multica/desktop.json` 的写入流程。
+ *
+ * @param {object} [options]
+ * @param {string} [options.apiUrl]            覆盖默认 apiUrl
+ * @param {string} [options.appUrl]            覆盖默认 appUrl
+ * @param {string} [options.wsUrl]             显式设置 wsUrl（不传则由 Desktop 自动推导）
+ * @param {boolean} [options.dryRun=false]     仅预览，不写盘
+ * @param {boolean} [options.force=false]      已存在时不备份直接覆盖
+ * @param {boolean} [options.noBackup=false]   不生成 .bak 文件
+ * @param {string} [options.homedir]           注入 home 目录（测试用）
+ * @param {(msg: string) => void} [options.logger=console.log]
+ * @returns {{
+ *   file: string,
+ *   dir: string,
+ *   created: boolean,
+ *   backedUpTo: string | null,
+ *   config: object,
+ *   dryRun: boolean
+ * }}
+ */
+function runSetupMulticaDesktop(options = {}) {
+  const {
+    apiUrl,
+    appUrl,
+    wsUrl,
+    dryRun = false,
+    force = false,
+    noBackup = false,
+    homedir,
+    logger = console.log,
+  } = options;
+
+  const { dir, file } = resolvePaths(homedir);
+  const config = buildConfig({ apiUrl, appUrl, wsUrl });
+
+  logger(`平台: ${process.platform} (${os.arch()})`);
+  logger(`目标文件: ${file}`);
+
+  const existed = fs.existsSync(file);
+  let backedUpTo = null;
+
+  if (existed && !force && !noBackup) {
+    backedUpTo = `${file}.bak.${formatBackupSuffix()}`;
+    if (dryRun) {
+      logger(`[dry-run] 备份现有文件 -> ${backedUpTo}`);
+    } else {
+      fs.copyFileSync(file, backedUpTo);
+      logger(`已备份现有文件 -> ${backedUpTo}`);
+    }
+  } else if (existed && force) {
+    logger('检测到现有配置（--force，将直接覆盖且不备份）');
+  } else if (existed && noBackup) {
+    logger('检测到现有配置（--no-backup，将直接覆盖）');
+  }
+
+  if (!fs.existsSync(dir)) {
+    if (dryRun) {
+      logger(`[dry-run] 创建目录: ${dir}`);
+    } else {
+      fs.mkdirSync(dir, { recursive: true });
+      logger(`已创建目录: ${dir}`);
+    }
+  }
+
+  const content = `${JSON.stringify(config, null, 2)}\n`;
+  if (dryRun) {
+    logger(`[dry-run] 将写入 ${file}：\n${content}`);
+  } else {
+    fs.writeFileSync(file, content, { encoding: 'utf8' });
+    logger(`已写入配置: ${file}`);
+    logger('完成。请重启 Multica Desktop 让配置生效。');
+  }
+
+  return {
+    file,
+    dir,
+    created: !existed,
+    backedUpTo,
+    config,
+    dryRun,
+  };
+}
+
+module.exports = {
+  DEFAULT_CONFIG,
+  resolvePaths,
+  buildConfig,
+  runSetupMulticaDesktop,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generator-mico-cli",
-  "version": "0.2.30",
+  "version": "0.2.32",
   "description": "Yeoman generator for Mico CLI projects",
   "keywords": [
     "yeoman-generator",