technical-debt-visualizer

技术债可视化工具

目的与意图

technical-debt-visualizer 提供软件质量的数据驱动视图。它通过识别既复杂又频繁变更的文件（即“高利息”技术债），帮助工程负责人和开发者确定重构工作的优先级。

适用场景

• 迭代规划：在专门的重构迭代开始前运行此工具，以找出最佳的“投资回报率”目标。
• 架构评审：用于直观呈现遗留系统对整体代码库健康状况的影响。
• 尽职调查：快速评估新建或收购的代码库的健康状况。

不适用场景

• 性能基准测试：此工具衡量代码的结构和可维护性，而非运行时性能。
• 绝对复杂度评级：圈复杂度等指标只是参考，并非绝对规则；有些复杂逻辑不可避免。

输入和输出示例

输入

source_path: "./src"
output_format: "markdown"

输出

一份 Markdown 报告，突出显示“热点”——复杂度高且测试覆盖率低的文件。

错误情况和边缘情形

• 没有 Git 历史记录：如果在非 Git 目录中运行，“变更频率”指标将不可用。
• 不支持的语言：复杂度分析取决于语言；未知扩展名会以较低的置信度报告。

安全和数据处理注意事项

• 本地扫描：分析完全在本地计算机的内存中进行。
• 不执行代码：此工具使用静态分析；绝不会运行正在分析的代码。