generator-mico-cli 0.2.30 → 0.2.32

package/generators/micro-react/templates/apps/layout/src/common/auth/index.ts

@@ -6,6 +6,7 @@ import { clearStoredTenantCode } from './tenant';
 
 // 导出 STORAGE_KEYS 常量
 export { STORAGE_KEYS } from '../../constants';
+export { resolveAuthCheckPath } from './auth-check-path';
 
 export function logout(): void {
   clearStoredTokens();

package/generators/micro-react/templates/apps/layout/src/common/logger.ts

@@ -1,37 +1,70 @@
 /**
  * 日志工具
- * 仅在开发环境下输出日志，生产环境自动静默
+ * - 开发环境：全量输出
+ * - 生产环境：默认仅 `error` 带前缀输出；可在**首屏 URL** 带 query 打开全量 `log` / `info` / `warn`（与 dev 一致）
  *
- * 使用 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 参数名；勿随意改名以免已分享的排障链接失效 */
+export const DEBUG_LOGS_QUERY_KEY = 'debug';
 
-/**
- * 创建带前缀的日志函数
- * 使用 bind 绑定前缀，保持控制台显示正确的调用位置
- */
-const createLogger = (prefix: string) => {
-  const formattedPrefix = `[${prefix}]`;
-  if (!isDev) {
-    // 生产环境返回空操作，但 error 仍然输出（便于生产排查）
-    return {
-      log: noop,
-      info: noop,
-      warn: noop,
-      error: console.error.bind(console, new Error(formattedPrefix)),
-    };
+/** 模块初始化时读取一次 `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;
   }
+}
+
+/** 开发环境，或生产环境首屏 URL 已带 `debug` 开关（模块加载时确定）；供业务侧按需分支 */
+export const isLayoutDebugLogsEnabled: 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 isLayoutDebugLogsEnabled
+    ? createVerboseHandlers(formattedPrefix)
+    : createQuietHandlers(formattedPrefix);
 };
 
 // 预定义的日志实例

package/generators/micro-react/templates/apps/layout/src/common/request/sso.ts

@@ -3,6 +3,7 @@
  */
 
 import { request as rawRequest } from '@umijs/max';
+import { resolveAuthCheckPath } from '@/common/auth/auth-check-path';
 import {
   maybePersistTokens,
   setStoredAuthToken,
@@ -59,14 +60,16 @@ const performSsoRedirect = (): void => {
 export const handleAuthFailureRedirect = (): void => {
   if (typeof window === 'undefined') return;
 
-  // 如果当前路由在免认证列表中，不触发 SSO 重定向
-  if (isNoAuthRoute(window.location.pathname)) {
-    console.log('[SSO] 当前路由在免认证列表中，跳过 SSO 重定向');
+  const authCheckPath = resolveAuthCheckPath(window.location.pathname);
+
+  // 与 getInitialState 一致：用 authCheckPath 判断，避免「/ + defaultPath」首屏仍按 / 误判为免认证
+  if (isNoAuthRoute(authCheckPath)) {
+    console.log('[SSO] 当前路由在免认证列表中，跳过 SSO 重定向', { authCheckPath });
     return;
   }
 
-  if (isPageAuthFree(window.location.pathname)) {
-    console.log('[SSO] 页面 accessControlEnabled=false，跳过 SSO 重定向');
+  if (isPageAuthFree(authCheckPath)) {
+    console.log('[SSO] 页面 accessControlEnabled=false，跳过 SSO 重定向', { authCheckPath });
     return;
   }
 

package/generators/micro-react/templates/package.json

@@ -32,7 +32,7 @@
   "devDependencies": {
     "@commitlint/cli": "^19.5.0",
     "@commitlint/config-conventional": "^19.5.0",
-    "@common-web/sentry": "0.0.7",
+    "@common-web/sentry": "0.0.8",
     "@sentry/webpack-plugin": "^4.9.1",
 		"@typescript-eslint/eslint-plugin": "^8.54.0",
 		"@typescript-eslint/parser": "^8.54.0",

package/generators/subapp-h5/ignore-list.json

@@ -0,0 +1 @@
+["node_modules", "dist", ".umi", ".umi-production", ".turbo"]

package/generators/subapp-h5/index.js

@@ -0,0 +1,424 @@
+'use strict';
+
+const Generator = require('yeoman-generator');
+const fs = require('node:fs');
+const path = require('node:path');
+const {
+  toKebab,
+  toPascal,
+  collectFiles,
+  transformDestPath,
+  isTemplateFile,
+  detectPackageScope,
+  setupErrorHandlers,
+  createLogger,
+  loadMicorc,
+} = require('../../lib/utils');
+
+const IGNORE_LIST = require('./ignore-list.json');
+
+setupErrorHandlers();
+
+module.exports = class extends Generator {
+  initializing() {
+    this.monorepoRoot = process.cwd();
+    this.logger = createLogger(this);
+
+    this.isDryRun = this.options.dryRun || process.env.MICO_DRY_RUN === '1';
+    this.skipInstall =
+      this.options.skipInstall === true || this.options['skip-install'] === true;
+    this.skipEndMessage = this.options.skipEndMessage === true;
+    this.composedFromH5React = this.options.composedFromH5React === true;
+
+    const { config: rcConfig, configPath } = loadMicorc(this.monorepoRoot);
+    this.rcConfig = rcConfig;
+    if (configPath) {
+      this.logger.verbose('Loaded config from:', configPath);
+      this.logger.verbose('Config:', JSON.stringify(rcConfig, null, 2));
+    }
+
+    const appsDir = path.join(this.monorepoRoot, 'apps');
+    const workspaceFile = path.join(this.monorepoRoot, 'pnpm-workspace.yaml');
+
+    // 联动 h5-react 时，父生成器刚把 apps/.gitkeep 等写入 mem-fs，尚未 commit 到磁盘，
+    // 仅用 fs.existsSync(apps) 会误判。允许：磁盘已有 apps/，或 mem-fs 中已有 apps 下占位文件。
+    const appsGitkeepInStore = this.destinationPath('apps/.gitkeep');
+    const hasAppsOnDisk = fs.existsSync(appsDir);
+    const hasAppsInMemFs =
+      typeof this.fs?.exists === 'function' && this.fs.exists(appsGitkeepInStore);
+    if (!hasAppsOnDisk && !hasAppsInMemFs) {
+      console.error('');
+      console.error('❌ Error: apps directory not found.');
+      console.error('');
+      console.error(
+        '   This generator must be run from an H5 monorepo root that contains an "apps" directory.',
+      );
+      console.error(`   Current directory: ${this.monorepoRoot}`);
+      console.error('');
+      console.error('   Usage:');
+      console.error('     cd /path/to/your-h5-monorepo');
+      console.error('     mico create subapp-h5');
+      console.error('');
+      process.exit(1);
+    }
+
+    if (!fs.existsSync(workspaceFile)) {
+      console.warn('');
+      console.warn('⚠️  Warning: pnpm-workspace.yaml not found.');
+      console.warn('   Make sure you are in the correct monorepo.');
+      console.warn('');
+    }
+  }
+
+  async prompting() {
+    try {
+      const compose = this.options.composeAnswers;
+      if (compose && typeof compose === 'object') {
+        const appName = toKebab(compose.appName);
+        if (!appName) {
+          console.error('');
+          console.error('❌ Error: composeAnswers.appName is required.');
+          console.error('');
+          process.exit(1);
+        }
+        const destDir = path.join(this.monorepoRoot, 'apps', appName);
+        if (fs.existsSync(destDir)) {
+          console.error('');
+          console.error(`❌ Error: Target already exists: apps/${appName}`);
+          console.error('');
+          process.exit(1);
+        }
+        this.answers = {
+          appName,
+          packageScope: compose.packageScope,
+          devPort: String(compose.devPort ?? '8000'),
+          author: compose.author || '',
+        };
+        if (!this.answers.packageScope || !this.answers.packageScope.startsWith('@')) {
+          console.error('');
+          console.error('❌ Error: composeAnswers.packageScope must be a scoped name (e.g. @my-org).');
+          console.error('');
+          process.exit(1);
+        }
+      } else {
+        const detectedScope = detectPackageScope(this.monorepoRoot);
+        const rc = this.rcConfig || {};
+
+        this.answers = await this.prompt([
+          {
+            type: 'input',
+            name: 'appName',
+            message: 'Sub app name',
+            default: rc.defaultSubappName || 'app',
+            filter: (input) => toKebab(input),
+            validate: (input) => {
+              const value = toKebab(input);
+              if (!value) return 'App name is required';
+              const destDir = path.join(this.monorepoRoot, 'apps', value);
+              if (fs.existsSync(destDir)) {
+                return `Target already exists: apps/${value}`;
+              }
+              return true;
+            },
+          },
+          {
+            type: 'input',
+            name: 'packageScope',
+            message: 'Package scope',
+            default: rc.packageScope || detectedScope || '@my-project',
+            validate: (input) => {
+              if (!input) return 'Package scope is required';
+              if (!input.startsWith('@')) return 'Package scope must start with @';
+              return true;
+            },
+          },
+          {
+            type: 'input',
+            name: 'devPort',
+            message: 'Dev server port (standalone pnpm dev in this app)',
+            default: rc.devPort || '8000',
+            validate: (input) => {
+              const port = Number(input);
+              if (!Number.isInteger(port) || port < 1024 || port > 65535) {
+                return 'Port must be an integer between 1024 and 65535';
+              }
+              return true;
+            },
+          },
+          {
+            type: 'input',
+            name: 'author',
+            message: 'Author (optional)',
+            default: rc.author || '',
+          },
+        ]);
+      }
+
+      this.appName = toKebab(this.answers.appName);
+      this.appNamePascal = toPascal(this.appName);
+      this.packageScope = this.answers.packageScope;
+      this.devPort = String(this.answers.devPort);
+      this.author = this.answers.author || '';
+      this.templateDir = this.templatePath();
+      this.destDir = path.join(this.monorepoRoot, 'apps', this.appName);
+    } catch (error) {
+      console.error('');
+      console.error('❌ Error during prompting:');
+      console.error(`   ${error.message}`);
+      console.error('');
+      process.exit(1);
+    }
+  }
+
+  async writing() {
+    try {
+      if (!fs.existsSync(this.templateDir)) {
+        console.error('');
+        console.error('❌ Error: Template directory not found.');
+        console.error(`   Expected: ${this.templateDir}`);
+        console.error('');
+        process.exit(1);
+      }
+
+      this.logger.verbose('Template directory:', this.templateDir);
+      this.logger.verbose('Destination directory:', this.destDir);
+
+      const templateData = {
+        appName: this.appName,
+        AppName: this.appNamePascal,
+        packageScope: this.packageScope,
+        devPort: this.devPort,
+        author: this.author,
+      };
+
+      this.logger.verbose('Template data:', JSON.stringify(templateData, null, 2));
+
+      const files = collectFiles(this.templateDir, this.templateDir, IGNORE_LIST);
+
+      if (files.length === 0) {
+        console.error('');
+        console.error('❌ Error: No template files found.');
+        console.error(`   Template directory: ${this.templateDir}`);
+        console.error('');
+        process.exit(1);
+      }
+
+      if (this.isDryRun) {
+        this.log('');
+        this.log('\x1b[33m📋 Dry run mode - no files will be created\x1b[0m');
+        this.log('');
+        this.log(`   Sub-app: ${this.appName}`);
+        this.log(`   Scope: ${this.packageScope}`);
+        this.log(`   Destination: apps/${this.appName}`);
+        this.log('');
+        this.log('   Would create the following files:');
+        this.log('');
+
+        let templateCount = 0;
+        let copyCount = 0;
+
+        for (const relPath of files) {
+          const destRelPath = transformDestPath(relPath);
+          const isTemplate = isTemplateFile(relPath) || path.basename(relPath) === '.env';
+          const tag = isTemplate ? '\x1b[32m[tpl]\x1b[0m' : '\x1b[36m[cpy]\x1b[0m';
+          this.log(`   ${tag} apps/${this.appName}/${destRelPath}`);
+
+          if (isTemplate) {
+            templateCount++;
+          } else {
+            copyCount++;
+          }
+        }
+
+        this.log('');
+        this.log(
+          `   Total: ${files.length} files (${templateCount} templates, ${copyCount} static)`,
+        );
+        this.log('');
+        this.log('   Run without --dry-run to actually create these files.');
+        this.log('');
+
+        this._skipInstall = true;
+        return;
+      }
+
+      this.log('');
+      this.log(`📦 Creating sub-app: ${this.appName}`);
+      this.log(`   Destination: apps/${this.appName}`);
+      this.log('');
+
+      this.logger.verbose(`Processing ${files.length} files...`);
+
+      let templateCount = 0;
+      let copyCount = 0;
+
+      for (const relPath of files) {
+        const srcPath = path.join(this.templateDir, relPath);
+        const destRelPath = transformDestPath(relPath);
+        const destPath = path.join(this.destDir, destRelPath);
+
+        if (isTemplateFile(relPath) || path.basename(relPath) === '.env') {
+          this.logger.file('template', destRelPath);
+          this.fs.copyTpl(srcPath, destPath, templateData);
+          templateCount++;
+        } else {
+          this.logger.file('copy', destRelPath);
+          this.fs.copy(srcPath, destPath);
+          copyCount++;
+        }
+      }
+
+      this.logger.verbose(`Processed: ${templateCount} templates, ${copyCount} copied`);
+
+      this._updateDevPreset();
+      this._updatePageConfig();
+    } catch (error) {
+      console.error('');
+      console.error('❌ Error during file generation:');
+      console.error(`   ${error.message}`);
+      console.error('');
+      process.exit(1);
+    }
+  }
+
+  /**
+   * 读取目标根目录文件：优先 mem-fs（与父生成器联动时尚未落盘），否则读磁盘。
+   * @param {string} absolutePath
+   * @returns {string|null}
+   */
+  _readDestinationText(absolutePath) {
+    if (this.fs.exists(absolutePath)) {
+      const buf = this.fs.read(absolutePath);
+      return Buffer.isBuffer(buf) ? buf.toString('utf8') : String(buf);
+    }
+    if (fs.existsSync(absolutePath)) {
+      return fs.readFileSync(absolutePath, 'utf8');
+    }
+    return null;
+  }
+
+  /**
+   * 写入目标根目录文件（走 mem-fs，最终由 Yeoman 统一落盘）。
+   * @param {string} absolutePath
+   * @param {string} content
+   */
+  _writeDestinationText(absolutePath, content) {
+    this.fs.write(absolutePath, content);
+  }
+
+  _updateDevPreset() {
+    const presetPath = this.destinationPath('dev.preset.json');
+    const raw = this._readDestinationText(presetPath);
+    if (raw == null) {
+      this.logger.verbose('dev.preset.json not found, skipping preset update');
+      return;
+    }
+
+    try {
+      const preset = JSON.parse(raw);
+      const fullApps = preset.presets?.full?.apps;
+
+      if (!Array.isArray(fullApps)) {
+        this.logger.verbose('dev.preset.json has no full.apps array, skipping');
+        return;
+      }
+
+      if (fullApps.includes(this.appName)) {
+        this.logger.verbose(`"${this.appName}" already in full preset, skipping`);
+        return;
+      }
+
+      fullApps.push(this.appName);
+      this._writeDestinationText(presetPath, `${JSON.stringify(preset, null, 2)}\n`);
+
+      this.log(`   📝 已将 "${this.appName}" 添加到 dev.preset.json 的 full 预设中`);
+    } catch (e) {
+      console.warn(`   ⚠️  更新 dev.preset.json 失败: ${e.message}`);
+    }
+  }
+
+  _updatePageConfig() {
+    const pageConfigPath = this.destinationPath('page.config.ts');
+    const content = this._readDestinationText(pageConfigPath);
+    if (content == null) {
+      this.logger.verbose('page.config.ts not found, skipping');
+      return;
+    }
+
+    try {
+      if (content.includes(`${this.appName}:`)) {
+        this.logger.verbose(`page.config.ts already has ${this.appName}, skipping`);
+        return;
+      }
+
+      const keyLine = `  ${this.appName}: true`;
+      const lastBraceIdx = content.lastIndexOf('};');
+      if (lastBraceIdx === -1) {
+        this.logger.verbose('page.config.ts: no closing }; found, skipping');
+        return;
+      }
+
+      const before = content.slice(0, lastBraceIdx).trimEnd();
+      const after = content.slice(lastBraceIdx);
+      let newBefore;
+      if (before.endsWith('{')) {
+        newBefore = `${before}\n${keyLine}\n`;
+      } else {
+        newBefore = `${before},\n${keyLine}\n`;
+      }
+
+      this._writeDestinationText(pageConfigPath, newBefore + after);
+      this.log(`   📝 已将 "${this.appName}" 写入 page.config.ts`);
+    } catch (e) {
+      console.warn(`   ⚠️  更新 page.config.ts 失败: ${e.message}`);
+    }
+  }
+
+  install() {
+    if (this._skipInstall || this.skipInstall) return;
+
+    this.log('');
+    this.log('📦 正在安装依赖...');
+    try {
+      this.spawnCommandSync('pnpm', ['install', '--filter', this.appName], {
+        cwd: this.monorepoRoot,
+      });
+    } catch (e) {
+      this._installFailed = true;
+      this.log('');
+      this.log('⚠️  依赖安装失败，但子应用文件已全部生成。');
+      this.logger.verbose('Install error:', e.message);
+    }
+  }
+
+  end() {
+    if (this._skipInstall || this.skipEndMessage) return;
+
+    this.log('');
+
+    if (this._installFailed) {
+      this.log('⚠️  子应用文件已创建，但依赖安装未完成。');
+      this.log('');
+      this.log('   请手动安装依赖:');
+      this.log('');
+      this.log('   pnpm install');
+      this.log('');
+      this.log('   如果安装仍然失败，可尝试:');
+      this.log('   pnpm install --network-concurrency 4');
+    } else {
+      this.log('✅ 子应用创建成功！');
+    }
+
+    this.log('');
+    this.log('   后续步骤:');
+    this.log('');
+    this.log(`   cd apps/${this.appName}`);
+    this.log('   pnpm dev');
+    this.log('');
+    if (!this.composedFromH5React) {
+      this.log('   继续在 monorepo 根目录新增子应用:');
+      this.log('   mico create subapp-h5');
+      this.log('');
+    }
+  }
+};

package/generators/subapp-h5/meta.json

@@ -0,0 +1,10 @@
+{
+  "name": "subapp-h5",
+  "description": "在 H5 Monorepo 的 apps/ 下新增 Umi 4 子应用",
+  "usage": "cd <h5-monorepo-root> && mico create subapp-h5",
+  "features": [
+    "写入 page.config.ts 与 dev.preset.json",
+    "Tailwind + @umijs/plugins 模板",
+    "与仓库 packageScope / workspace 包对齐"
+  ]
+}

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

@@ -0,0 +1 @@
+PORT=<%= devPort %>

package/generators/subapp-h5/templates/.stylelintrc.js

@@ -0,0 +1,22 @@
+module.exports = {
+  extends: [require.resolve('umi/stylelint')],
+  rules: {
+    'at-rule-no-unknown': [
+      true,
+      {
+        ignoreAtRules: [
+          'tailwind',
+          'apply',
+          'layer',
+          'config',
+          'plugin',
+          'theme',
+          'utility',
+          'source',
+          'custom-variant',
+        ],
+      },
+    ],
+  },
+  ignoreFiles: ["dist/**/*", "node_modules/**/*"],
+};

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

@@ -0,0 +1,7 @@
+// https://umijs.org/config/
+
+import { createDevConfig } from '<%= packageScope %>/umi-config/config.dev';
+
+export default createDevConfig({
+  // custom config
+});

package/generators/subapp-h5/templates/config/config.prod.development.ts

@@ -0,0 +1,7 @@
+// https://umijs.org/config/
+
+import { createDevelopmentConfig } from '<%= packageScope %>/umi-config/config.prod.development';
+
+export default createDevelopmentConfig({
+  // custom config
+});

package/generators/subapp-h5/templates/config/config.prod.production.ts

@@ -0,0 +1,10 @@
+// https://umijs.org/config/
+
+import { createProductionConfig } from '<%= packageScope %>/umi-config/config.prod.production';
+
+export default createProductionConfig(
+  { appName: '<%= appName %>' },
+  {
+    // custom config
+  },
+);

package/generators/subapp-h5/templates/config/config.prod.testing.ts

@@ -0,0 +1,7 @@
+// https://umijs.org/config/
+
+import { createTestingConfig } from '<%= packageScope %>/umi-config/config.prod.testing';
+
+export default createTestingConfig({
+  // custom config
+});

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

@@ -0,0 +1,7 @@
+// https://umijs.org/config/
+
+import { createProConfig } from '<%= packageScope %>/umi-config/config.prod';
+
+export default createProConfig({
+  // custom config
+});

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

@@ -0,0 +1,6 @@
+// https://umijs.org/config/
+
+import { createBaseConfig } from '<%= packageScope %>/umi-config/config';
+import routes from './routes';
+
+export default createBaseConfig({ routes });

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

@@ -0,0 +1,13 @@
+/**
+ * @name 基础路由配置
+ * @description 这里只配置静态的基础路由，动态路由从 window.__MICO_MENUS__ 获取
+ * @doc https://umijs.org/docs/guides/routes
+ * @note Umi Max 会自动使用 src/layouts/index.tsx 作为全局布局，无需显式配置
+ */
+export default [
+  {
+    path: '/',
+    component: 'index',
+    name: '首页',
+  },
+];