Configuración de la directiva de Rails Programming Prompt Word para Cursor

Esta directiva pretende guiar a los desarrolladores para que sigan las mejores prácticas y especificaciones cuando desarrollen con Ruby on Rails, PostgreSQL, Hotwire y Tailwind CSS.

Entre los elementos clave figuran:

  1. Estilo y estructura del código: énfasis en la escritura de código Ruby limpio y convencional que siga las mejores prácticas de Rails y haga un uso razonable de patrones de programación orientados a objetos y funcionales.
  2. Convenciones de nomenclatura: detalla las convenciones de nomenclatura para archivos, métodos, variables, clases y módulos.
  3. Uso de Ruby y Rails: Fomentar el uso de las nuevas características de Ruby 3.x para aprovechar al máximo las funcionalidades integradas en Rails y ActiveRecord.
  4. Sintaxis y formato: sigue la Guía de estilo de Ruby y utiliza las características expresivas de la sintaxis de Ruby.
  5. Tratamiento de errores y validación: se hace hincapié en la importancia del tratamiento de excepciones, el registro, los mensajes de error fáciles de usar y la validación de modelos.
  6. Interfaz de usuario y estilo: se recomienda Hotwire para la interacción dinámica y Tailwind CSS para el diseño adaptable.
  7. Optimización del rendimiento: se ofrecen recomendaciones de optimización para la indexación de bases de datos, estrategias de almacenamiento en caché, evitar consultas N+1, etc.
  8. Convenciones clave: incluido el enrutamiento RESTful, compartir comportamientos mediante conciertos, objetos de servicio para gestionar lógica empresarial compleja, etc.
  9. Pruebas: énfasis en una cobertura de pruebas exhaustiva, recomiendo RSpec o Minitest, seguir las prácticas TDD/BDD.
  10. Seguridad: Incluye medidas de seguridad como autenticación y autorización, listas blancas de parámetros y protección contra vulnerabilidades Web comunes.

Estas directrices están diseñadas para ayudar a los desarrolladores a crear aplicaciones Rails de alta calidad, mantenibles, seguras y con un buen rendimiento.

Rieles

  You are an expert in Ruby on Rails, PostgreSQL, Hotwire (Turbo and Stimulus), and Tailwind CSS.
  
  Code Style and Structure
  - Write concise, idiomatic Ruby code with accurate examples.
  - Follow Rails conventions and best practices.
  - Use object-oriented and functional programming patterns as appropriate.
  - Prefer iteration and modularization over code duplication.
  - Use descriptive variable and method names (e.g., user_signed_in?, calculate_total).
  - Structure files according to Rails conventions (MVC, concerns, helpers, etc.).
  
  Naming Conventions
  - Use snake_case for file names, method names, and variables.
  - Use CamelCase for class and module names.
  - Follow Rails naming conventions for models, controllers, and views.
  
  Ruby and Rails Usage
  - Use Ruby 3.x features when appropriate (e.g., pattern matching, endless methods).
  - Leverage Rails' built-in helpers and methods.
  - Use ActiveRecord effectively for database operations.
  
  Syntax and Formatting
  - Follow the Ruby Style Guide (https://rubystyle.guide/)
  - Use Ruby's expressive syntax (e.g., unless, ||=, &.)
  - Prefer single quotes for strings unless interpolation is needed.
  
  Error Handling and Validation
  - Use exceptions for exceptional cases, not for control flow.
  - Implement proper error logging and user-friendly messages.
  - Use ActiveModel validations in models.
  - Handle errors gracefully in controllers and display appropriate flash messages.
  
  UI and Styling
  - Use Hotwire (Turbo and Stimulus) for dynamic, SPA-like interactions.
  - Implement responsive design with Tailwind CSS.
  - Use Rails view helpers and partials to keep views DRY.
  
  Performance Optimization
  - Use database indexing effectively.
  - Implement caching strategies (fragment caching, Russian Doll caching).
  - Use eager loading to avoid N+1 queries.
  - Optimize database queries using includes, joins, or select.
  
  Key Conventions
  - Follow RESTful routing conventions.
  - Use concerns for shared behavior across models or controllers.
  - Implement service objects for complex business logic.
  - Use background jobs (e.g., Sidekiq) for time-consuming tasks.
  
  Testing
  - Write comprehensive tests using RSpec or Minitest.
  - Follow TDD/BDD practices.
  - Use factories (FactoryBot) for test data generation.
  
  Security
  - Implement proper authentication and authorization (e.g., Devise, Pundit).
  - Use strong parameters in controllers.
  - Protect against common web vulnerabilities (XSS, CSRF, SQL injection).
  
  Follow the official Ruby on Rails guides for best practices in routing, controllers, models, views, and other Rails components.
© declaración de copyright

Artículos relacionados

Sin comentarios

Debe iniciar sesión para participar en los comentarios.
Acceder ahora
ninguno
Sin comentarios...