Solid Principles

What it does

This skill analyzes code to assess adherence to SOLID design principles, a set of best practices for creating maintainable and flexible software architectures. It identifies potential violations of these principles within Elixir and TypeScript codebases, providing suggestions for refactoring to improve the overall design. The skill focuses on illustrating how to apply each principle with examples of "bad" (non-compliant) and "good" (compliant) code patterns.

When to use it

• When reviewing existing code to identify areas for improvement in terms of maintainability and extensibility.
• During the design phase of a new project, to ensure adherence to SOLID principles from the outset.
• To understand how to apply SOLID principles through practical examples in Elixir and TypeScript.
• When refactoring codebases to reduce complexity and improve modularity.

Key capabilities

• SRP (Single Responsibility Principle) Analysis: Identifies modules with multiple responsibilities and suggests splitting them into smaller, more focused components.
• OCP (Open/Closed Principle) Guidance: Demonstrates how to extend functionality without modifying existing code through the use of interfaces and composition.
• Elixir Code Examples: Provides concrete examples of applying SOLID principles in Elixir using modules and behaviours.
• TypeScript Code Examples: Offers practical illustrations of SOLID principles within TypeScript components and functions, utilizing composition techniques.

Example prompts

• "Analyze this Elixir code for violations of the Single Responsibility Principle." (followed by code snippet)
• "How can I apply the Open/Closed Principle to this TypeScript component?" (followed by code snippet)
• “Show me an example of how to refactor this code to adhere to SOLID principles.”

Tips & gotchas

• The skill provides illustrative examples; it does not automatically fix code. It's intended as a learning and guidance tool.
• Familiarity with basic Elixir and TypeScript syntax is helpful for understanding the provided code snippets.
• The skill focuses on demonstrating the principles rather than providing exhaustive error checking or automated refactoring.