clean-code.mdc

Sprachunabhängige Clean-Code-Regeln (Konstanten statt Magic Numbers, Lesbarkeit)

Für wen: Jedes Projekt, jede Sprache

Im Detail

Diese Cursor-Rule aus der awesome-cursorrules-Sammlung von PatrickJS bündelt grundlegende Clean-Code-Prinzipien, die nicht an eine bestimmte Sprache oder ein Framework gebunden sind: benannte Konstanten statt Magic Numbers, aussagekräftige Namen, kleine Funktionen, konsistente Formatierung. Anders als die vielen framework-spezifischen Rules im Verzeichnis (Next.js, FastAPI, Django) wirkt sie als Basis-Layer, der in jedem Projekt zusätzlich aktiviert werden kann – egal ob Python, TypeScript oder Go. Sie lohnt sich vor allem für Teams, die ihrem Editor allgemeine Qualitätsstandards mitgeben wollen, ohne für jede Sprache eigene Regeln zu schreiben. Für spezifische Stacks sollte sie mit den passenden sprachspezifischen Rules kombiniert werden.

Voraussetzungen

• Cursor-Editor

Schritt für Schritt

1. Rule ins Cursor-Projekt einbinden und optional mit sprachspezifischen Rules wie für Next.js, FastAPI oder Django kombinieren
2. Prüfen, ob die Grundprinzipien — benannte Konstanten, aussagekräftige Namen, kleine Funktionen — zum eigenen Codestil passen, und bei Bedarf anpassen
3. An einer bestehenden Codestelle mit Magic Numbers oder unklaren Namen testen, ob Cursor die Regel bei Vorschlägen anwendet
4. Bei mehreren Sprachen im selben Projekt prüfen, ob die Basis-Regel überall greift oder mit sprachspezifischen Rules kollidiert

Beispiel aus der Praxis

In einem TypeScript-Projekt mit zusätzlichen Next.js-Rules sorgt die Basis-Regel dafür, dass Cursor bei einem Vorschlag für eine neue Funktion automatisch eine benannte Konstante statt einer Magic Number wie 86400 verwendet.

Praxis-Tipp

Kombiniere sie mit einer sprachspezifischen Rule wie typescript.mdc oder python.mdc, damit Cursor sowohl allgemeine als auch stackspezifische Konventionen durchsetzt.

Stolperfallen

Die Rule als alleinige Qualitätssicherung betrachten, obwohl sie nur allgemeine Prinzipien abdeckt — für Framework-Spezifika zusätzliche Rules kombinieren. Bei Sprachen mit eigenen etablierten Konventionen kann die generische Regel mit deren Idiomen kollidieren.

Siehe auch

• typescript.mdc
• python.mdc
• react.mdc

Lizenz & Quelle

• Lizenz: CC0-1.0
• Quelle: github.com/PatrickJS/awesome-cursorrules

Lade …