docs: document resource API and shared component conventions

Align the root guidance, existing skill entry points, and README with resource API directories, complete response envelopes, and named component folders. Keep the root guidance as the single source of project rules.
This commit is contained in:
eezd committed 2026-10-26 11:53:48 +08:00
1 parent 6b537c03e0
commit 4ef792a6f4
7 files changed
+10 -8

No files matched your search

+1 -1
View File
@@ -3,4 +3,4 @@ name: v3-create-crud
description: 调整业务页面与表单
---
先读根 AGENTS.md,核对后端路由和现有业务调用链。页面放 `web/src/pages/<module>/`,私有 API/类型跟随模块;真正跨模块共享才放 common。复用实际 Element Plus 控件和 `http/axios` 的 requestJSON/requestRaw,不预设分页、CRUD、导出或角色能力。失败保留原因,成功后再关闭/刷新,取消确认不得伪装成实际操作成功。按行为测试成功、失败与权限边界。
先读根 AGENTS.md,核对后端路由和现有业务调用链。页面私有组件、类型和组合函数放 `web/src/pages/<module>/`;全部 API 放 `common/apis/<resource>/{index.ts,type.ts}`。按模板导出独立 `*Api` 函数,用 `request<ResponseData>({ url, method, data, params })` 返回完整响应,调用方读取 `.data`;原文/下载按实际语义保留响应。复用 Element Plus 的 Form、Dialog、表单控件和 Table,不预设分页、CRUD、导出或角色能力。失败保留原因,成功后再关闭/刷新,取消确认不得伪装成实际操作成功。按行为测试成功、失败与权限边界。
+1 -1
View File
@@ -3,4 +3,4 @@ name: v3-upsert-route
description: 调整登录守卫与权限路由
---
先读根 AGENTS.md、`web/src/router/` 和 `pinia/stores/{user,permission}.ts`。常驻与动态路由按现有实现登记,匿名路由使用 meta.anonymous,真实权限来自 /auth/me,无角色系统。唯一名称、懒加载;核对匿名/初始化/回跳、深链、403、401、注销及换会话,旧结果不能注册新会话路由。
先读根 AGENTS.md、`web/src/router/` 和 `pinia/stores/{user,permission}.ts`。常驻与动态路由按现有实现登记,匿名路由使用 meta.anonymous,真实权限来自 common/apis/auth 的 /auth/me 响应 data,无角色系统。唯一名称、懒加载;核对匿名/初始化/回跳、深链、403、401、注销及换会话,旧结果不能注册新会话路由。
+1 -1
View File
@@ -3,4 +3,4 @@ name: v3-upsert-store
description: 调整 Pinia 共享状态
---
先读根 AGENTS.md 和现有 store。跨页面共享状态放 `web/src/pinia/stores/`,使用 Setup Store;页面表单和工作区临时状态留在模块。setup 外显式传入 pinia,不增加转发函数或重复镜像。认证变更通过 user store 更新会话代号,持久化仅保留已有明确需求。验证旧请求隔离与状态重置。
先读根 AGENTS.md 和现有 store。跨页面共享状态放 `web/src/pinia/stores/`,使用 Setup Store,状态、动作和保存队列均归 store 实例所有,API 从 common/apis 对应资源导入;页面表单和工作区临时状态留在模块。setup 外显式传入 pinia,不增加转发函数或重复镜像。认证变更通过 user store 更新会话代号,持久化仅保留已有明确需求。验证旧请求隔离与状态重置。
+1 -1
View File
@@ -3,4 +3,4 @@ name: v3-use-composables
description: 提取或复用业务组合函数
---
先读根 AGENTS.md 及实际调用方。当前项目没有模板分页、全屏加载等示例组合函数,不凭模板声明调用不存在的能力。页面私有组合函数跟随模块;仅为实际跨模块复用提取 common,不为单次代码建立新层。异步失败明确拒绝,同一错误由负责层展示。
先读根 AGENTS.md 及实际调用方。当前项目没有模板分页、全屏加载等示例组合函数,不凭模板声明调用不存在的能力。API 请求统一从 common/apis 对应资源导入,组合函数不另造请求封装;页面私有组合函数跟随模块;仅为实际跨模块复用提取 common,不为单次代码建立新层。异步失败明确拒绝,同一错误由负责层展示。
+1 -1
View File
@@ -3,4 +3,4 @@ name: v3-use-utils
description: 复用公共工具与认证能力
---
先读根 AGENTS.md 和 `web/src/common/utils/` 的实际实现。命令、路径、通知、PWA 等按已有签名复用;认证 Token 由 user store 维护,不绕过会话与动态路由清理。没有模板示例的角色/日期工具,不引入虚构依赖。页面专用转换留在页面模块,未知外部输入在边界校验。
先读根 AGENTS.md 和 `web/src/common/utils/` 的实际实现。命令、路径、通知、PWA 等按已有签名复用;认证 Token 由 user store 维护,不绕过会话与动态路由清理。没有模板示例的角色/日期工具,不引入虚构依赖。API 请求只通过 `common/apis/<resource>/index.ts` 的独立函数与 `http/axios` 的 request;原生资源票据缓存等实际共享工具留在 common/utils。页面专用转换留在页面模块,未知外部输入在边界校验。