For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
メインナビゲーション
Codex

Codex use case

コードベースのリファクタリング

挙動を変えずにデッドコードを削除し、レガシーパターンをモダナイズします。

Difficulty 上級
Time horizon 1時間

Codex を使い、デッドコードの削除、大きなファイルの整理、重複ロジックの統合、古くなったパターンのモダナイズを、レビューしやすい小さな単位で進めます。

最適な用途

  • デッドコード、肥大化したモジュール、重複ロジック、古くなった抽象化により、日常的な修正のコストが高くなっているコードベース
  • フレームワークや技術スタックの移行に発展させず、既存のコードをそのままモダナイズする必要があるチーム

Contents

    ← すべてのユースケース

    コードベースのリファクタリング

    挙動を変えずにデッドコードを削除し、レガシーパターンをモダナイズします。

    Codex を使い、デッドコードの削除、大きなファイルの整理、重複ロジックの統合、古くなったパターンのモダナイズを、レビューしやすい小さな単位で進めます。

    上級
    1時間

    Codex を使い、デッドコードの削除、大きなファイルの整理、重複ロジックの統合、古くなったパターンのモダナイズを、レビューしやすい小さな単位で進めます。

    上級
    1時間

    最適な用途

    • デッドコード、肥大化したモジュール、重複ロジック、古くなった抽象化により、日常的な修正のコストが高くなっているコードベース
    • フレームワークや技術スタックの移行に発展させず、既存のコードをそのままモダナイズする必要があるチーム

    スキルとプラグイン

    • モダナイズ作業をマージする前に、セキュリティ上の注意を要するクリーンアップ、依存関係の変更、認証フロー、外部に公開される領域をレビューします。
    • 実績のあるモダナイズ手法、レビュー用チェックリスト、同等性確認ワークフローを、リポジトリやチームで再利用できるスキルにします。
    Skill Why use it
    Security Best Practices モダナイズ作業をマージする前に、セキュリティ上の注意を要するクリーンアップ、依存関係の変更、認証フロー、外部に公開される領域をレビューします。
    Skill Creator 実績のあるモダナイズ手法、レビュー用チェックリスト、同等性確認ワークフローを、リポジトリやチームで再利用できるスキルにします。

    開始用プロンプト

    このコードベースをモダナイズし、リファクタリングしてください。 要件: - 明示的に機能上の変更を依頼しない限り、挙動を維持してください。 - まず、変更作業の妨げになっているデッドコード、重複した処理経路、肥大化したモジュール、古くなった抽象化、レガシーパターンを特定してください。 - 提案する作業単位ごとに、現在の挙動、構造上の改善、その改善後も挙動が変わっていないことを証明する検証項目を明示してください。 - 作業を、デッドコードの削除、制御フローの簡素化、ヘルパーの抽出、古いパターンのリポジトリの現行規約に沿うものへの置き換えなど、レビューしやすい小さなリファクタリング単位に分割してください。 - リファクタリングに必要な場合を除き、公開 API の互換性を維持してください。 - 別の移行タスクに分けるべきフレームワーク移行、依存関係のアップグレード、API の変更、アーキテクチャの変更があれば明示してください。 - 作業範囲が広い場合は、実装前に作成すべきドキュメント、仕様、同等性チェックを提案してください。 この作業を行うための計画を提案してください。
    このコードベースをモダナイズし、リファクタリングしてください。 要件: - 明示的に機能上の変更を依頼しない限り、挙動を維持してください。 - まず、変更作業の妨げになっているデッドコード、重複した処理経路、肥大化したモジュール、古くなった抽象化、レガシーパターンを特定してください。 - 提案する作業単位ごとに、現在の挙動、構造上の改善、その改善後も挙動が変わっていないことを証明する検証項目を明示してください。 - 作業を、デッドコードの削除、制御フローの簡素化、ヘルパーの抽出、古いパターンのリポジトリの現行規約に沿うものへの置き換えなど、レビューしやすい小さなリファクタリング単位に分割してください。 - リファクタリングに必要な場合を除き、公開 API の互換性を維持してください。 - 別の移行タスクに分けるべきフレームワーク移行、依存関係のアップグレード、API の変更、アーキテクチャの変更があれば明示してください。 - 作業範囲が広い場合は、実装前に作成すべきドキュメント、仕様、同等性チェックを提案してください。 この作業を行うための計画を提案してください。

    はじめに

    コードベースに未使用コード、重複ロジック、古くなった抽象化、大きなファイル、レガシーパターンが蓄積し、変更のたびに本来以上のコストがかかるようになっている場合は、リファクタリングによる技術的負債の削減を検討してください。リファクタリングの目的は、技術スタックの移行に発展させることなく、既存システムの構造を改善することです。

    ここで Codex が役立つのは、まず複雑になった領域の全体像を把握し、その後、未使用のコードパスの削除、大きなモジュールの整理、重複したコードパスの統合、古いフレームワークパターンのモダナイズ、各作業単位の検証強化といったクリーンアップを、レビューしやすい小さな単位で進められるためです。

    目標は、移行を伴わずに現行のコードベースを改善することです:

    1. 不要になった未使用コード、古くなったヘルパー、古いフラグ、互換性維持用のシムを削除します。
    2. ヘルパーを抽出し、コンポーネントを分割し、副作用をより明確な境界へ移すことで、見通しの悪いモジュールを小さく整理します。
    3. レガシーパターンをリポジトリの現行規約に沿うものへ置き換えます。たとえば、より新しいフレームワークの基本要素、明確な型、単純な状態フロー、標準ライブラリのユーティリティを使用します。
    4. 外部から見た挙動を変えず、次の変更を低コストで行えるようにします。

    使用方法

    1. 編集する前に、見通しの悪いモジュール、重複ロジック、未使用コード、テスト、公開インターフェースの契約、リポジトリの現状に合わなくなった古いパターンを Codex に洗い出させ、対象領域の全体像を把握します。
    2. クリーンアップでは、一度に 1 つのテーマを選びます:未使用コードの削除、制御フローの簡素化、古いパターンのモダナイズ、大きなファイルを責任範囲が明確な小さな単位に分割することなどです。
    3. Codex がファイルにパッチを適用する前に、現在の挙動、実施予定の構造上の改善、挙動が変わっていないことを証明するための最小限の検証を明示させます。
    4. クリーンアップ全体を 1 つの diff にまとめるのではなく、各作業単位の完了後に変更をレビューし、最小限で効果的なチェックを実行します。
    5. スタック変更、依存関係の移行、アーキテクチャ変更は、クリーンアップを完了するために必要な場合を除き、別のタスクとして扱います。

    プランモードを使うと、作業を始める前に リファクタリングの計画を作成できます。

    ExecPlans の活用

    コードのモダナイズに関するクックブック では、ExecPlans を紹介しています。ExecPlans は、Codex がクリーンアップの全体像を把握し、目標とする最終状態を明確にして、各作業単位の検証結果を記録するためのドキュメントです。 リファクタリングが複数のモジュールにまたがる場合や、複数のセッションを要する場合に役立ちます。ExecPlans を使って、削除した内容、パターンの更新、変更せず維持する必要があった契約、まだ先送りになっている作業を記録してください。

    繰り返し使うパターンへのスキル活用

    スキル は、同じクリーンアップルールを複数のリポジトリ、サービス、チームで繰り返し使う場合に役立ちます。利用できる場合はフレームワーク固有のスキルを使い、リスクの高いクリーンアップにはセキュリティと CI のスキルを追加します。また、未使用コードの削除、モジュールの抽出、レガシーパターンのモダナイズについて実績のあるチェックリストができたら、チーム向けのスキルを作成します。 複数のコードベースで同じモダナイズ作業を行うことになった場合は、Codex を使って、最初に成功した作業を再利用可能なスキルにできます。

    関連するユースケース