mcpField
R
refactor-plan

refactor-plan

github.com/githubDevelopment40.5k13.0k installsUpdated 1d ago
Repository

About refactor-plan

A coding-agent skill for analyzing a repository and producing a staged refactoring plan before code changes. It emphasizes verification, recovery steps, and waiting for approval before implementation.

Key features

  1. 01Repository and dependency review
  2. 02Safe, phased change sequence
  3. 03Verification between phases
  4. 04Rollback guidance for risky phases
  5. 05Approval before implementation

Use cases

  1. 01Planning a multi-file refactor
  2. 02Assessing hidden coupling before edits
  3. 03Sequencing contract, implementation, and test changes

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/github/awesome-copilot --skill refactor-plan

After installing, type/refactor-planin Claude Code to confirm it loaded.

Details

From the project README

Refactor Plan

Create a detailed plan before making any code changes.

Instructions

  1. Do not edit files while preparing the plan.
  2. Search the codebase to understand the current state. Read enough implementation, tests, configuration, and docs to make the plan specific to the repository.
  3. Identify affected files, ownership boundaries, dependencies, and likely hidden coupling.
  4. Plan changes in a safe sequence. Prefer contracts and types first, then implementations, then callers, then tests, then cleanup.
  5. Include verification steps between phases and a final validation command.
  6. Include rollback or recovery steps for the riskiest phases.
  7. Output the complete plan using the format below.
  8. Stop after the plan and ask for confirmation before implementing. If the user already asked you to implement, still produce the plan first and wait for confirmation unless they explicitly said to continue without review after the plan.

If the request is too ambiguous to plan safely, ask concise clarifying questions instead of editing files.

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]

After the plan, ask: "Shall I proceed with Phase 1?"

Comments

Markdown supported