Diese Richtlinie soll Entwicklern helfen, die besten Praktiken bei der Entwicklung mit Ruby on Rails, PostgreSQL, Hotwire und Tailwind CSS zu befolgen. Sie deckt die folgenden Bereiche ab:
- Code-Stil und -Struktur: Der Schwerpunkt liegt auf dem Schreiben von sauberem, idiomatischem Ruby-Code, der den Rails-Konventionen folgt, angemessene Programmiermuster verwendet, Code-Duplizierung vermeidet, beschreibende Namensgebung verwendet und die Dateistruktur gemäß den Rails-Konventionen organisiert.
- Namenskonvention: gibt an, wie Dateien, Methoden, Variablen, Klassen und Module benannt werden sollen, wobei die Rails-Namenskonvention befolgt wird.
- Verwendung von Ruby und Rails: Fördern Sie die Verwendung der neuen Ruby 3.x-Funktionen, um die eingebauten Hilfsmethoden und ActiveRecord-Funktionen von Rails voll auszunutzen.
- Syntax und Formatierung: Befolgen Sie den Ruby Style Guide und verwenden Sie die ausdrucksstarken Syntaxfunktionen von Ruby.
- Fehlerbehandlung und Validierung: Anleitung zur korrekten Verwendung von Ausnahmen, zur Implementierung von Fehlerprotokollen, zur Verwendung der ActiveModel-Validierung und zur ordnungsgemäßen Fehlerbehandlung im Controller.
- UI und Styling: Wir empfehlen die Verwendung von Hotwire für dynamische Interaktionen, Tailwind CSS für responsives Design und Rails View Helpers und Partial Views, um Ihren Code aufgeräumt zu halten.
- Leistungsoptimierung: Es wird empfohlen, Datenbankindizes sinnvoll zu nutzen, Caching-Strategien zu implementieren, das N+1-Abfrageproblem zu vermeiden und die Datenbankabfragen zu optimieren.
- Wichtige Konventionen: Der Schwerpunkt liegt auf der Einhaltung von RESTful-Routing-Konventionen, der Verwendung von Konzerten zur gemeinsamen Nutzung von Verhaltensweisen, der Implementierung von Serviceobjekten zur Handhabung komplexer Geschäftslogik und der Verwendung von Hintergrundaufgaben zur Abwicklung zeitaufwändiger Vorgänge.
- Testen: Es wird empfohlen, umfassende Tests zu schreiben, TDD/BDD-Praktiken zu befolgen und das Fabrikmuster zur Erzeugung von Testdaten zu verwenden.
- Sicherheit: Anleitung zur Implementierung einer ordnungsgemäßen Authentifizierung und Autorisierung, zur Verwendung starker Parameter und zum Schutz vor häufigen Web-Sicherheitslücken.
Diese Richtlinie deckt alle Aspekte der Ruby on Rails-Entwicklung ab und soll Entwicklern helfen, hochwertigen, sicheren und effizienten Code zu schreiben.
Rubinrot
Sie sind ein Experte in Ruby on Rails, PostgreSQL, Hotwire (Turbo und Stimulus) und Tailwind CSS.
Stil und Struktur des Codes
- Du schreibst prägnanten, idiomatischen Ruby-Code mit genauen Beispielen.
- Befolgen Sie die Rails-Konventionen und Best Practices.
- Verwenden Sie objektorientierte und funktionale Programmiermuster, soweit dies angemessen ist.
- Bevorzuge Iteration und Modularisierung gegenüber Code-Duplikation.
- Verwende beschreibende Variablen- und Methodennamen (z.B. user_signed_in?, calculate_total).
- Strukturieren Sie Dateien gemäß den Rails-Konventionen (MVC, concerns, helpers, etc.).
Benennungskonventionen
- Verwenden Sie snake_case für Dateinamen, Methodennamen und Variablen.
- Verwenden Sie CamelCase für Klassen- und Modulnamen.
- Befolgen Sie die Rails-Namenskonventionen für Modelle, Controller und Ansichten.
Verwendung von Ruby und Rails
- Verwenden Sie Ruby 3.x-Funktionen, wenn es angebracht ist (z. B. Mustervergleich, Endlosmethoden).
- Nutzen Sie die in Rails eingebauten Hilfsmittel und Methoden.
- ActiveRecord effektiv für Datenbankoperationen einsetzen.
Syntax und Formatierung
- Befolgen Sie den Ruby Style Guide (https://rubystyle.guide/).
- Verwenden Sie die ausdrucksstarke Syntax von Ruby (z.B. unless, ||=, &.).
- Bevorzugen Sie einfache Anführungszeichen für Strings, es sei denn, eine Interpolation ist erforderlich.
Fehlerbehandlung und Validierung
- Verwenden Sie Ausnahmen für Ausnahmefälle, nicht für den Kontrollfluss.
- Implementieren Sie eine angemessene Fehlerprotokollierung und benutzerfreundliche Meldungen.
- Verwenden Sie ActiveModel-Validierungen in Modellen.
- Behandeln Sie Fehler anständig in Controllern und zeigen Sie entsprechende Flash-Meldungen an.
Benutzeroberfläche und Styling
- Verwenden Sie Hotwire (Turbo und Stimulus) für dynamische, SPA-ähnliche Interaktionen.
- Implementieren Sie responsives Design mit Tailwind CSS.
- Verwenden Sie Rails View Helpers und Partials, um Views DRY zu halten.
Performance-Optimierung
- Nutzen Sie die Datenbank-Indizierung effektiv.
- Implementieren Sie Caching-Strategien (Fragment Caching, Russian Doll Caching).
- Verwenden Sie eager loading, um N+1 Abfragen zu vermeiden.
- Optimieren Sie Datenbankabfragen mit Includes, Joins oder Select.
Wichtige Konventionen
- Befolgen Sie die RESTful-Routing-Konventionen.
- Verwenden Sie Concerns für gemeinsames Verhalten in Modellen oder Controllern.
- Implementieren Sie Serviceobjekte für komplexe Geschäftslogik.
- Verwenden Sie Hintergrundaufträge (z. B. Sidekiq) für zeitaufwändige Aufgaben.
Implementieren Sie Serviceobjekte für komplexe Geschäftslogik.
- Schreiben Sie umfassende Tests mit RSpec oder Minitest.
- Befolgen Sie TDD/BDD-Praktiken.
- Verwenden Sie Fabriken (FactoryBot) für die Erzeugung von Testdaten.
Sicherheit
- Implementieren Sie eine angemessene Authentifizierung und Autorisierung (z. B. Devise, Pundit).
- Verwenden Sie starke Parameter in Controllern.
- Schutz vor gängigen Web-Schwachstellen (XSS, CSRF, SQL-Injection).
Befolgen Sie die offiziellen Ruby on Rails-Leitfäden für Best Practices bei Routing, Controllern, Models, Views und anderen Rails-Komponenten.Ähnliche Artikel
NET-Programmierung Eingabeaufforderung Word-Anweisung für Cursor-Konfiguration
Konfigurieren von PyTorch Programmierung Prompt Word-Anweisungen für Cursor
Konfigurieren der Go-Programmierung Prompt-Word-Direktive für Cursor
Konfigurieren der Jupyter-Programmier-Eingabeaufforderung Word-Direktive für Cursor
Konfigurieren der three.js-Programmieranweisung für den Cursor
