IDE-Tools · Foto: Homedust, CC BY 2.0
clean.mdc
Zuletzt aktualisiert:
Typ
Rule
Lizenz
MIT
Anwendungsfeld
Windsurf Rules & Cross-IDE-Rules
Aufräum-Sessions
Voraussetzungen
- Projekt mit bereits konfigurierten Formattern/Linters (z. B. black, isort, eslint)
- KI-Editor/Agent mit Unterstützung für Custom-Regeln
Einordnung
Die Ausführung selbst ist simpel, setzt aber bereits konfigurierte Formatter und Linter voraus.
Behebt alle Formatierungs-/Linting-Probleme im ganzen Projekt (black, isort, eslint …)
Für wen: Aufräum-Sessions
Im Detail
Anders als clean-code.mdc, bei dem es um Programmierprinzipien geht, ist clean.mdc ein Ausführungs-Kommando: Es startet die im Projekt vorhandenen Formatter und Linter — etwa black und isort bei Python oder eslint bei JavaScript/TypeScript — über die gesamte Codebasis und behebt automatisch behebbare Verstöße. Der Nutzen ist ein einheitlicher, sauberer Stand nach größeren Merges oder vor einem Release, ohne jede Datei einzeln zu prüfen. Sinnvoll für periodische Aufräum-Sessions oder nach dem Import von Fremdcode. Voraussetzung: Die Tools müssen im Projekt bereits konfiguriert sein, sonst läuft die Regel ins Leere.
Schritt für Schritt
- Regel nach größeren Merges oder vor einem Release aufrufen
- Agenten die vorhandenen Formatter und Linter projektweit ausführen lassen
- automatisch behebbare Verstöße vom Agenten korrigieren lassen
- den entstandenen Diff vor dem Commit durchsehen
- bei Bedarf regelmäßig für periodische Aufräum-Sessions wiederholen
Beispiel aus der Praxis
Nach dem Zusammenführen mehrerer Feature-Branches in einem Python-Projekt lässt man clean.mdc laufen; black und isort vereinheitlichen Formatierung und Importreihenfolge über die gesamte Codebasis, sodass der Stand vor dem Release sauber ist.
Praxis-Tipp
Setzen Sie die Regel nach größeren Merges ein, z. B. “Räume das ganze Projekt mit clean.mdc auf”, statt Formatierung manuell nachzuziehen.
Stolperfallen
Ohne bereits konfigurierte Formatter oder Linter läuft die Regel ins Leere. Projektweite automatische Fixes können zudem große Diffs erzeugen, die man vor dem Commit prüfen sollte, um unbeabsichtigte Änderungen zu vermeiden.
Siehe auch
Lizenz & Quelle
- Lizenz: MIT
- Quelle: github.com/steipete/agent-rules
Häufige Fragen.
Wie unterscheidet sich clean.mdc von clean-code.mdc?
clean-code.mdc betrifft Programmierprinzipien, clean.mdc ist dagegen ein Ausführungskommando, das vorhandene Formatter und Linter startet.
Braucht man dafür zusätzliche Werkzeuge?
Nein, sie nutzt nur bereits im Projekt konfigurierte Tools wie black, isort oder eslint.
Wann setzt man die Regel am besten ein?
Für periodische Aufräum-Sessions oder nach dem Import von Fremdcode, laut Beschreibung.
Inhalt ansehen (clean.mdc)
Lade …
Erfahrungen & Kommentare.
Funktioniert der Rule bei Ihnen? Tipps, Stolperfallen, Varianten — teilen Sie es mit der Community.
Lade Kommentare …
Passt dazu.
v5.md
Basis-Regelwerk: Task-Klassifizierung (leicht/standard/kritisch), Tool-Nutzung, Antwortstil
prompt-injection-guard.md
Schutz vor Prompt-Injection aus externem Kontext (Web/RAG/Dateien): Stopp + Rückfrage bei gefährlichen Aktionen
commit-message-format.md
Commit-Messages nach Conventional Commits (Prefix + Summary + Bullet-Body)
