Files

Zhongwei Li b3ad2e3943 Initial commit

2025-11-29 18:09:29 +08:00

15 KiB

Raw Blame History

description

description
TDDのRefactorフェーズを実行します。テストを通す実装が完了した後、コード品質の改善とリファクタリングを行います。

TDD Refactorフェーズ（コード改善）

TDDのRefactorフェーズを実行します。

事前準備

開発コンテキストの準備を行います：

追加ルールの読み込み
- AGENTS.md ファイルが存在する場合は読み込み
- docs/rule ディレクトリが存在する場合は読み込み
- docs/rule/tdd ディレクトリが存在する場合は読み込み
- docs/rule/tdd/refactor ディレクトリが存在する場合は読み込み
- 各ディレクトリ内のすべてのファイルを読み込み、追加ルールとして適用
@agent-symbol-searcher でリファクタリング関連情報を検索し、見つかったファイルを読み込み
- 既存のコードスタイルやベストプラクティスを検索し、スタイルガイドをReadツールで読み込み
- プロジェクト全体のアーキテクチャパターンを特定し、設計文書をReadツールで読み込み
- 再利用可能なユーティリティ関数やコンポーネントを確認し、関連ファイルをReadツールで読み込み
関連ファイルを直接読み込み
- docs/implements/{要件名}/{{task_id}}/{feature_name}-memo.md - 既存の開発履歴を確認
- docs/implements/{要件名}/{{task_id}}/{feature_name}-requirements.md - 要件定義を確認
- docs/implements/{要件名}/{{task_id}}/{feature_name}-testcases.md - テストケース定義を確認
- docs/implements/{要件名}/{{task_id}}/{feature_name}-green-phase.md - Greenフェーズの実装を確認
- 関連する設計文書やタスクファイルも必要に応じて読み込み

読み込み完了後、準備されたコンテキスト情報を基にRefactorフェーズ（コード改善）の作業を開始します。

信頼性レベル指示

リファクタリング時には、各改善内容について元の資料との照合状況を以下の信号でコメントしてください：

🔵 青信号: 元の資料を参考にしてほぼ推測していない場合
🟡 黄信号: 元の資料から妥当な推測の場合
🔴 赤信号: 元の資料にない推測の場合

目標

Greenフェーズで実装されたコードを以下の観点で改善してください。テストは必ず通り続けることが大前提です。

改善の観点

1. 可読性の向上

変数名・関数名の改善
日本語コメントの充実
コードの構造を分かりやすく

2. 重複コードの除去（DRY原則）

同じような処理の共通化
定数の抽出
ヘルパー関数の作成

3. 設計の改善

単一責任原則の適用
依存関係の整理
モジュール化の検討
NEVER: 実装コード内でのモック・スタブの記述
NEVER: 実装コード内でDBに代わるインメモリーストレージの利用

4. ファイルサイズの最適化

ファイルサイズが500行未満になるよう分割・最適化
長大なファイルの機能別分割
適切なモジュール境界の設定

5. コード品質の確保

lintエラーの解消
typecheckエラーの解消
フォーマットの統一
静的解析ツールのチェッククリア

6. セキュリティレビュー

脆弱性に繋がる実装の検出と修正
入力値検証の強化
SQLインジェクション対策の確認
XSS（Cross-Site Scripting）対策の確認
CSRF（Cross-Site Request Forgery）対策の確認
データ漏洩リスクの回避
認証・認可の適切な実装

7. パフォーマンスレビュー

アルゴリズムの計算量解析
メモリ使用量の最適化
不要な処理の削除
キャッシュ戦略の検討
データベースクエリの最適化
ループ処理の効率化
非同期処理の適切な実装

8. エラーハンドリングの充実

入力値の検証
適切なエラーメッセージ
例外処理の改善

リファクタリング時の日本語コメント強化要件

リファクタリングでは既存の日本語コメントを改善し、新たなコメントを追加してください：

改善された関数・メソッドのコメント

/**
 * 【機能概要】: [リファクタ後の機能の詳細説明]
 * 【改善内容】: [どのような改善を行ったかを説明]
 * 【設計方針】: [なぜこの設計にしたかの理由]
 * 【パフォーマンス】: [性能面での考慮事項]
 * 【保守性】: [メンテナンスしやすくするための工夫]
 * 🔵🟡🔴 信頼性レベル: [この改善が元資料のどの程度に基づいているか]
 * @param {type} paramName - [パラメータの詳細説明と制約]
 * @returns {type} - [戻り値の詳細説明と保証事項]
 */
function improvedFunction(paramName) {
  // 【実装詳細】: [改善された実装の内容と理由]
}

ヘルパー関数・ユーティリティのコメント

/**
 * 【ヘルパー関数】: [この関数の役割と作成理由]
 * 【再利用性】: [どのような場面で再利用できるか]
 * 【単一責任】: [この関数が担当する責任の範囲]
 */
function helperFunction(input) {
  // 【処理効率化】: [処理を効率化するための工夫] 🔵🟡🔴
  // 【可読性向上】: [コードの読みやすさを向上させる仕組み] 🔵🟡🔴
}

定数・設定値のコメント

// 【設定定数】: [この定数の役割と設定理由] 🔵🟡🔴
// 【調整可能性】: [将来的に調整が必要になる可能性と方法] 🔵🟡🔴
const IMPROVED_CONSTANT = 100; // 【最適化済み】: パフォーマンステストに基づき最適化 🔵🟡🔴

// 【設定オブジェクト】: [設定をまとめた理由と管理方針]
const CONFIG = {
  // 【各設定項目】: [それぞれの設定値の意味と影響範囲]
  maxRetries: 3, // 【リトライ回数】: 実運用での経験に基づく適切な回数
  timeout: 5000, // 【タイムアウト】: ユーザビリティを考慮した時間設定
};

エラーハンドリング改善のコメント

try {
  // 【安全な処理実行】: [例外が発生する可能性と対策]
  const result = riskyOperation();
} catch (error) {
  // 【詳細エラー処理】: [エラーの種類に応じた適切な処理]
  // 【ユーザビリティ】: [ユーザーにとって分かりやすいエラー対応]
  if (error.code === 'SPECIFIC_ERROR') {
    // 【特定エラー対応】: [このエラーに特化した処理の理由]
    return handleSpecificError(error);
  }
  // 【一般エラー対応】: [予期しないエラーへの安全な対処]
  return handleGenericError(error);
}

リファクタリングの手順

現在のテストが全て通ることを確認
- 【品質保証】: リファクタ前の動作確認
- 【安全性確保】: 変更による機能破綻の防止
- 【実行方法】: Taskツールを使用してテストを実行し、結果を詳細に分析
コード・テスト除外チェック
- 【.gitignore確認】: 本来確認対象のコードファイルが除外されていないかチェック
- 【テスト除外確認】: describe.skip, it.skip, test.skip等でテストが無効化されていないかチェック
- 【jest設定確認】: jest.config.jsやpackage.jsonのtestPathIgnorePatterns等でテストファイルが除外されていないかチェック
- 【実行対象確認】: 実際に実行されるべきテストとコードが適切に対象に含まれているかチェック
開発時生成ファイルのクリーンアップ
- 【不要ファイル検出】: 開発中に作成された一時的なファイルを検出・削除
- 【対象ファイルパターン】: 以下のパターンに該当するファイルを確認
  - debug-*.js, debug-*.ts: デバッグ用スクリプト
  - test-*.js, test-*.ts, temp-*.js: 一時テストファイル
  - *.tmp, *.temp, *.bak, *.orig: 一時・バックアップファイル
  - *~, .DS_Store: エディタ・システム生成ファイル
  - test-output-*, *.test-output: テスト出力ファイル
- 【安全確認】: 削除前に各ファイルの内容を確認し、重要なコードが含まれていないかチェック
- 【選択的削除】: 不要と判断されたファイルのみを削除し、必要なファイルは保持
- 【削除ログ】: 削除したファイルと削除理由をログとして記録
- 【実行手順】:
  1. find . -name "debug-*" -o -name "test-*" -o -name "temp-*" -o -name "*.tmp" -o -name "*.temp" -o -name "*.bak" -o -name "*.orig" -o -name "*~" -o -name ".DS_Store" | grep -v node_modules でファイル検出
  2. 各ファイルの内容をReadツールで確認
  3. 不要と判断されたファイルは削除し、削除理由を記録
セキュリティレビューの実施
- 【脆弱性検査】: コード全体のセキュリティホールの特定
- 【入力検証確認】: 不正な入力値に対する防御機能の確認
- 【セキュリティガイドライン適用】: 業界標準のセキュリティベストプラクティスの適用
パフォーマンスレビューの実施
- 【計算量解析】: アルゴリズムの時間計算量・空間計算量の評価
- 【ボトルネック特定】: 処理速度やメモリ使用量の問題箇所の特定
- 【最適化戦略】: 具体的なパフォーマンス改善施策の立案
小さな改善を1つずつ適用
- 【段階的改善】: 影響範囲を限定した安全な変更
- 【トレーサビリティ】: 変更内容の追跡可能性確保
各改善後にテストを実行
- 【継続的検証】: 改善の度に動作確認
- 【早期発見】: 問題の早期発見と修正
- 【実行方法】: Taskツールを使用してテストを実行し、改善の影響を確認
テストが失敗したら即座に戻す
- 【迅速復旧】: 問題発生時の素早い対応
- 【安定性維持】: システムの安定した状態を保持

注意事項

機能的な変更は行わない（新機能追加はNG）
テストが通らなくなったら即座に修正
一度に大きな変更をしない
日本語コメントの品質も向上させる
品質確認のためのテスト実行時はTaskツールを利用する

提供してください

セキュリティレビュー結果: 脆弱性の有無と対応策
パフォーマンスレビュー結果: 性能課題の分析と改善策
改善されたコード: リファクタリング後のコード（強化された日本語コメント付き）
改善ポイントの説明: 何をどのように改善したか（セキュリティ・パフォーマンス観点を含む）
テスト実行結果: Taskツールを使用して全てのテストが引き続き通ることの確認
品質評価: 現在のコードの品質レベル（セキュリティ・パフォーマンス評価を含む）
コメント改善内容: 日本語コメントをどのように強化したか

リファクタリング例

// Before: ハードコーディング
function add(a, b) {
  return 5; // とりあえず動く実装
}

// After: 適切な実装（改善された日本語コメント付き）
/**
 * 【機能概要】: 2つの数値を加算し、結果を返す
 * 【改善内容】: ハードコーディングを削除し、実際の加算処理を実装
 * 【設計方針】: 入力値検証と型安全性を重視した設計
 * 【エラー処理】: 不正な入力に対する適切な例外処理を実装
 */
function add(firstNumber, secondNumber) {
  // 【入力値検証】: 数値以外の入力を早期に検出してエラーを防ぐ
  // 【型安全性】: TypeScriptの型チェックと併せて実行時検証を実施
  if (typeof firstNumber !== 'number' || typeof secondNumber !== 'number') {
    // 【ユーザビリティ】: 開発者にとって分かりやすいエラーメッセージを提供
    throw new Error('引数は数値である必要があります');
  }

  // 【メイン処理】: シンプルで確実な加算処理
  // 【パフォーマンス】: 不要な処理を避けた効率的な実装
  return firstNumber + secondNumber;
}

リファクタリング完了後、以下を実行してください：

メモファイル最終更新: docs/implements/{要件名}/{{task_id}}/{feature_name}-memo.md ファイルのRefactorフェーズセクションと概要を更新
- 改善内容、セキュリティレビュー結果、パフォーマンスレビュー結果を記録
- 最終コード、品質評価を記録
- 概要セクションの現在のフェーズを「完了」に更新
リファクタリング内容と設計改善を docs/implements/{要件名}/{{task_id}}/{feature_name}-refactor-phase.md に保存（既存ファイルがある場合は追記）
TODOステータスを更新（Refactorフェーズ完了をマーク）
品質判定: リファクタリング成果の品質を以下の基準で判定
- テスト結果: 全てのテストが引き続き成功
- セキュリティ: 重大な脆弱性が発見されていない
- パフォーマンス: 重大な性能課題が発見されていない
- リファクタ品質: 目標が達成されている
- コード品質: 適切なレベルに向上
次のステップ表示: 判定結果に関わらず、次のお勧めコマンドを表示
- 「次のお勧めステップ: /tsumiki:tdd-verify-complete で完全性検証を実行します。」

品質判定基準

✅ 高品質:
- テスト結果: Taskツールによる実行で全て継続成功
- セキュリティ: 重大な脆弱性なし
- パフォーマンス: 重大な性能課題なし
- リファクタ品質: 目標達成
- コード品質: 適切なレベル
- ドキュメント: 完成

⚠️ 要改善:
- テストの一部失敗（Taskツールで検出）
- セキュリティ脆弱性発見
- パフォーマンス課題発見
- リファクタ目標未達成
- 品質改善不十分
- ドキュメント不備

TODO更新パターン

- 現在のTODO「Refactorフェーズ（品質改善）」を「completed」にマーク
- リファクタリングフェーズの完了をTODO内容に反映
- 品質判定結果をTODO内容に記録
- 次のフェーズ「完全性検証」をTODOに追加
- 改善が必要な箇所がある場合は新たなTODOとして追加

15 KiB Raw Blame History Unescape Escape