Appearance
用户手册
完整的 Git Doctor 使用指南,帮助您快速上手并充分利用所有功能。
健康概览
健康概览视图展示仓库的整体健康状态:
┌─────────────────────────────────────────┐
│ 健康概览 │
├─────────────────────────────────────────┤
│ 📊 健康评分: 85/100 │
│ │
│ 📦 仓库体积 │
│ └─ .git 大小: 12.5 MB │
│ └─ 大文件数: 3 │
│ │
│ 📝 提交质量 │
│ └─ 规范率: 78% │
│ └─ 总提交数: 256 │
│ │
│ 🌿 分支健康 │
│ └─ 本地分支: 8 │
│ └─ 僵尸分支: 2 │
│ │
│ 🔒 安全风险 │
│ └─ 高风险: 0 │
│ └─ 中风险: 2 │
└─────────────────────────────────────────┘查看详细信息:
- 点击各项指标可展开查看详情
- 点击问题项可跳转到具体位置
功能入口
VS Code 插件
- 点击侧边栏的 Git Doctor 图标(脉搏图标)
- 使用命令面板
Ctrl+Shift+P,输入Git Doctor:
CLI 命令行
bash
# 完整诊断
git-doctor analyze
# 各项分析
git-doctor size # 体积分析
git-doctor commits # 提交质量
git-doctor branches # 分支健康
git-doctor security # 敏感信息诊断维度
仓库体积分析
分析 .git 目录的大小和对象分布。
| 指标 | 说明 |
|---|---|
| 总大小 | .git 目录总体积 |
| 松散对象 | 未打包的单独对象 |
| Pack 文件 | 打包后的对象文件 |
| 大文件 | 超过阈值的文件(默认 1MB) |
优化建议:
- 大文件过多 → 考虑使用 Git LFS
- 松散对象过多 → 运行
git gc - Pack 文件过大 → 检查是否有不必要的历史
提交质量分析
检查提交消息是否符合规范。
检查项:
- ✅ Conventional Commits 格式
- ✅ 提交消息长度
- ✅ 提交频率分布
- ✅ 作者贡献统计
Conventional Commits 格式:
<type>(<scope>): <subject>
<body>
<footer>支持的 type:
feat: 新功能fix: Bug 修复docs: 文档更新style: 代码格式refactor: 重构test: 测试chore: 构建/工具
分支健康度分析
| 问题类型 | 说明 | 建议 |
|---|---|---|
| 僵尸分支 | 超过 90 天未更新 | 考虑删除或激活 |
| 已合并未删除 | 已合并到主分支但未删除 | 建议删除 |
| 命名不规范 | 不符合命名约定 | 重命名或删除 |
敏感信息扫描
| 类型 | 示例模式 | 风险级别 |
|---|---|---|
| AWS Key | AKIA... | 高 |
| GitHub Token | ghp_... | 高 |
| 私钥文件 | -----BEGIN RSA PRIVATE KEY----- | 严重 |
| 密码 | password=xxx | 中 |
| API Key | api_key=xxx | 中 |
处理建议:
- 立即撤销泄露的凭证
- 使用
git filter-branch清理历史 - 考虑使用环境变量或密钥管理服务
代码热点
热点指标
┌─────────────────────────────────────────┐
│ 代码热点 │
├─────────────────────────────────────────┤
│ 🔥 高风险 │
│ └─ src/core/parser.ts │
│ 修改次数: 45 | Bug修复: 12 │
│ TDI: 85.3 │
│ │
│ ⚠️ 中风险 │
│ └─ src/utils/helper.ts │
│ 修改次数: 23 | Bug修复: 5 │
│ TDI: 52.1 │
└─────────────────────────────────────────┘TDI 技术债务指数
| 范围 | 风险级别 | 颜色 |
|---|---|---|
| 0-30 | 低风险 | 🟢 绿色 |
| 31-60 | 中风险 | 🟡 黄色 |
| 61-80 | 高风险 | 🟠 橙色 |
| 81-100 | 严重风险 | 🔴 红色 |
热力图
命令面板:Git Doctor: 打开热力图
热力图以可视化方式展示代码变更热度,颜色越深表示修改越频繁。
贡献者画像
分析团队成员的贡献分布:
- 提交数量排名
- 代码行数贡献
- 活跃时间分布
- 知识孤岛风险识别
报告导出
支持格式
| 格式 | 说明 | 适用场景 |
|---|---|---|
| HTML | 可视化仪表盘 | 分享、演示 |
| Markdown | 纯文本格式 | 文档、Wiki |
| JSON | 结构化数据 | 程序处理、CI |
| Text | 控制台格式 | 快速查看 |
导出命令
bash
# CLI 导出
git-doctor export -f html -o report.html
git-doctor export -f markdown -o report.md
git-doctor export -f json -o report.json常见问题
为什么分析结果显示"无数据"?
可能原因:
- 当前目录不是 Git 仓库
- 仓库刚初始化,没有提交历史
- 仓库使用了 shallow clone(浅克隆)
解决方法:
bash
# 检查是否是 Git 仓库
ls -la .git
# 如果是浅克隆,获取完整历史
git fetch --unshallow热点分析很慢?
解决方法:
减少分析时间范围:
json"gitDoctor.hotspot.timeRange": 30添加排除模式:
json"gitDoctor.hotspot.excludePatterns": [ "**/node_modules/**", "**/vendor/**" ]