mica-admin: Instructions file for Codex

AGENTS.md

This file provides guidance to Codex (Codex.ai/code) when working with code in this repository.

项目概述

mica-admin 是基于 mica 工具集的低代码权限管理平台，使用 Maven、Spring Boot 4.1、Spring Security、MyBatis-Plus（后端）+ Vben Admin 5.x（前端）+ uniapp x（移动 App）。

仓库根目录结构（mono-repo，单 git 仓库）：

目录	说明	技术栈
mica-admin-server/	Spring Boot 后端（Java 17+）	Maven 模块
mica-admin-web/	Web 管理端（Vben Admin 5.x 本地化）	Vite + Vue 3 + Naive UI
mica-admin-uniapp/	移动 App（uniapp x）	uniapp x + Vue 3 + TypeScript + Pinia
docs/	设计文档	-

mica-admin-uniapp/ 不进 Maven：它是独立的 npm/pnpm 工程，与 mica-admin-web/ 平级。 三者放在同一 git 仓库是为了 AI 编码时能"看见完整上下文",便于跨模块协作。

工作准则(必读)

• ❌ 禁止擅自 git commit / git push。所有变更默认保持 M / A 状态,等用户明确说"提交"、"commit"、"push" 时再执行。需要提交时,先把 git status 摘要给用户看一眼。
• ❌ 禁止擅自重命名既有字段。即使觉得"更合理"也不动,字段名/列名属于业务决策,改之前必须先和用户确认。
• ✅ 改动默认只改类型,不改命名(除非用户明确要求)。
• 命名 / 删文件 / 改 schema 之前,先用 AskUserQuestion 确认,不要先斩后奏。

构建命令

后端 (mica-admin-server)

从仓库根目录执行：

# 默认 dev profile，跳过前端构建
mvn package
# 生产构建：触发 pnpm install + pnpm build:prod，把 dist 打入 META-INF/resources
mvn clean package -Pprod -U -Dmaven.test.skip=true

# 单测
mvn test -Dtest=ClassName#methodName -DfailIfNoTests=false

# 本地启动
mvn spring-boot:run -Dspring-boot.run.profiles=dev

Maven profile 行为：

• dev（默认激活）：skipNpmBuild=true，不构建前端。
• prod：skipNpmBuild=false，通过 exec-maven-plugin 触发前端构建，并把 mica-admin-web/dist 复制到 META-INF/resources，与后端 jar 合并。

前端 (mica-admin-web)

cd mica-admin-web
pnpm install
pnpm dev               # Vite dev server，端口 5888，/api 代理到 http://localhost:8080
pnpm typecheck         # vue-tsc --noEmit --skipLibCheck
pnpm lint              # eslint --fix
pnpm build             # 类型检查 + 生产构建
pnpm build:prod        # 仅打包，跳过类型检查（Maven prod profile 调的就是这个）
pnpm build:analyze     # 构建并分析包体积

后端架构 (mica-admin-server)

主包：net.dreamlu.mica.admin，源码 src/main/java/：