Optimize DRY SOLID Principles .cursorrules prompt file

Author: Malcolm Jones (bossjones/Tony Dark)

What you can build

Interactive Coding Assistant: Develop a tool that provides real-time feedback and coding suggestions based on user input. It uses communication techniques to ask clarifying questions and adapts responses according to the user's expertise level.Collaborative Code Review Platform: A platform where coders can share their code and receive feedback on best practices, improvements, and refactoring suggestions. The tool helps break down complex problems and validates solutions with testing guidance.Code Quality Checker: An application that analyzes the code for errors, performance issues, and adherence to best practices like the SOLID principles. It provides suggestions for error handling, logging, and documentation.Declarative Paradigm Simulation: A tool that converts imperative code snippets into a declarative or functional style, demonstrating the benefits of immutability and composability.Domain-specific Language (DSL) Creator: An app that helps domain experts and stakeholders define and create meta-linguistic abstractions for their domain, allowing for better semantic naming and clarity in the codebase.Reusable Component Library: A service that identifies and catalogs common patterns and models across projects, offering a library of reusable components and services.Technical Communication Platform: A service that adapts the level of technical detail and tone based on the user's expertise, offering concise and structured responses using markdown, bulleted lists, or tables.Limitations Recorder: A tool that helps developers clearly state assumptions and limitations in their codebase, providing a record for future reference and development.Code Refactoring Suggestion Engine: An intelligent tool that suggests modifications for code refactoring, maintaining the coding style conventions, and offering alternative approaches when needed.Operational Guidance System: A platform that provides operational instructions for testing and validating each step of the development process, ensuring the solution is complete and handles edge cases effectively.

Benefits

Synopsis

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.

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.

.cursorrules Content

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.