generator-mico-cli 0.2.31 → 0.2.33

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: '首页',
+  },
+];

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>
+  );
+}