technical-debt-visualizer

技術的負債の可視化

目的と意図

technical-debt-visualizer は、データに基づいてソフトウェアの品質を把握できるようにします。複雑で変更頻度も高いファイル、つまり「利息の高い」技術的負債を特定し、エンジニアリングリーダーや開発者がリファクタリング作業の優先順位を決めるのに役立ちます。

使用する場面

• スプリント計画：リファクタリング専用のスプリントを始める前に実行し、最も「ROI」が高い対象を特定します。
• アーキテクチャレビュー：レガシーシステムがコードベース全体の健全性に及ぼす影響を可視化するために使用します。
• デューデリジェンス：新規または買収したリポジトリの健全性をすばやく評価します。

使用しない場面

• パフォーマンスのベンチマーク：このツールが測定するのはコードの構造と保守性であり、実行時のパフォーマンスではありません。
• 複雑さの絶対評価：循環的複雑度などのメトリクスは指標であり、絶対的なルールではありません。複雑なロジックが避けられない場合もあります。

入力と出力の例

入力

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

出力

複雑度が高く、テストカバレッジが低いファイル、「ホットスポット」を示す Markdown レポートです。

エラー条件とエッジケース

• Git 履歴がない場合：Git 管理されていないディレクトリで実行すると、「変更頻度」メトリクスは利用できません。
• 未対応の言語：複雑度の分析は言語に依存します。認識できない拡張子は、信頼度スコアを低くして報告されます。

セキュリティとデータの取り扱いに関する考慮事項

• ローカルスキャン：分析はローカルマシン上のメモリ内で完全に実行されます。
• コードを実行しない：このツールは静的解析を使用し、分析対象のコードを実行することはありません。