Configuration de la directive Word de l'invite de programmation Ruby pour le curseur

Cette directive a pour but de guider les développeurs dans le respect des meilleures pratiques lorsqu'ils développent avec Ruby on Rails, PostgreSQL, Hotwire et Tailwind CSS. Elle couvre les domaines suivants :

  1. Style et structure du code : l'accent est mis sur l'écriture d'un code Ruby propre et idiomatique qui suit les conventions Rails, utilise des modèles de programmation appropriés, évite la duplication du code, utilise un nommage descriptif et organise la structure des fichiers conformément aux conventions Rails.
  2. Convention de nommage : spécifie comment les fichiers, méthodes, variables, classes et modules doivent être nommés, en suivant la convention de nommage de Rails.
  3. Utilisation de Ruby et de Rails : encourager l'utilisation des nouvelles fonctionnalités de Ruby 3.x pour tirer pleinement parti des méthodes d'aide intégrées de Rails et de la fonctionnalité ActiveRecord.
  4. Syntaxe et formatage : suivez le Ruby Style Guide et utilisez les fonctions syntaxiques expressives de Ruby.
  5. Gestion des erreurs et validation : conseils sur la manière d'utiliser correctement les exceptions, de mettre en œuvre la journalisation des erreurs, d'utiliser la validation ActiveModel et de gérer les erreurs de manière élégante dans le contrôleur.
  6. Interface utilisateur et style : Nous recommandons d'utiliser Hotwire pour les interactions dynamiques, Tailwind CSS pour le design responsive, et les aides de vue Rails et les vues partielles pour garder votre code ordonné.
  7. Optimisation des performances : il est recommandé d'utiliser judicieusement les index de la base de données, de mettre en œuvre des stratégies de mise en cache, d'éviter le problème des requêtes N+1 et d'optimiser les requêtes de la base de données.
  8. Conventions clés : L'accent est mis sur le respect des conventions de routage RESTful, l'utilisation de concerts pour partager des comportements, la mise en œuvre d'objets de service pour gérer la logique commerciale complexe et l'utilisation de tâches d'arrière-plan pour gérer les opérations fastidieuses.
  9. Tests : il est recommandé d'écrire des tests complets, de suivre les pratiques TDD/BDD et d'utiliser le modèle d'usine pour générer des données de test.
  10. Sécurité : conseils sur la manière de mettre en œuvre une authentification et une autorisation appropriées, d'utiliser des paramètres solides et de se prémunir contre les vulnérabilités courantes en matière de sécurité sur le web.

Cette directive couvre tous les aspects du développement Ruby on Rails et est conçue pour aider les développeurs à écrire un code de haute qualité, sécurisé et efficace.

Rubis

  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.
© déclaration de droits d'auteur

Articles connexes

Pas de commentaires

Vous devez être connecté pour participer aux commentaires !
S'inscrire maintenant
aucun
Pas de commentaires...