generator-mico-cli 0.1.18

package/generators/micro-react/templates/.cursor/rules/cicd-deploy.mdc

@@ -0,0 +1,143 @@
+---
+description: CI/CD 与部署 - Jenkins 构建流程、环境配置、CDN 发布
+globs: ["CICD/**", "deployDesc.md"]
+---
+
+# CI/CD 与部署
+
+## 构建架构
+
+```
+┌─────────────────────────────────────────────────────────────────┐
+│                        Jenkins                                   │
+│  ┌─────────────────────────────────────────────────────────────┐│
+│  │  根据环境执行对应脚本：                                       ││
+│  │                                                              ││
+│  │  开发环境 → CICD/start_dev.sh   → build:development          ││
+│  │  测试环境 → CICD/start_test.sh  → build:testing              ││
+│  │  生产环境 → CICD/start_prod.sh → build:production           ││
+│  │  本地构建 → CICD/start_local.sh → build:local                ││
+│  └─────────────────────────────────────────────────────────────┘│
+│                              ↓                                   │
+│  ┌─────────────────────────────────────────────────────────────┐│
+│  │  构建产物：dist/{app}/                                       ││
+│  │  上传 CDN：cdn-portal[-env].micoplatform.com/<%= projectName %>/   ││
+│  └─────────────────────────────────────────────────────────────┘│
+└─────────────────────────────────────────────────────────────────┘
+```
+
+## CICD 脚本
+
+| 脚本 | 环境 | 构建命令 | CDN 路径 |
+|------|------|---------|---------|
+| `start_dev.sh` | 开发 | `build:development` | `cdn-portal-dev.micoplatform.com` |
+| `start_test.sh` | 测试 | `build:testing` | `cdn-portal-test.micoplatform.com` |
+| `start_prod.sh` | 生产 | `build:production` | `cdn-portal.micoplatform.com` |
+| `start_local.sh` | 本地 | `build:local` | `./`（相对路径） |
+
+## 脚本执行流程
+
+```bash
+#!/bin/bash
+source ~/.bashrc
+
+# 1. 安装 Node.js 和 pnpm
+nvm install 22.20.0
+nvm use 22.20.0
+npm i -g pnpm@10.18.2 --registry=https://registry.npmmirror.com
+pnpm install
+
+# 2. 获取版本号
+VERSION=$(node -p "require('./package.json').version")
+
+# 3. 设置 CDN 路径
+export CDN_PUBLIC_PATH="https://cdn-portal[-env].micoplatform.com/<%= projectName %>/${VERSION}/"
+
+# 4. 执行构建
+pnpm run build:[environment]
+
+# 5. 输出版本信息
+echo "VERSION=$VERSION" > .env_x_<%= projectName %>
+```
+
+## 环境配置
+
+### 分支策略
+| 环境 | 分支 | 说明 |
+|------|------|------|
+| 测试环境 | `test` | 测试验证 |
+| 生产环境 | `main` | 正式发布 |
+
+### CDN 域名
+| 环境 | 域名 |
+|------|------|
+| 开发 | `cdn-portal-dev.micoplatform.com` |
+| 测试 | `cdn-portal-test.micoplatform.com` |
+| 生产 | `cdn-portal.micoplatform.com` |
+
+### CDN 路径结构
+```
+cdn-portal.micoplatform.com/
+└── <%= projectName %>/
+    └── {version}/
+        └── dist/
+            ├── layout/      # 主应用
+            ├── homepage/    # 子应用
+            └── ...
+```
+
+## 环境变量
+
+### CDN_PUBLIC_PATH
+- 通过 `turbo.json` 的 `globalEnv` 注入
+- 用于设置静态资源的公共路径
+- 不同环境有不同的 CDN 域名
+
+### 版本号
+- 从 `package.json` 的 `version` 字段读取
+- 用于 CDN 路径中的版本隔离
+- 构建后输出到 `.env_x_<%= projectName %>` 文件
+
+## 构建产物
+
+```bash
+# 构建后目录结构
+dist/
+├── layout/          # 主应用
+│   ├── index.html
+│   ├── umi.js
+│   └── umi.css
+├── homepage/        # 子应用
+│   ├── index.html
+│   ├── umi.js
+│   └── umi.css
+└── ...
+```
+
+## 本地构建测试
+
+```bash
+# 模拟测试环境构建
+sh CICD/start_test.sh
+
+# 模拟生产环境构建
+sh CICD/start_prod.sh
+
+# 本地构建（使用相对路径）
+sh CICD/start_local.sh
+```
+
+## 环境要求
+
+| 依赖 | 版本 | 说明 |
+|------|------|------|
+| nvm | 最新版 | Node 版本管理 |
+| Node.js | 22.20.0 | 运行时 |
+| pnpm | 10.18.2 | 包管理器 |
+
+## 注意事项
+
+1. **版本号管理**：修改 `package.json` 的 `version` 会影响 CDN 路径
+2. **CDN 刷新**：部署后可能需要刷新 CDN 缓存（见 `wangsu_fresh_*.sh`）
+3. **环境隔离**：不同环境使用不同的 CDN 域名和路径
+4. **构建缓存**：Turborepo 会根据 `turbo.json` 配置缓存构建结果

package/generators/micro-react/templates/.cursor/rules/coding-conventions.mdc

@@ -0,0 +1,206 @@
+---
+description: 编码规范 - TypeScript、React、样式约定
+globs: ["**/*.ts", "**/*.tsx", "**/*.less", "**/*.css"]
+---
+
+# 编码规范
+
+## TypeScript 命名规范
+
+### 接口 (Interface)
+使用 `I` 前缀：
+```typescript
+interface IUserInfo {
+  name: string;
+  avatar: string;
+  userid: string;
+}
+
+interface IMenuItem {
+  id: number;
+  name: string;
+  children?: IMenuItem[];
+}
+```
+
+### 枚举 (Enum)
+使用 `E` 前缀：
+```typescript
+enum EStatus {
+  Pending = 'pending',
+  Approved = 'approved',
+  Rejected = 'rejected',
+}
+
+enum EUserRole {
+  Admin = 'admin',
+  User = 'user',
+}
+```
+
+### 类型别名 (Type)
+可用 `T` 前缀：
+```typescript
+type TCallback = () => void;
+type TRequestOptions = {
+  headers?: Record<string, string>;
+  timeout?: number;
+};
+```
+
+## React 组件规范
+
+### 函数组件
+```typescript
+import React from 'react';
+
+interface MyComponentProps {
+  title: string;
+  onClose?: () => void;
+}
+
+const MyComponent: React.FC<MyComponentProps> = ({ title, onClose }) => {
+  return (
+    <div className="my-component">
+      <h1>{title}</h1>
+      {onClose && <button onClick={onClose}>关闭</button>}
+    </div>
+  );
+};
+
+export default MyComponent;
+```
+
+### Hooks 规范
+- 自定义 Hook 以 `use` 前缀命名
+- 放置在 `src/hooks/` 目录
+- 导出时在 `src/hooks/index.ts` 统一导出
+
+```typescript
+// src/hooks/useTheme.ts
+export const useTheme = () => {
+  // ...
+};
+
+// src/hooks/index.ts
+export { useTheme } from './useTheme';
+export { useMenu } from './useMenu';
+```
+
+## 样式规范
+
+### Less 变量使用
+优先使用 Less 变量（有编辑器提示），而非直接使用 CSS 变量：
+
+```less
+// ✅ 推荐
+.my-card {
+  background-color: @color-fill-1;
+  color: @color-text-2;
+  border: 1px solid @color-border-2;
+}
+
+// ⚠️ 可用但缺少提示
+.my-card {
+  background-color: var(--color-fill-1);
+}
+```
+
+### 主题适配
+所有颜色都应使用主题变量，确保亮色/暗黑模式自动切换：
+
+```less
+// 主要颜色变量
+@Brand1-1 ~ @Brand1-7      // 品牌主色系列
+@color-text-1 ~ @color-text-5   // 文字颜色（深 → 浅）
+@color-fill-1 ~ @color-fill-5   // 填充颜色（浅 → 深）
+@color-border-1 ~ @color-border-4  // 边框颜色
+@Success-1 ~ @Success-7    // 成功状态色
+@Warning-1 ~ @Warning-7    // 警告状态色
+@Danger-1 ~ @Danger-7      // 危险状态色
+```
+
+### 类名规范
+- 使用 kebab-case（短横线分隔）
+- 组件容器用 `-container` 后缀
+- 子元素用 `-item`、`-content`、`-header` 等后缀
+
+```less
+.micro-app-container {
+  .micro-app-loading { }
+  .micro-app-content { }
+  .micro-app-error { }
+}
+```
+
+## 文件组织
+
+### 页面目录结构
+复杂页面应拆分到独立文件夹：
+
+```
+pages/
+├── Home/
+│   ├── index.tsx          # 主组件
+│   ├── index.less         # 样式
+│   └── components/        # 页面私有组件
+│       ├── Header.tsx
+│       └── List.tsx
+```
+
+### 公共组件
+放置在 `src/components/` 目录，每个组件一个文件夹：
+
+```
+components/
+├── MicroAppLoader/
+│   ├── index.tsx
+│   └── index.less
+├── IconFont/
+│   └── index.tsx
+```
+
+## 导入顺序
+
+```typescript
+// 1. React 及其生态
+import React, { useState, useEffect } from 'react';
+import { useLocation } from '@umijs/max';
+
+// 2. 第三方库
+import { Button, Modal } from '@arco-design/web-react';
+import dayjs from 'dayjs';
+
+// 3. 项目内部模块（使用 @ 别名）
+import { request } from '@/common/request';
+import { useTheme } from '@/hooks';
+
+// 4. 相对路径导入
+import Header from './components/Header';
+
+// 5. 样式文件
+import './index.less';
+```
+
+## 注释规范
+
+### 函数注释
+```typescript
+/**
+ * 判断页面加载类型
+ * 有 htmlUrl 或 jsUrls 时使用 qiankun 微应用加载
+ * @param page 页面配置
+ * @returns 'internal' | 'microapp'
+ */
+const getLoadType = (page: MenuItem['page']): 'internal' | 'microapp' => {
+  // ...
+};
+```
+
+### 关键逻辑注释
+```typescript
+// 如果有匹配的动态路由配置且需要加载微应用
+if (currentRoute?.loadType === 'microapp' && currentRoute.entry) {
+  return <MicroAppLoader entry={currentRoute.entry} name={currentRoute.path} />;
+}
+```

package/generators/micro-react/templates/.cursor/rules/commit-conventions.mdc

@@ -0,0 +1,111 @@
+---
+description: Git 提交规范 - Conventional Commits 格式
+globs: []
+---
+
+# Git 提交规范
+
+## 格式
+
+```
+type(scope): subject
+```
+
+- **type**: 必填，提交类型
+- **scope**: 可选，影响范围（模块、页面、包名等）
+- **subject**: 必填，简短描述（1-50 字符）
+
+## 提交类型
+
+| 类型 | 说明 | 示例 |
+|------|------|------|
+| `feat` | 新功能 | `feat(用户): 添加用户注册功能` |
+| `fix` | Bug 修复 | `fix(表格): 修复分页显示问题` |
+| `docs` | 文档更新 | `docs(API): 更新接口文档` |
+| `style` | 代码格式（不影响功能） | `style(组件): 调整按钮样式` |
+| `refactor` | 重构 | `refactor(auth): 重构认证服务` |
+| `perf` | 性能优化 | `perf(列表): 优化渲染性能` |
+| `test` | 测试相关 | `test(单元测试): 添加用户服务测试` |
+| `build` | 构建系统或外部依赖 | `build(webpack): 升级依赖` |
+| `ci` | CI 配置 | `ci(github): 添加自动部署` |
+| `chore` | 其他杂项 | `chore(依赖): 更新依赖包` |
+| `wip` | 开发中 | `wip(功能): 功能开发中` |
+| `release` | 版本发布 | `release: v1.0.0` |
+| `deps` | 依赖更新 | `deps: 升级 React 到 18.2` |
+| `revert` | 回滚 | `revert: 回滚上一次提交` |
+
+## 正确示例
+
+```bash
+# 中文（推荐）
+feat(用户管理): 添加用户删除功能
+fix(表格): 修复分页显示问题
+docs(API): 更新接口文档
+style(组件): 调整按钮样式
+refactor(服务): 重构用户服务逻辑
+chore(依赖): 更新项目依赖包
+perf(性能): 优化列表渲染性能
+
+# 英文
+feat(table): 支持列宽调整
+fix(core): 处理失去焦点时发生的事件 (close #28)
+chore(release): 更新日志
+```
+
+## 常见错误
+
+```bash
+# ❌ 错误：缺少 type
+添加用户功能
+
+# ❌ 错误：type 不在允许列表中
+add(user): 添加用户功能
+
+# ❌ 错误：subject 为空
+feat:
+
+# ❌ 错误：subject 过长（超过50字符）
+feat(user): 这是一个非常非常非常非常非常非常非常非常非常非常长的提交信息
+
+# ✅ 正确
+feat(user): 添加用户注册功能
+```
+
+## Scope 命名
+
+- 使用短横线连接多个单词：`user-center`、`micro-app`
+- 可以使用中文：`用户管理`、`表格`
+- 建议与模块/目录名对应
+
+## 特殊情况
+
+### 合并分支
+允许以 `Merge` 开头：
+```bash
+Merge branch 'feature/user' into main
+```
+
+### 回滚提交
+允许以 `Revert` 开头：
+```bash
+Revert "feat(user): 添加用户功能"
+```
+
+### 版本发布
+允许以 `Version` 开头：
+```bash
+Version 1.0.0
+```
+
+## 校验机制
+
+- **钩子**: `.husky/commit-msg`
+- **工具**: `npx --no-install max verify-commit`
+- **配置**: `.commitlintrc.js`
+
+提交前会自动校验消息格式，不符合规范将被拒绝。
+
+## 相关链接
+
+- [Conventional Commits](https://www.conventionalcommits.org/)
+- [Angular Commit Guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit)