techdebt

技術的負債の検出

コードベース内の技術的負債を特定して修正します。

確認する項目

コードの重複

• ロジックが似ていて、統合できる関数
• コピー＆ペーストされたコードブロック
• 抽象化すべき繰り返しのパターン

デッドコード

• 使用されていないインポート
• 使用されていない関数やクラス
• コメントアウトされたコードブロック
• 到達不能なコードパス

古いパターン

• 非推奨の API の使用
• f-string ではなく古い形式の文字列フォーマット（% または .format）
• list ではなく typing.List を使用した型ヒント
• 公開関数の型ヒントの不足

コードの不吉な臭い

• 50 行を超える関数
• パラメーターが多すぎる関数（5 個超）
• 深すぎるネスト（3 階層超）
• 定数化されていないマジックナンバー
• 複雑すぎる条件分岐

ベストプラクティスの不足

• 公開関数の docstring の不足
• エラーハンドリングの不足
• 設定にすべき値のハードコード
• 重要な処理に対するテストの不足

ワークフロー

1. コードベースをスキャンする

   • 上記の問題に該当するパターンを探します
   • 影響の大きさと修正の容易さに基づいて優先順位を付けます

2. 検出結果を報告する

   • カテゴリ別に問題を列挙します
   • ファイルパスと行番号を含めます
   • 深刻度（高／中／低）を見積もります

3. 問題を修正する

   • 深刻度が高く、修正しやすいものから着手します
   • 修正ごとにアトミックコミットを作成します
   • 変更のたびにテストを実行します

4. 検証する

   • リンターを実行します：ruff check .
   • テストを実行します：pytest
   • 新たな問題が発生していないことを確認します

引数

任意で、対象とするディレクトリまたはファイルを指定できます。

使用方法：

• /techdebt — プロジェクト全体をスキャンします
• /techdebt src/ — 特定のディレクトリをスキャンします
• /techdebt src/utils.py — 特定のファイルをスキャンします

出力

以下の概要を提示します：

• 検出された問題（カテゴリ別）
• 修正した問題
• 今後のセッションに持ち越す項目