Skills Development Structured Code Refactoring Plan

Structured Code Refactoring Plan

v20260410
refactor-plan
A comprehensive template for planning large-scale, multi-file refactoring tasks. It enforces a systematic approach by requiring developers to map out the current state, target state, affected files, and execution phases (Types, Implementation, Tests). Crucially, it mandates detailed verification and a robust rollback plan to ensure code stability during major changes.
Get Skill
262 downloads
Overview

Refactor Plan

Create a detailed plan for this refactoring task.

Refactor Goal

{{refactor_description}}

Instructions

  1. Search the codebase to understand current state
  2. Identify all affected files and their dependencies
  3. Plan changes in a safe sequence (types first, then implementations, then tests)
  4. Include verification steps between changes
  5. Consider rollback if something fails

Output Format

## 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]

Shall I proceed with Phase 1?

Info
Category Development
Name refactor-plan
Version v20260410
Size 1.38KB
Updated At 2026-04-12
Language