analyzing-projects

项目分析

加载时机

• 触发条件：开始使用新项目、询问“这是如何运作的”、探索代码库、了解不熟悉的代码
• 跳过条件：已经熟悉项目结构和模式

项目分析工作流

复制此检查清单并跟踪进度：

Project Analysis Progress:
- [ ] Step 1: Quick overview (README, root files)
- [ ] Step 2: Detect tech stack
- [ ] Step 3: Map project structure
- [ ] Step 4: Identify key patterns
- [ ] Step 5: Find development workflow
- [ ] Step 6: Generate summary report

步骤 1：快速概览

# Check for common project markers
ls -la
cat README.md 2>/dev/null | head -50

步骤 2：检测技术栈

包管理器和依赖项

• package.json → Node.js/JavaScript/TypeScript
• requirements.txt / pyproject.toml / setup.py → Python
• go.mod → Go
• Cargo.toml → Rust
• pom.xml / build.gradle → Java
• Gemfile → Ruby

框架（来自依赖项）

• React、Vue、Angular、Next.js、Nuxt
• Express、FastAPI、Django、Flask、Rails
• Spring Boot、Gin、Echo

基础设施

• Dockerfile、docker-compose.yml → 容器化
• kubernetes/、k8s/ → Kubernetes
• terraform/、.tf 文件 → IaC
• serverless.yml → Serverless Framework
• .github/workflows/ → GitHub Actions

步骤 3：分析项目结构

以带注释的树状结构呈现：

project/
├── src/              # Source code
│   ├── components/   # UI components (React/Vue)
│   ├── services/     # Business logic
│   ├── models/       # Data models
│   └── utils/        # Shared utilities
├── tests/            # Test files
├── docs/             # Documentation
└── config/           # Configuration

步骤 4：识别关键模式

查找并报告：

• 架构：单体、微服务、无服务器、Monorepo
• API 风格：REST、GraphQL、gRPC、tRPC
• 状态管理：Redux、Zustand、MobX、Context
• 数据库：SQL、NoSQL、所用 ORM
• 身份验证：JWT、OAuth、会话
• 测试：Jest、Pytest、Go test 等

步骤 5：开发工作流

检查以下内容：

• .eslintrc、.prettierrc → 代码检查/格式化
• .husky/ → Git 钩子
• Makefile → 构建命令
• package.json 中的 scripts/ → NPM 脚本

步骤 6：输出格式

使用此模板生成摘要：

# Project: [Name]

## Overview

[1-2 sentence description]

## Tech Stack

| Category  | Technology |
| --------- | ---------- |
| Language  | TypeScript |
| Framework | Next.js 14 |
| Database  | PostgreSQL |
| ...       | ...        |

## Architecture

[Description with simple ASCII diagram if helpful]

## Key Directories

- `src/` - [purpose]
- `lib/` - [purpose]

## Entry Points

- Main: `src/index.ts`
- API: `src/api/`
- Tests: `npm test`

## Conventions

- [Naming conventions]
- [File organization patterns]
- [Code style preferences]

## Quick Commands

| Action  | Command         |
| ------- | --------------- |
| Install | `npm install`   |
| Dev     | `npm run dev`   |
| Test    | `npm test`      |
| Build   | `npm run build` |

分析验证

完成分析后，验证：

Analysis Validation:
- [ ] All major directories explained
- [ ] Tech stack accurately identified
- [ ] Entry points documented
- [ ] Development commands verified working
- [ ] No assumptions made without evidence

如果有任何项目无法验证，请在报告中标注为“需要澄清”。