machichdigital

IDE-Tools · Foto: Homedust, CC BY 2.0

RuleCursor RulesLizenz: CC0-1.0frei kopierbar

clean-code.mdc

Zuletzt aktualisiert:

⬇ Als Datei laden

⧉ –× kopiert⬇ –× heruntergeladenBewertung:

Typ

Rule

Lizenz

CC0-1.0

Anwendungsfeld

Cursor Rules

Jedes Projekt, jede Sprache

Voraussetzungen

  • Cursor als Editor (für .mdc-Regeldateien)
  • Ein laufendes Projekt, unabhängig von der Programmiersprache

Einordnung

AufwandEinrichtung & Einarbeitung1/5 · geringNutzenErtrag im Alltag3/5 · mittelVoraussetzungenWas vorher da sein muss1/5 · gering1 = gering5 = hoch

Einfach einzubinden, ihr Nutzen hängt aber stark davon ab, ob schon ein eigener Styleguide existiert.

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

Für wen: Jedes Projekt, jede Sprache

Im Detail

clean-code.mdc sammelt sprachunabhängige Grundregeln für lesbaren Code: aussagekräftige Namen statt kryptischer Abkürzungen, benannte Konstanten statt Magic Numbers, kleine Funktionen mit einer Verantwortung und Vermeidung von Duplikaten. Der Mehrwert liegt darin, dass sie an kein Framework gebunden ist und sich daher in jedem Projekt als Basis-Regel einbinden lässt, egal ob TypeScript, Python oder Node im Einsatz ist. Für Teams mit bereits etabliertem Styleguide ist sie eher redundant; für neue Projekte oder gemischte Sprachstacks liefert sie eine solide Grundlage, auf der sprachspezifische Regeln aufbauen können.

Schritt für Schritt

  1. clean-code.mdc ins Regel-Verzeichnis von Cursor legen
  2. Prüfen, ob die Regel projektweit oder nur für bestimmte Dateitypen greifen soll
  3. Ein bestehendes Codebeispiel mit Magic Numbers oder unklaren Namen von Cursor überarbeiten lassen
  4. Vorschläge gegen die eigenen Konventionen prüfen und Ausnahmen ergänzen
  5. Bei bereits etabliertem Styleguide abgleichen, ob sich Regeln widersprechen

Beispiel aus der Praxis

Cursor schlägt bei einer Funktion mit der Zeile return x * 86400 vor, die Zahl 86400 durch eine benannte Konstante wie SECONDS_PER_DAY zu ersetzen und den Parameter aussagekräftiger zu benennen.

Praxis-Tipp

Kombinieren Sie sie als Basis-Regel mit einer sprachspezifischen Regel wie typescript.mdc oder python.mdc, statt sie allein einzusetzen.

Stolperfallen

Bei einem bereits vorhandenen Styleguide kann diese generische Regel zu widersprüchlichen Vorschlägen führen; vorher klären, welche Regel im Konfliktfall Vorrang hat.

Siehe auch

Lizenz & Quelle

Häufige Fragen.

Kostet die Nutzung etwas?

Nein, es handelt sich um eine reine Textregel für Cursor, es entstehen keine zusätzlichen Kosten.

Für welche Sprachen ist sie geeignet?

Laut Beschreibung ist sie sprachunabhängig und funktioniert etwa für TypeScript, Python oder Node.

Ersetzt sie einen Linter?

Nein, sie ist eine Empfehlung für die KI-Vorschläge, kein automatisiertes Prüfwerkzeug.

Inhalt ansehen (clean-code.mdc)
Lade …

Erfahrungen & Kommentare.

Funktioniert der Rule bei Ihnen? Tipps, Stolperfallen, Varianten — teilen Sie es mit der Community.

Lade Kommentare …

Ihre IP-Adresse wird zum Schutz vor Missbrauch gespeichert und nach 14 Tagen automatisch entfernt (Datenschutz).

Passt dazu.