JSDoc Development Guidelines .cursorrules prompt file
About .cursorrules prompt file
What you can build
Code Improvement Tool: A web-based application that helps developers improve their code by analyzing it against senior developer guidelines and offering suggestions based on principles like immutability, simplicity, and DRY.
Automated Code Review Assistant: A tool that integrates with GitHub or other version control systems to provide automated, inline code reviews, highlighting areas that need improvement using the functional paradigm and performance guidelines.
Collaborative Coding Platform: An online platform that encourages developers to work together on coding problems, applying concepts like functional programming and testing, with built-in tools to evaluate code based on the described best practices.
Functional Programming Course: An e-learning platform focused on teaching functional programming principles, offering interactive tutorials and exercises that apply Immutable practices and functional paradigms in real-world scenarios.
Developer Productivity Dashboard: A personalized dashboard for developers that tracks adherence to guidelines such as code maintainability and reusability, providing tips and resources for continuous improvement.
Code Refactoring Service: A consultancy service that analyzes existing codebases and proposes systematic refactoring strategies to improve simplicity and readability by applying principles such as composition over inheritance.
Bug Tracking and Documentation App: An application that helps developers track, manage, and comment on bugs using best practices like using TODO and FIXME comments, with integrated JSDoc documentation suggestions.
Error Handling Library: A JavaScript library that simplifies error handling by providing utilities for returning and logging errors instead of throwing exceptions, tailored for both frontend and backend environments.
End-to-End Testing Suite: A comprehensive testing suite focused on unit, integration, and end-to-end tests, with tools for developers to automate and streamline the testing process while adhering to described testing strategies.
Performance Profiling Tool: A performance profiling tool that helps developers identify bottlenecks by providing detailed analysis before suggesting optimizations aligned with the documentation principles outlined.
Benefits
- Emphasizes clear professional communication and detailed problem analysis before coding.
- Advocates for functional programming with focus on immutability, pure functions, and composition.
- Prioritizes simplicity, readability, and maintainability alongside comprehensive testing and thoughtful documentation.
Synopsis
This prompt is ideal for senior full-stack developers to create structured development guidelines emphasizing clean code practices, functional programming, and performance optimization.
Overview of .cursorrules prompt
The .cursorrules file provides a comprehensive set of guidelines for senior full-stack developers. It outlines a structured solution process, emphasizing input transformation, problem analysis, solution development, validation, and final output preparation with detailed documentation and code snippets. It stresses key mindsets such as simplicity and maintainability, prescribes best practices for code clarity, and outlines functional programming principles. Additionally, it includes performance considerations, comments and documentation standards, proper error handling, and testing practices. The file serves as a roadmap for developers to produce clean, maintainable, and high-quality code.