SuperAPI AI 工具集

codebase-architecture

设计与创作

查看项目

更新于 10-16 00:22

技能介绍

用途:帮助决定 TypeScript 代码库的结构,在变更成本变高时改进结构,并让结构约束长期保持。目标是让读者能在脑中装下整个代码库:接口面少、每件事只有一种标准做法、行为出现在最该找的地方。

三种模式,按问题而非产物选择,并说明所选模式:

  • Design(新代码库):结构尚未确定时,产出架构简报。先明确约束(产品范围、团队规模、合规安全、预期规模、部署目标、必需集成、质量门槛),假设写入简报首节。选择仓库形态(apps/ 放可部署面,packages/ 放共享库),定义后端模块接口(handler、service、dao、mapper、constants/types)并各自指明强制手段(导入边界 lint 或类型检查),定义请求上下文与中间件(tenantId、userId、traceId 放入 AsyncLocalStorage 支撑的 RequestContext,经 getContext() 读取),定义前端边界(Next.js App Router 默认,app/ 只放路由文件,领域代码放 src/modules/<name>/),并给出测试与发布策略。
  • Deepen(既有代码库):代码能跑但变更昂贵时使用。先梳理领域语言与决策,按变更落点限定扫描范围(用 git log --oneline 加权高频文件),寻找深化机会(贫血概念、浅模块、泄漏接缝、命名分歧、重复概念、原始类型偏执、错位逻辑等),记录文件路径,先做删除测试,再按杠杆排序,先迁移一个垂直切片,最后用 lint、类型或测试固定新接缝。
  • Harden(让结构保持):护栏阻止错误落地,寻路让正确做法易于找到。先调查现有检查(本地跑但不拦合并、CI 跑但不会失败、无人调用的休眠配置),按要防止的失败而非工具流行度选择检查,安装后先绿再故意破坏验证其确实生效,并接入 pre-commit 与 CI。

验证循环:按所用模式运行对应项并记录证据,无法执行的项目记为 N/A 并说明原因。包括一致性、可强制、可运维、质量门禁、CI 与本地一致、无悬空指针、净简化等。

限制:不负责新仓库脚手架、多租户领域隔离与路由、AGENTS.md 内容本身、单个功能的计划、局部 diff 的清理或结构审查、产品自身的验证 CLI 与功能地图。无法写入仓库时,各模式输出降级为计划,并说明哪些检查尚未验证。资料未提供具体收费、价格与平台信息。