Den vollständigen Index der Dokumentation findest du in llms.txt. Die Markdown-Version einer Dokumentationsseite erhältst du, indem du .md an die URL der Seite anhängst.
Hauptnavigation
Design
Codex

Anwendungsfall für Codex

Deine Codebasis refaktorieren

Entferne toten Code und modernisiere veraltete Codemuster, ohne das Verhalten der Software zu ändern.

Schwierigkeitsgrad Advanced
Zeithorizont 1h

Entferne mit Codex toten Code, gliedere große Dateien übersichtlicher, führe doppelte Logik zusammen und modernisiere veraltete Codemuster. Gehe dabei in kleinen Schritten vor, die sich einzeln prüfen lassen.

Besonders geeignet für

  • Codebasen, in denen toter Code, zu große Module, doppelte Logik oder veraltete Abstraktionen selbst Routineänderungen aufwendig machen.
  • Teams, die bestehenden Code modernisieren müssen, ohne dabei auf ein anderes Framework oder einen anderen Technologie-Stack umzusteigen.

Inhalt

    ← Alle Anwendungsfälle

    Deine Codebasis refaktorieren

    Entferne toten Code und modernisiere veraltete Codemuster, ohne das Verhalten der Software zu ändern.

    Entferne mit Codex toten Code, gliedere große Dateien übersichtlicher, führe doppelte Logik zusammen und modernisiere veraltete Codemuster. Gehe dabei in kleinen Schritten vor, die sich einzeln prüfen lassen.

    Advanced
    1h

    Entferne mit Codex toten Code, gliedere große Dateien übersichtlicher, führe doppelte Logik zusammen und modernisiere veraltete Codemuster. Gehe dabei in kleinen Schritten vor, die sich einzeln prüfen lassen.

    Advanced
    1h

    Besonders geeignet für

    • Codebasen, in denen toter Code, zu große Module, doppelte Logik oder veraltete Abstraktionen selbst Routineänderungen aufwendig machen.
    • Teams, die bestehenden Code modernisieren müssen, ohne dabei auf ein anderes Framework oder einen anderen Technologie-Stack umzusteigen.

    Skills und Plug-ins

    • Prüfe sicherheitskritische Codebereinigungen, Änderungen an Abhängigkeiten, Authentifizierungsabläufe und von außen zugängliche Schnittstellen, bevor du die Änderungen eines Modernisierungsschritts zusammenführst.
    • Erstelle für dein Repository oder dein Team einen wiederverwendbaren Skill aus einem bewährten Modernisierungsmuster, einer Review-Checkliste oder einem Verfahren, mit dem du das Verhalten vor und nach dem Refactoring vergleichst.
    Skill Nutzen
    Security Best Practices Prüfe sicherheitskritische Codebereinigungen, Änderungen an Abhängigkeiten, Authentifizierungsabläufe und von außen zugängliche Schnittstellen, bevor du die Änderungen eines Modernisierungsschritts zusammenführst.
    Skill Creator Erstelle für dein Repository oder dein Team einen wiederverwendbaren Skill aus einem bewährten Modernisierungsmuster, einer Review-Checkliste oder einem Verfahren, mit dem du das Verhalten vor und nach dem Refactoring vergleichst.

    Prompt für den Einstieg

    Modernize and refactor this codebase. Requirements: - Preserve behavior unless I explicitly ask for a functional change. - Start by identifying dead code, duplicated paths, oversized modules, stale abstractions, and legacy patterns that are slowing changes down. - For each proposed pass, name the current behavior, the structural improvement, and the validation check that should prove behavior stayed stable. - Break the work into small reviewable refactor passes such as deleting dead code, simplifying control flow, extracting helpers, or replacing outdated patterns with the repo's current conventions. - Keep public APIs stable unless a change is required by the refactor. - Call out any framework migration, dependency upgrade, API change, or architecture move that should be split into a separate migration task. - If the work is broad, propose the docs, specs, and parity checks we should create before implementation. Propose a plan to do this.
    Modernize and refactor this codebase. Requirements: - Preserve behavior unless I explicitly ask for a functional change. - Start by identifying dead code, duplicated paths, oversized modules, stale abstractions, and legacy patterns that are slowing changes down. - For each proposed pass, name the current behavior, the structural improvement, and the validation check that should prove behavior stayed stable. - Break the work into small reviewable refactor passes such as deleting dead code, simplifying control flow, extracting helpers, or replacing outdated patterns with the repo's current conventions. - Keep public APIs stable unless a change is required by the refactor. - Call out any framework migration, dependency upgrade, API change, or architecture move that should be split into a separate migration task. - If the work is broad, propose the docs, specs, and parity checks we should create before implementation. Propose a plan to do this.

    Einführung

    Wenn ungenutzter Code, doppelte Logik, veraltete Abstraktionen, große Dateien oder überholte Muster jede Änderung an deiner Codebasis unnötig aufwendig machen, lohnt es sich, über ein Refactoring nachzudenken. Damit kannst du technische Schulden abbauen und die Struktur des bestehenden Systems verbessern, ohne den Technologie-Stack zu wechseln.

    Codex kann sich zunächst einen Überblick über den unübersichtlichen Bereich verschaffen und ihn dann in kleinen Schritten aufräumen, die du einzeln prüfen kannst. Dabei kann Codex ungenutzte Codepfade entfernen, große Module entflechten, doppelte Codepfade zusammenführen, veraltete Framework-Muster modernisieren und jeden Schritt gezielt absichern.

    So verbesserst du die bestehende Codebasis direkt:

    1. Entferne ungenutzten Code, veraltete Hilfsfunktionen, alte Flags und Kompatibilitätsschichten, die du nicht mehr brauchst.
    2. Verschlanke unübersichtliche Module, indem du Hilfsfunktionen auslagerst, Komponenten aufteilst oder Seiteneffekte an klar definierten Schnittstellen bündelst.
    3. Ersetze veraltete Muster durch Lösungen, die den aktuellen Konventionen im Repository entsprechen. Nutze etwa neuere Grundbausteine des Frameworks, klarere Typen, eine einfachere Zustandsverwaltung oder Funktionen der Standardbibliothek.
    4. Behalte das nach außen sichtbare Verhalten bei und verringere den Aufwand für die nächste Änderung.

    So gehst du vor

    1. Bitte Codex, den Bereich vor der ersten Änderung zu analysieren. Lass dir unübersichtliche Module, doppelte Logik, ungenutzten Code, Tests und die Zusagen öffentlicher Schnittstellen zeigen. Dazu gehören auch Muster, die im Repository inzwischen überholt sind.
    2. Nimm dir pro Durchgang ein Thema vor. Entferne zum Beispiel ungenutzten Code, vereinfache den Kontrollfluss, modernisiere ein veraltetes Muster oder zerlege eine große Datei in kleinere Teile mit klaren Zuständigkeiten.
    3. Bevor Codex Dateien ändert, lass dir das aktuelle Verhalten und die geplante strukturelle Verbesserung beschreiben. Lass Codex außerdem angeben, mit welcher möglichst kleinen Prüfung sich nachweisen lässt, dass das Verhalten gleich geblieben ist.
    4. Sieh dir nach jedem Durchgang die Änderungen an und führe die kleinste aussagekräftige Prüfung aus, statt alle Änderungen in einem einzigen Diff zu sammeln.
    5. Behandle Änderungen am Technologie-Stack, die Migration von Abhängigkeiten und Architekturänderungen als separate Aufgaben, sofern sie für den Abschluss der Bereinigung nicht erforderlich sind.

    Im Planungs-Modus kannst du vor Beginn der Arbeit einen Plan für das Refactoring erstellen.

    ExecPlans nutzen

    Das Cookbook zur Code-Modernisierung stellt ExecPlans vor. In diesen Dokumenten kann Codex den Überblick über die Bereinigung behalten, den angestrebten Zustand genau beschreiben und nach jedem Durchgang die Prüfergebnisse festhalten. ExecPlans sind hilfreich, wenn du mehrere Module überarbeitest oder mehr als eine Sitzung brauchst. Halte darin fest, was du entfernt hast, welche Muster du aktualisiert hast, welche Schnittstellenzusagen du einhalten musstest und welche Arbeiten noch zurückgestellt sind.

    Skills für wiederkehrende Aufgaben nutzen

    Skills sind hilfreich, wenn für mehrere Repositorys, Dienste oder Teams dieselben Regeln zur Codebereinigung gelten. Nutze passende Skills für dein Framework, sofern sie verfügbar sind. Ziehe bei riskanten Änderungen zusätzlich Skills für Sicherheit und CI heran. Wenn dein Team eine bewährte Checkliste hat, um ungenutzten Code zu entfernen, Module auszulagern oder veraltete Muster zu modernisieren, erstelle daraus einen Skill für das Team. Wenn du dieselbe Modernisierung in mehreren Codebasen vornimmst, kann Codex dir helfen, aus dem ersten erfolgreichen Durchgang einen wiederverwendbaren Skill zu erstellen.

    Verwandte Anwendungsfälle