auto-gen-crud 0.1.0

package/skills/auto-gen-crud-agent/SKILL.md

@@ -0,0 +1,114 @@
+---
+name: auto-gen-crud-agent
+description: Build and modify Vue CRUD pages with auto-gen-crud and its OpenAPI generator. Use when Codex or a VSCode AI agent needs to generate CRUD pages, wire search/table/modal configs, adapt request calls, query auto-gen-crud MCP tools, or follow this project's CRUD page conventions. 也适用于“生成 CRUD 页面”“根据 OpenAPI 生成页面”“使用 auto-gen-crud”“接入 CRUD agent”“配置 searchForm/table/modalForm”等中文需求。
+---
+
+# auto-gen-crud Agent Skill
+
+当任务是创建、修改或二开基于 `auto-gen-crud` 的 CRUD 页面时，使用这个 skill。
+
+## 核心工作流
+
+1. 动手前先读取目标项目：
+   - 包依赖和当前使用的 UI 库。
+   - 已有 CRUD 页面写法。
+   - `request` / `http` 工具函数签名。
+   - 路由、页面目录和命名规范。
+2. 如果有 OpenAPI / Apifox 文档或者链接，优先使用 `auto-gen-crud/generator` 生成初始化页面。
+3. 如果没有可靠接口文档，再手写 `AutoCrud` + hooks 页面。
+4. 生成代码要保持清晰、可读、方便业务继续二开。
+5. 修改完成后执行目标项目已有的 type-check、build、lint 或 generator test。
+
+## 页面结构规则
+
+优先使用这种目录结构：
+
+```text
+src/views/ExamplePage/
+├── index.vue
+├── api/
+│   ├── index.ts
+│   └── types.ts
+└── config/
+    ├── enums.ts
+    ├── searchForm.ts
+    ├── table.ts
+    └── modalForm.ts
+```
+
+职责边界：
+
+- `index.vue`：页面编排、请求流程、跨模块动作、`pageContext`。
+- `api/index.ts`：当前页面 API 函数。
+- `api/types.ts`：当前页面局部类型。
+- `config/searchForm.ts`：只描述搜索字段。
+- `config/table.ts`：只描述表格列和行操作。
+- `config/modalForm.ts`：只描述新增、编辑、查看弹窗字段。
+- `config/enums.ts`：枚举映射和可选的选项数组。
+
+## 生成器规则
+
+使用：
+
+```ts
+import { generateCrudPage } from "auto-gen-crud/generator";
+```
+
+推荐默认值：
+
+- `pageContext` 默认保持空对象：`reactive<PageContextType>({})`。
+- `getDataList` 直接透传 `...searchForm.data`。
+- 枚举文件默认生成 `TypeTextMap`。
+- 只有用户明确需要 `TypeOptions` 数组选项时，才设置 `generateTypeOptions: true`。
+- 除非用户明确要求覆盖，否则保持 `overwrite: false`。
+- `maxRetries` 不能超过 `5`。
+
+适配请求函数时，优先使用 `requestAdapter`，不要先生成错误代码再手动大面积改产物。
+
+## 手写页面规则
+
+使用这些导入：
+
+```ts
+import { AutoCrud, useModalForm, useSearchForm, useTable } from "auto-gen-crud";
+```
+
+使用中立 schema 字段：
+
+- 表单字段：`label`、`prop`、`component`、`options`、`required`、`show`、`disabled`、`props`、`render`
+- 表格列：`title`、`field`、`actions`、`copy`、`decode`、`image`、`dateTime`、`render`
+
+除非项目已有明确 adapter 规则，否则不要生成 UI 库强绑定 schema。
+
+## MCP 使用建议
+
+如果 agent 环境里有 MCP 工具，优先查询工具，不要靠猜：
+
+- `vac_get_agent_guide`
+- `vac_get_generator_reference`
+- `vac_get_api_reference`
+- `vac_list_schema_fields`
+- `vac_search_docs`
+
+MCP server 启动方式：
+
+```bash
+node node_modules/auto-gen-crud/mcp/auto-gen-crud-mcp.mjs
+```
+
+全局安装后也可以：
+
+```bash
+auto-gen-crud-mcp
+```
+
+## 完成前检查清单
+
+结束前必须检查：
+
+- 生成的 import 能解析。
+- `AutoCrud` 正确接收 `searchForm`、`table`、`modalForm`。
+- `getDataList` 按当前 hook 风格正确更新或返回表格数据。
+- 枚举字段默认使用 `TextMap`，除非用户明确要求 `TypeOptions`。
+- 页面业务问题不要绕到组件包里做 workaround。
+- 如果项目提供 type-check / build / lint，执行对应校验。