开发指标助手
语言: English | 简体中文
追踪开发指标、代码品质指示器,以及专案随时间的健康状态。
使用方式
| 命令 | 用途 |
|---|---|
/metrics |
执行完整专案健康检查 |
/metrics --quality |
仅代码品质指标 |
/metrics --debt |
分类技术债报告 |
/metrics --debt-trend |
技术债趋势 |
/metrics --test |
测试健康指标 |
/metrics src/ |
限定特定模组范围 |
指标类别
| 类别 | 指标说明 |
|---|---|
| 代码品质 | 复杂度、重复率、lint 警告 |
| 测试健康 | 覆盖率 %、通过率、不稳定测试数 |
| 提交品质 | 大小、频率、格式合规 |
| 债务追踪 | TODO/FIXME 数量、问题存在时间、债务分类 |
| 依赖健康 | 过时套件、漏洞数量 |
技术债分类
基于 SQALE 方法和 ISO/IEC 25010 维护性子特性。
| 类别 | 衡量项目 | 侦测方法 |
|---|---|---|
| 代码债 | TODO/FIXME、死码、重复 | Grep, lint |
| 测试债 | 未覆盖模组、低覆盖区域 | 覆盖率报告 |
| 设计债 | 复杂度热点(cyclomatic > 15)、深层嵌套 | 静态分析 |
| 文档债 | 未文档化 API、过时文档 | JSDoc/TypeDoc 扫描 |
| 依赖债 | 过时套件、已知 CVE | npm audit/outdated |
债务报告格式
## 技术债报告
**日期**: YYYY-MM-DD | **债务密度**: N 项 / 每千行
### 摘要
| 类别 | 数量 | 严重度 | 预估修复时间 | 趋势 |
|------|------|--------|-------------|------|
| 代码债 | 42 | 中 | 21h | ↑ +5 |
| 测试债 | 15 模组 | 高 | 30h | → 稳定 |
| 设计债 | 3 热点 | 高 | 16h | ↓ -1 |
| 文档债 | 8 API | 低 | 8h | ↑ +2 |
| 依赖债 | 5 过时 | 严重 | 4h | → 稳定 |
**总预估修复时间**: 79 小时
### 最高优先项目
1. [严重] CVE-2024-XXXX in lodash — 修复: npm update
2. [高] src/parser/ 复杂度 28 — 修复: 提取方法
3. [高] src/payments/ 0% 覆盖率 — 修复: 新增集成测试
趋势追踪
使用 --debt-trend 与过去的快照比较。
User: /metrics --debt-trend
AI: 技术债趋势(近 3 个月):
代码债: ████████░░ 42 (+5) ↑ 增加中
测试债: ██████░░░░ 15 (0) → 稳定
设计债: ███░░░░░░░ 3 (-1) ↓ 改善中
文档债: ████░░░░░░ 8 (+2) ↑ 增加中
依赖债: ██░░░░░░░░ 5 (0) → 稳定
总计: 73 项(前次 67)— ⚠️ 债务增加中
快速健康分数
健康分数为加权组合:
| 因素 | 权重 | 理想值 |
|---|---|---|
| 测试覆盖率 | 30% | >= 80% |
| Lint 通过率 | 20% | 100% |
| TODO/FIXME 密度 | 15% | < 每千行 1 个 |
| 构建成功率 | 20% | 100% |
| 依赖新鲜度 | 15% | < 3 个月 |
分数 = sum(因素分数 * 权重)
工作流程
- 收集 - 从工具与 git 历史收集原始指标
- 分析 - 与阈值及历史趋势比较
- 报告 - 产生含可行动重点的摘要
- 趋势 - 显示方向(改善 / 衰退 / 稳定)
下一步引导
/metrics 完成后,AI 助手应建议:
指标分析完成。建议下一步:
- 执行
/refactor处理高复杂度模组- 执行
/coverage改善低覆盖率区域- 执行
/audit检视安全与依赖问题- 执行
/metrics --debt-trend追踪技术债趋势- 执行
/retrospective在回顾中讨论技术债