コード クリーンアップ

概要

レビュー後の見た目の改善により、コードを本番環境対応にします。これは /developer-kit-specs:specs.task-review 承認後の最終ワークフローステップです。

入力: docs/specs/[id]/tasks/TASK-XXX.md (reviewed ステータス)
出力: クリーンアップされたコード、タスクが completed としてマーク

使用時期

• レビュー承認後にコードのクリーンアップ、ポーランド、仕上げ、整理、または技術債の除去を依頼されるときに使用します。
• 完了準備のためのコード: デバッグログ、デッドコード、最適化されたインポート、可読性向上の除去に使用します。
• 仕様駆動開発ワークフローの最終品質ゲートとして使用します。
• ロジックのリファクタリングまたはバグ修正ではなく、見た目と衛生管理のクリーンアップに専念しています。

引数

引数	必須	説明
--lang	いいえ	java, spring, typescript, nestjs, react, python, general
--task	はい	タスクファイルへのパス

ベストプラクティス

• クリーンアップのみ、変更なし: 削除または再構成のみ — 機能を変更しないでください
• 動作を保持: クリーンアップ後、コードはまったく同じように機能する必要があります
• プロジェクトツールを使用: ./mvnw spotless:apply, npm run lint:fix, black などを優先します
• TodoWrite を使用: 全 8 フェーズの進捗を追跡します
• 失敗時は停止: テストに失敗した場合は、停止してレポートしてください — 進行しないでください

言語固有のフォーマッタコマンド、インポート順序、grep パターンについては references/language-patterns.md を参照してください。

手順

フェーズ 1: タスク検証

1. $ARGUMENTS でパラメータを解析します:

   • --lang (オプション): ターゲット言語/フレームワーク
   • --task (必須): タスク ID またはファイルパス
   • --spec (オプション): Spec フォルダパス (タスク ID で使用)

   2 つのフォーマットをサポート:

   • フォーマット 1 (直接パス): --task=docs/specs/001-feature/tasks/TASK-001.md
   • フォーマット 2 (spec+task): --spec=docs/specs/001-feature --task=TASK-001

   フォーマット 2 を使用する場合は、タスクファイルパスを次のように構築します: {spec}/tasks/{task}.md

2. タスクファイルを読み取ります。確認:

   • ステータスが reviewed または implemented です (completed ではありません)
   • レビューレポート TASK-XXX--review.md が存在し、承認されています

3. レビューされていない場合 → 停止し、ユーザーに最初に /developer-kit-specs:specs.task-review を実行するよう指示してください

4. タスク ID、タイトル、provides ファイルを抽出します

フェーズ 2: クリーンアップするファイルの特定

1. 作成/変更されたファイルについて TASK-XXX--review.md を読み取ります
2. ファイルパスについてタスク provides フィールドを読み取ります
3. ファイルが存在することを確認; クリーンアップリストを構築します
4. カテゴリ分け: ソースファイル、テストファイル、設定ファイル

フェーズ 3: 技術債の除去

Grep を使用してファイルで一時的/デバッグアーティファクトを検索します:

• console.log, System.out.println, print(, // DEBUG:, // temp, // hack
• 解決済みの TODO/FIXME コメント (未解決のものは保持します)

各検出結果のコンテキストを確認します。確認された債務を除去し、何が削除されたかを文書化します。

フェーズ 4: インポート最適化

1. 利用可能な場合は言語固有のインポート最適化ツールを実行します (参照を参照)
2. ツールが存在しない場合は、未使用のインポートを手動で削除します
3. 変更されたファイルを文書化します

フェーズ 5: コード可読性の改善

1. 利用可能な場合は言語固有のフォーマッタを実行します (参照を参照)
2. フォーマッタがない場合: インデント、長い行の改行 (>120)、スペースの修正
3. 明らかに安全な場合のみデッドコードを削除
4. 変更を文書化します

フェーズ 6: ドキュメンテーション検証

1. クラス/ファイルヘッダーと公開 API ドキュメントを確認します
2. 残りの TODO がまだ有効で、コンテキストを持っているかを確認します
3. 古いコメントを削除または更新します
4. ドキュメント変更を文書化します

フェーズ 7: 最終検証

1. 利用可能な場合はリンタを実行します
2. 利用可能な場合はテストを実行します
3. ロジックまたはシグネチャ変更が導入されていないことを確認します
4. テストに失敗した場合 → 停止してエラーをレポートします

フェーズ 8: タスク完了

1. タスクステータスを自動更新:

   • タスクファイルに ## Cleanup Summary セクションを追加
   • DoD セクションの残りのボックスをチェック
   • フック により、ステータスが completed に自動更新され、completed_date + cleanup_date が設定されます

2. タスクファイルに ## Cleanup Summary を追加します:

   • クリーンアップされたファイル
   • 実施した変更
   • 検証チェックリスト (リンタ、テスト、機能変更なし)

3. すべての todo を完了としてマークします

例

Spring Boot クリーンアップ

/developer-kit-specs:specs-code-cleanup --lang=spring --task="docs/specs/001-user-auth/tasks/TASK-001.md"

アクション:

1. TASK-001 ステータスが reviewed であることを確認
2. ファイル: UserController.java, UserService.java, UserRepository.java
3. 5 つの System.out.println と 2 つの解決済み TODO を削除
4. ./mvnw spotless:apply を実行
5. ./mvnw test -q を実行
6. タスクを completed としてマーク

TypeScript クリーンアップ

/developer-kit-specs:specs-code-cleanup --lang=typescript --task="docs/specs/002-dashboard/tasks/TASK-003.md"

アクション:

1. TASK-003 ステータスが reviewed であることを確認
2. ファイル: Dashboard.tsx, useDashboard.ts, Dashboard.test.tsx
3. 8 つの console.log ステートメントを削除
4. npm run lint:fix と npm run format を実行
5. npm test を実行
6. タスクを completed としてマーク

制約と警告

• クリーンアップ中にロジックまたはシグネチャを変更しないでください
• テストに失敗した場合は、すぐに停止してレポートしてください
• 完了としてマークする前に、動作が変更されていないことを確認してください