project-summary — 项目快速概览

为新开发者提供入职引导或向智能体提供上下文，生成结构化的项目摘要。

步骤

1. 扫描项目根目录

优先读取以下文件（均为可选）：

• package.json / pyproject.toml / Cargo.toml / go.mod / *.sln / *.csproj
• README.md — 已有的项目描述
• LICENSE
• Dockerfile / docker-compose.yml
• .github/workflows/*.yml / .gitlab-ci.yml / Jenkinsfile
• tsconfig.json / babel.config.* / webpack.config.* / vite.config.*
• .eslintrc* / .prettierrc* / pyproject.toml [tool.ruff]

2. 检测语言与框架

主要语言 — 统计文件扩展名：

find . -type f -not -path '*/node_modules/*' -not -path '*/.git/*' -not -path '*/dist/*' -not -path '*/target/*' -not -path '*/__pycache__/*' -not -path '*/.venv/*' | sed 's/.*\.//' | sort | uniq -c | sort -rn | head -10
# Windows:
Get-ChildItem -Recurse -File -Exclude node_modules,.git,dist,target | Group-Object Extension | Sort-Object Count -Descending | Select-Object -First 10 Count,Name

框架 — 检查依赖项（详见 readme-generator 技能中的检测表）。

3. 映射架构

根据目录结构识别架构模式：

4. 识别入口点

# 查找常见入口文件
ls -la src/index.* src/main.* app.* main.* index.* manage.py server.* 2>/dev/null
# 检查 package.json 中的 "main", "module", "bin", "scripts.start"
# 检查 Cargo.toml [[bin]] 或 src/main.rs
# 检查 pyproject.toml [project.scripts]

5. 列出关键文件

列出最重要的文件及其简要说明：

## 关键文件
| 文件 | 用途 |
|------|------|
| `src/index.ts` | 应用程序入口点 |
| `src/routes/` | API 路由定义 |
| `src/models/` | 数据库模型 / Schema |
| `src/middleware/` | Express 中间件（认证、日志等） |
| `prisma/schema.prisma` | 数据库 Schema |
| `docker-compose.yml` | 本地开发服务配置 |
| `.github/workflows/ci.yml` | CI 流水线 —— 测试 + 代码检查 + 构建 |

重点关注新开发者需要了解的文件。跳过生成文件、自解释配置和样板代码。

6. 记录测试设置

# 检测测试框架
grep -l "jest\|vitest\|mocha\|pytest\|unittest\|cargo test\|go test" package.json pyproject.toml Cargo.toml Makefile 2>/dev/null
# 查找测试文件
find . -name "*.test.*" -o -name "*.spec.*" -o -name "test_*" -not -path '*/node_modules/*' 2>/dev/null | head -20

报告：测试框架、测试位置、如何运行测试、大致测试数量。

7. 检查 CI/CD

如果存在 CI 配置，则总结：

• 触发流水线的条件（推送、PR、定时任务）
• 执行的步骤（代码检查、测试、构建、部署）
• 部署目标（如可识别）

8. 映射依赖关系

列出前 10 个最重要的依赖项（非全部）：

• 重点关注框架、数据库、认证、测试和构建工具
• 注明大致总数量

## 关键依赖
| 包 | 用途 |
|----|------|
| express | Web 框架 |
| prisma | 数据库 ORM |
| jsonwebtoken | JWT 认证 |
| jest | 测试框架 |
| **总计** | **47 个依赖（12 个开发依赖）** |

9. 输出结构化摘要

# 项目概览：[项目名称]

**描述：** [来自 package.json 或 README]
**语言：** TypeScript | **框架：** Express.js | **运行时：** Node.js 20
**架构：** MVC | **包管理器：** pnpm
**许可证：** MIT

## 快速开始
[安装 + 启动命令]

## 项目结构
[架构说明 + 关键目录]

## 关键文件
[第 5 步中的表格]

## 依赖项
[第 8 步中的表格]

## 测试
- **框架：** Jest
- **运行方式：** `pnpm test`
- **覆盖率：** `pnpm test -- --coverage`

## CI/CD
- **平台：** GitHub Actions
- **触发条件：** 推送到 main 分支、创建 PR
- **流水线流程：** 代码检查 → 测试 → 构建 → 部署至 Vercel

## 注意事项
[任何异常或重要信息 —— 如多包仓库设置、必需服务、README 中提到的问题]

边界情况

• 多包仓库（Monorepo）：总结根目录结构，并简要描述每个包或工作区
• 无清单文件：根据文件扩展名和目录结构推断
• 非常大的项目（超过 1000 个文件）：限制扫描深度至 3 层，重点聚焦 src/ 和根目录配置
• 多种语言：报告主语言和次语言，并附上占比
• 空项目或新建项目：标记为模板项目；说明已配置内容与缺失部分

错误处理