refactor-planner

Generate step-by-step TDD-based refactoring plans for code cleanup and architecture improvements.

7|5|Updated Jun 2, 2023
One-click install
npx skills add https://github.com/sjmyuan/prompts --skill refactor-planner
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: refactor-planner
Source: https://github.com/sjmyuan/prompts/tree/main/skills/refactor-planner
Command: npx skills add https://github.com/sjmyuan/prompts --skill refactor-planner

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of detailed, step-by-step refactoring plans using a Test-Driven Development (TDD) approach, ensuring code quality and maintainability.

Core Features & Use Cases

  • Automated Refactoring Plans: Generates plans for code cleanup, architecture improvements, technical debt reduction, and quality enhancements.
  • TDD Integration: Incorporates TDD principles (write tests, confirm failure, refactor, verify) into each step.
  • Use Case: When you need to refactor a complex module, this Skill will provide a clear, actionable plan to improve the code safely and systematically.

Quick Start

Use the refactor-planner skill to generate a TDD-based refactoring plan for improving the performance of the user authentication module.

Frequently Asked Questions about refactor-planner

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a refactoring plan for technical debt?▼

A refactoring plan for technical debt is generated by analyzing the code and creating a step-by-step TDD-based plan. This approach ensures code quality by outlining tests, refactoring, and verification.

What is TDD-based refactoring?▼

TDD-based refactoring is an approach that integrates Test-Driven Development into code cleanup. It involves writing tests, confirming failures, refactoring the code, and verifying the results to systematically improve architecture and reduce technical debt.

How do I plan code cleanup for a complex module?▼

You can plan code cleanup for a complex module by generating an automated, step-by-step refactoring plan. This plan handles structural changes and quality enhancements systematically using TDD principles to ensure safety.

Does this refactoring planner execute code changes?▼

No, this refactoring planner does not execute code changes. It only produces a detailed plan for code improvements and structural changes; you must pair it with a plan-executor tool to implement the actual modifications.

When do I need a TDD refactoring plan?▼

You need a TDD refactoring plan when you are requesting refactoring, architecture improvements, or technical debt reduction. It provides a clear, actionable, and systematic path to safely enhance code quality and maintainability.