# Codebase Inventory Audit

> 代码库清单审计：自动盘点项目代码结构，识别孤儿代码、重复逻辑、文档缺口和技术债务。当用户说'代码库审计'、'项目盘点'、'代码清理'、'技术债务'、'孤儿代码'、'重复代码'、'代码结构分析'、'项目健康度'时触发。核心特点：结构可视化、健康度评分、债务量化、清理优先级。

- Skill: `gaoqiongxie/codebase-inventory-audit` (Agent Skill)
- Install (CLI): `npx skillmds@latest add gaoqiongxie/codebase-inventory-audit`
- Raw SKILL.md: https://api.skillmd.com/api/skills/gaoqiongxie/codebase-inventory-audit/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Security
- Author: gaoqiongxie (https://skillmd.com/u/gaoqiongxie)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/gaoqiongxie/codebase-inventory-audit

---


> **来源**: Anthropic Skills Issue #147
>
> **发布时间**: 2026-05
>
> **理念**: "不了解自己代码库的人，就像在黑暗中装修房子。"

# 🗂️ Codebase Inventory Audit — 代码库清单审计

自动盘点代码库，识别技术债务和优化机会。

---

## 🎯 核心能力

| 能力 | 说明 |
|------|------|
| **结构可视化** | 生成模块依赖图、调用关系图 |
| **孤儿代码识别** | 找出无引用的函数、类、文件 |
| **重复逻辑检测** | 识别代码重复、相似函数 |
| **文档缺口扫描** | 找出缺少注释/文档的公共 API |
| **技术债务量化** | 给代码库健康度打分 |
| **依赖分析** | 第三方库使用情况、过时依赖 |

---

## 📊 审计维度

### 1. 代码结构健康度

```
项目: my-project
├── 模块数量: 23
├── 文件数量: 487
├── 代码行数: 42,380
├── 平均文件行数: 87
├── 最大文件: src/services/legacy/monolith.ts (2,340 行) ⚠️
└── 循环依赖: 3 处 ❌
```

### 2. 孤儿代码扫描

| 类型 | 数量 | 示例 |
|------|------|------|
| 未引用函数 | 12 | `utils/legacyHelper.ts:calculateOldTax` |
| 未使用类 | 3 | `models/DeprecatedUser.ts` |
| 死代码文件 | 5 | `hooks/useOldApi.ts` |
| 未使用导出 | 18 | `constants/oldConfig.ts` |

### 3. 重复代码检测

| 相似度 | 位置 A | 位置 B | 建议 |
|--------|--------|--------|------|
| 85% | `auth/login.ts:45-67` | `auth/register.ts:32-54` | 提取公共函数 |
| 72% | `orders/validate.ts` | `payments/validate.ts` | 创建共享校验器 |

### 4. 文档缺口

| 文件 | 公共 API | 有文档 | 缺口 |
|------|---------|--------|------|
| `api/user.ts` | 8 | 3 | 5 |
| `services/order.ts` | 12 | 2 | 10 |
| `utils/date.ts` | 6 | 6 | 0 ✅ |

---

## 📈 健康度评分

```
代码库健康度: 72/100

✅ 结构规范     18/20
⚠️ 代码质量     14/20 （重复代码 15 处）
⚠️ 文档完整     12/20 （38% 公共 API 无文档）
⚠️ 技术债务     13/20 （3 个循环依赖，5 个死文件）
✅ 依赖管理     15/20
```

---

## 🚀 使用方式

### 方式一：全量审计

```
对当前项目执行代码库审计
```

### 方式二：定向扫描

```
扫描 src/services 目录的孤儿代码
```

### 方式三：债务清理计划

```
根据审计结果生成技术债务清理计划
按 ROI 排序
```

---

## 🔗 与其他 Skill 的关系

| | codebase-inventory-audit | security-audit | systematic-debugging |
|---|---|---|---|
| **侧重** | 代码结构健康 | 安全漏洞 | Bug 排查 |
| **最佳组合** | inventory-audit 发现结构问题 → security-audit 检查漏洞 → hermes-experience 沉淀重构经验 |

---

> "定期审计代码库，就像定期体检——早发现，早治疗。"