.cursorrules Optimize DRY SOLID Principles

by @Malcolm Jones (bossjones/Tony Dark)

Communication and Problem-Solving:

Code Quality and Best Practices:

Paradigms and Principles:

Semantic Naming and Abstractions:

Platform Thinking:

Response Format:

Handling Uncertainty and Limitations:

When outputting code blocks, include a # or // file name comment prior to the block, with a few lines before and after the modification. This helps the user identify where to make changes.

Stick to the current architecture choices located in pyproject.toml unless the user suggests a new method or module.

If you need clarification on any part of the task, ask for more information before proceeding with the implementation.

Developer Productivity Toolkit

A collection of tools designed to enhance code quality, collaboration, and efficiency for developers, emphasizing modern best practices and adaptable workflows.

Core Tools

Interactive Coding Assistant:
Provides real-time feedback and adaptive suggestions based on user expertise, asking clarifying questions to refine solutions.
Code Quality Checker:
Analyzes code for errors, SOLID principles compliance, and performance issues, offering fixes for logging, error handling, and documentation.
Collaborative Code Review Platform:
Enables code sharing with feedback on best practices, refactoring suggestions, and testing guidance for complex problems.

Advanced Tools

Declarative Paradigm Simulation:
Converts imperative code to declarative/functional styles, demonstrating immutability and composability benefits.
Domain-Specific Language (DSL) Creator:
Helps domain experts build meta-linguistic abstractions for clearer semantic naming and domain alignment.
Reusable Components Library:
Identifies and catalogs common patterns across projects, offering pre-built components and services.

Support Tools

Technical Communication Platform:
Adapts technical detail and tone to user expertise, delivering structured responses via markdown or tables.
Code Refactoring Suggestion Engine:
Proposes style-consistent refactoring options and alternative approaches.
Operational Guidance System:
Provides step-by-step testing/validation instructions to ensure edge-case handling and solution completeness.
Limitations Recorder:
Tracks assumptions and constraints in codebases for future reference.

Key Technologies:

AI/ML Models (for adaptive suggestions)
Static Code Analysis
Functional Programming Paradigms
DSL Frameworks

Overview of .cursorrules prompt

The .cursorrules file provides a framework for developers to enhance communication, problem-solving, and code quality in software development projects. It emphasizes the importance of clarifying user requirements, proposing solutions through collaborative dialogue, and breaking down complex issues into manageable steps. The file encourages the use of best practices in coding, such as adherence to DRY and SOLID principles, error handling, and maintaining code consistency. It advocates for declarative and functional programming paradigms while maintaining modular and maintainable code. The use of semantic naming, well-defined abstractions, and platform thinking is highlighted to improve clarity and reuse. Additionally, the .cursorrules file sets guidelines for response formatting, handling uncertainty, and using the current architecture choices outlined in pyproject.toml. It provides a structured approach to software development, fostering efficient communication and thorough problem-solving.

Updated: March 17, 2025

Developers seeking to build collaborative problem-solving tools, code quality analyzers, or coding mentorship platforms would benefit by implementing standards for effective communication, paradigms, and clarity in code.

Usefull for: