Refactor

What it does

This skill automates code refactoring for Python and Node.js backend projects, aiming to improve readability, performance, and maintainability. It leverages tartinerlabs' AI to identify and suggest fixes based on a defined set of rules categorized as General Patterns, TypeScript/JS Idioms, and Design Principles. The process involves auditing the codebase, reporting findings, and applying targeted refactorings while preserving existing behavior.

When to use it

• To improve the overall quality and maintainability of a Python or Node.js backend codebase.
• When dealing with codebases exhibiting common issues like deeply nested functions, hardcoded values, or inefficient TypeScript/JS idioms.
• As part of a regular code review process to proactively identify and address potential refactoring opportunities.
• To reduce technical debt by systematically addressing design principle violations such as tight coupling or god objects.

Key capabilities

• Code Auditing: Scans specified files, directories, or entire codebases for rule violations.
• Categorized Reporting: Groups findings into General Patterns, TypeScript/JS Idioms, and Design Principles categories.
• Targeted Refactoring: Applies minimal changes to address identified issues while preserving existing functionality.
• Rule-Based System: Operates based on a defined set of rules with detailed explanations and examples (found in the rules/ directory).

Example prompts

• "Refactor the codebase located at /src/services."
• "Audit the file /src/api/client.ts for TypeScript/JS idiom violations."
• "Run a general refactoring audit on all files within the project."

Tips & gotchas

• The skill operates based on predefined rules; review these in the rules/ directory to understand its behavior and limitations.
• Refactorings are designed to be minimal, focusing only on the identified issue. More extensive changes may require manual intervention.
• Ensure that the target scope (files or directories) is clearly defined for accurate auditing.