refactor-plan について
コードベースを調査し、コード変更前に段階的なリファクタリング計画を作るコーディングエージェント向けスキルです。各段階の検証やリスクの高い変更からの復旧策を含め、実装前に確認を求めます。
主な機能
- 01コードベースと依存関係の調査
- 02安全な段階的変更の順序
- 03各段階の検証手順
- 04高リスク段階のロールバック案
- 05実装前の確認
活用シーン
- 01複数ファイルにまたがるリファクタリングの計画
- 02変更前の潜在的な結合の把握
- 03契約・実装・テスト変更の順序付け
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ github/ awesome-copilot --skill refactor-planインストール後、Claude Code で/refactor-planを入力して読み込まれたか確認します。
詳細
リファクタリング計画
コードを変更する前に、詳細な計画を作成してください。
手順
- 計画の準備中はファイルを編集しないでください。
- コードベースを検索して現在の状態を把握してください。実装、テスト、設定、ドキュメントを十分に読み、リポジトリに即した具体的な計画を立ててください。
- 影響を受けるファイル、所有権の境界、依存関係、および隠れた結合の可能性を特定してください。
- 安全な順序で変更を計画してください。まずコントラクトと型、次に実装、次に呼び出し元、次にテスト、最後にクリーンアップを優先してください。
- 各フェーズ間の検証手順と、最終的な検証コマンドを含めてください。
- 最もリスクの高いフェーズについては、ロールバックまたはリカバリの手順を含めてください。
- 以下の形式で完全な計画を出力してください。
- 計画を出したら停止し、実装前に確認を求めてください。ユーザーがすでに実装を依頼していた場合でも、計画後にレビューなしで続行してよいと明示的に言われていない限り、まず計画を作成して確認を待ってください。
安全に計画を立てるにはリクエストが曖昧すぎる場合は、ファイルを編集するのではなく、簡潔な確認質問をしてください。
出力形式
## Refactor Plan: [title]
### Current State
[Brief description of how things work now]
### Target State
[Brief description of how things will work after]
### Affected Files
| File | Change Type | Dependencies |
|------|-------------|--------------|
| path | modify/create/delete | blocks X, blocked by Y |
### Execution Plan
#### Phase 1: Types and Interfaces
- [ ] Step 1.1: [action] in `file.ts`
- [ ] Verify: [how to check it worked]
#### Phase 2: Implementation
- [ ] Step 2.1: [action] in `file.ts`
- [ ] Verify: [how to check]
#### Phase 3: Tests
- [ ] Step 3.1: Update tests in `file.test.ts`
- [ ] Verify: Run `npm test`
#### Phase 4: Cleanup
- [ ] Remove deprecated code
- [ ] Update documentation
### Rollback Plan
If something fails:
1. [Step to undo]
2. [Step to undo]
### Risks
- [Potential issue and mitigation]
計画の後に、「Phase 1 に進めてよろしいですか?」と尋ねてください。
コメント
Markdown 対応