refactor

Analyze working code and plan prioritized refactoring steps.

Updated Oct 29, 2024

Search Tags:#code quality #code style #maintainability #cleanup #refactor #code smells

Ready to run

npx skills add https://github.com/namalkanti/dotfiles --skill refactor-namalkanti

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: refactor
Source: https://github.com/namalkanti/dotfiles/tree/main/.codex/skills/refactor
Command: npx skills add https://github.com/namalkanti/dotfiles --skill refactor-namalkanti

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the need for code quality improvements and style consistency by analyzing existing code and planning incremental cleanup passes, ensuring maintainability without altering functionality.

Core Features & Use Cases

Code Analysis: Identifies style violations, code smells, and areas for structural improvement.
Refactoring Planning: Organizes identified issues into prioritized, actionable steps with time estimates and dependencies.
Prompt Generation: Creates detailed prompts for AI-assisted code refactoring.
Use Case: After completing a new feature, use this Skill to systematically clean up the modified code, ensuring it adheres to project standards and is easier to maintain in the future.

Quick Start

Use the refactor skill to organize on-deck cleanup tasks from the current plan.

Frequently Asked Questions about refactor

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

FAQPage Schema

How do I plan incremental code cleanup passes without changing functionality?▼

To plan incremental code cleanup passes without changing functionality, analyze existing code for style violations and code smells, then organize the identified issues into prioritized steps with time estimates and dependencies.

What is the best way to organize on-deck refactoring items into actionable steps?▼

Organizing on-deck refactoring items involves creating a plan file where code smells and style violations are structured into prioritized, actionable steps, tracking dependencies, and generating detailed prompts for AI-assisted execution.

Can I generate prompts for AI-assisted code refactoring of specific files?▼

Yes, you can generate prompts for AI-assisted code refactoring by analyzing working code for maintainability improvements and creating detailed instructions that operate on a plan file while working with related files.

Does this code style analysis tool work with related files in my project?▼

This code style analysis tool works with related files in your project by operating on a plan file to track dependencies and organize on-deck cleanup tasks across the modified codebase.

When should I not use an automated refactoring plan for code smells?▼

You should not use an automated refactoring plan for code smells when your code is not yet working, as this process strictly focuses on improving maintainability and style without altering existing functionality.

How do I identify code smells and style violations after completing a feature?▼

To identify code smells and style violations after completing a feature, analyze the working code using a medium pedantry level, focusing on structural improvement areas and maintainability without changing functionality.