代码映射更新¶
分析代码库结构,生成 Token 高效的架构文档。
第一步:扫描项目结构¶
- 识别项目类型(monorepo、单应用、库、微服务)
- 查找所有源码目录(
src/、lib/、app/、packages/) - 映射入口点(
main.ts、index.ts、app.py、main.go等)
第二步:生成代码映射¶
在 docs/CODEMAPS/ 中创建或更新代码映射:
| 文件 | 内容 |
|---|---|
INDEX.md |
整个代码库概览及各区域的链接 |
backend.md |
API 路由、中间件链、服务 → 仓储映射 |
frontend.md |
页面树、组件层级、状态管理流程 |
database.md |
数据库模式、迁移、存储层 |
integrations.md |
外部服务、第三方集成、适配器 |
workers.md |
后台任务、队列、调度器 |
代码映射格式¶
每个代码映射都应做到 Token 高效——为 AI 上下文消耗而优化:
# Backend 아키텍처
## 라우트
POST /api/users → UserController.create → UserService.create → UserRepo.insert
GET /api/users/:id → UserController.get → UserService.findById → UserRepo.findById
## 주요 파일
src/services/user.ts (비즈니스 로직, 120줄)
src/repos/user.ts (데이터베이스 접근, 80줄)
## 의존성
- PostgreSQL (주 데이터 저장소)
- Redis (세션 캐시, 속도 제한)
- Stripe (결제 처리)
第三步:区域分类¶
生成器会根据文件路径模式自动对区域进行分类:
- 前端:
app/、pages/、components/、hooks/、.tsx、.jsx - 后端:
api/、routes/、controllers/、services/、.route.ts - 数据库:
db/、migrations/、prisma/、repositories/ - 集成:
integrations/、adapters/、connectors/、plugins/ - Worker:
workers/、jobs/、queues/、tasks/、cron/
第四步:添加元数据¶
为每个代码映射添加包含最新信息的文件头:
第五步:同步索引与区域文档¶
INDEX.md 应链接并汇总已生成的区域文档:
- 各区域的文件数与总行数
- 检测到的入口点
- 仓库树的简单 ASCII 概览
- 各区域详细文档的链接
提示¶
- 关注高层结构而非实现细节
- 使用文件路径和函数签名,而不是完整的代码块
- 为高效加载上下文,将每个代码映射保持在 1000 Token 以内
- 使用 ASCII 图表表示数据流,而不是冗长的说明
- 在添加主要功能或重构会话后,运行
npx tsx scripts/codemaps/generate.ts
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 ev/ECC