mcpField
T
tech-debt-analyzer

tech-debt-analyzer

github.com/travisjneuman测试与质量106136 次安装今天更新
代码仓库

关于 tech-debt-analyzer

用于系统识别、评估和记录技术债务的技能,适合维护代码质量与规划重构的开发团队。它结合自动化检查、严重程度评估和优先级矩阵,形成可执行的债务清单。

主要功能

  1. 01检测代码异味与复杂度
  2. 02检查依赖过时和漏洞
  3. 03按严重程度评估问题
  4. 04使用影响与成本矩阵排序
  5. 05编写技术债务登记项

适用场景

  1. 01评估代码库的可维护性
  2. 02建立并维护技术债务清单
  3. 03规划重构工作的优先级
  4. 04排查依赖与安全问题

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/travisjneuman/.claude --skill tech-debt-analyzer

安装后在 Claude Code 中输入/tech-debt-analyzer确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

index.js
package.json
assets/
ADR_TEMPLATE.md
DEBT_REGISTER_TEMPLATE.md
references/
debt_categories.md
scripts/
analyze_dependencies.py
detect_code_smells.py

详细介绍

技术债务分析器

系统地识别、分析并记录技术债务。

适用场景

适用于:

  • 分析代码质量问题
  • 创建技术债务清单
  • 评估代码可维护性
  • 识别依赖项问题
  • 记录安全漏洞
  • 规划重构工作

不适用于:

  • 编写新代码 → 使用 generic-feature-developer
  • 代码审查 → 使用 generic-code-reviewer
  • 编写测试 → 使用 test-specialist

快速分析命令

# Find large files (>500 lines)
find src -name "*.ts" -exec wc -l {} + | awk '$1 > 500' | sort -rn

# Find TODO/FIXME markers
grep -rn "TODO\|FIXME\|HACK\|XXX" src/

# Check for console.log in production code
grep -rn "console.log" src/ --include="*.ts" --include="*.tsx"

# Find TypeScript 'any' usage
grep -rn ": any" src/ --include="*.ts" --include="*.tsx"

# Check outdated dependencies
npm outdated

# Security vulnerabilities
npm audit

# Unused exports (requires ts-unused-exports)
npx ts-unused-exports tsconfig.json

债务类别

类别示例
代码质量文件过大、函数复杂、TODO/FIXME 标记
架构耦合紧密、缺少抽象、循环依赖
测试覆盖率不足、测试脆弱、执行缓慢
文档缺少 README、文档过时、没有 ADR
依赖项软件包过时、安全漏洞
性能N+1 查询、内存泄漏、包体积过大
安全缺少验证、机密暴露、XSS/SQL 注入

分析工作流

1. 自动检测

需检查的代码异味:

  • 文件过大(>500 行)
  • 函数复杂(圈复杂度 >10)
  • 债务标记(TODO、FIXME、HACK、XXX)
  • 生产代码中的 Console 语句
  • TypeScript 中的 any 类型
  • 参数列表过长(>5 个参数)
  • 嵌套过深(>4 层)

依赖项问题:

  • 已弃用的软件包
  • 功能重复
  • 版本约束过宽松
  • 已知漏洞
2. 严重程度评估
严重程度标准行动
严重安全漏洞、数据丢失风险立即修复
高性能问题、阻塞问题当前迭代处理
中代码质量、缺少文档本季度处理
低轻微代码异味、优化项有空时处理
3. 优先级矩阵
影响 / 工作量低中高
影响高优先处理次优先处理规划并处理
影响中次优先处理规划并处理酌情考虑
影响低快速见效酌情考虑避免

债务清单格式

## DEBT-001: Description

**Category:** Code Quality | **Severity:** High
**Location:** src/services/UserService.ts

**Description:** Brief description of the issue

**Impact:**

- Business: How it affects delivery
- Technical: Why it's problematic
- Risk: What could go wrong

**Proposed Solution:** What to do about it
**Effort:** Days/hours estimate
**Target:** Sprint/quarter

预防策略

自动化防护
{
  "rules": {
    "complexity": ["error", 10],
    "max-lines-per-function": ["error", 50],
    "max-params": ["error", 5],
    "max-depth": ["error", 4]
  }
}
维护计划
频率任务
每周检查 TODO/FIXME,更新清单
每月更新依赖项,审查债务
每季度全面分析,审查架构

自我审查清单

完成债务分析后:

  • 已运行所有自动化检查
  • 已人工审查关键路径
  • 严重程度评估有充分依据
  • 提出的解决方案可执行
  • 始终如一地应用优先级矩阵
  • 清单条目完整

另请参阅

评论

支持 Markdown