Code verbessern & refaktorieren

Verdent for VS Code hilft Ihnen, Code sicher über mehrere Dateien hinweg zu refaktorieren und zu verbessern, ohne die Funktionalität zu beeinträchtigen. Mit Plan Mode und dem Explorer-Subagenten können Sie alle betroffenen Dateien identifizieren, bevor Sie Änderungen vornehmen, sodass ein umfassendes Refactoring gewährleistet ist, ohne dass Instanzen übersehen werden.

Was Sie lernen werden

• Effektive Refactorings anfordern, die sich auf Ergebnisse statt auf die Implementierung konzentrieren
• Sicher über mehrere Dateien hinweg refaktorieren – mit Abhängigkeitsverwaltung
• Verbesserungen der Codequalität und Optimierungsvorschläge anfordern
• Groß angelegte Refactoring-Projekte mit mehrphasigen Ansätzen bewältigen
• Die Performance durch algorithmische und architektonische Verbesserungen optimieren
• Die Funktionalität des Codes während Refactoring-Vorgängen erhalten

Voraussetzungen

Bevor Sie mit Verdent refaktorieren:

• Visual Studio Code mit installierter Verdent-Erweiterung
• Eine Codebasis oder ein Projekt-Arbeitsbereich, der in VS Code geöffnet ist
• Ein aktives Verdent-Abonnement mit verfügbaren Credits
• Versionskontrolle (Git) wird empfohlen, um bei Bedarf sicher zurücksetzen zu können

Effektive Refactorings anfordern

Beschreiben Sie was Sie verbessern möchten und warum, statt wie es behoben werden soll. Lassen Sie Verdent den Code analysieren und den besten Ansatz basierend auf den Mustern Ihres Projekts vorschlagen.

Effektive Refactoring-Anfragen:

Konzentrieren Sie sich auf das gewünschte Ergebnis, nicht auf die Implementierung:

Refactor the UserController to improve readability and reduce duplication

This authentication logic is scattered across multiple files. Consolidate it into a single module

Improve error handling in the API layer to be more consistent and informative

Verdent analysiert den Code, identifiziert alle betroffenen Dateien, untersucht Muster und schlägt konkrete Refactoring-Strategien vor, die den Konventionen Ihrer Codebasis entsprechen.

Best Practice: Verwenden Sie Plan Mode

Starten Sie Refactoring-Anfragen im Plan Mode. Verdent wird:

1. Den Code analysieren und alle betroffenen Dateien identifizieren
2. Einen detaillierten Refactoring-Plan vorlegen, bevor Änderungen vorgenommen werden
3. Klärende Fragen zu Implementierungspräferenzen stellen
4. Genau zeigen, was sich ändert und in welcher Reihenfolge
5. Ihnen ermöglichen, den Ansatz zu prüfen und zu verfeinern

Beispiel mit Plan Mode:

In Plan Mode: Refactor authentication logic to use a centralized authentication utility

Verdent wird:

• Explorer verwenden, um alle Code-Stellen zur Authentifizierung zu finden
• Muster und Inkonsistenzen identifizieren
• Eine einheitliche Authentifizierungsschnittstelle vorschlagen
• Zeigen, welche Dateien geändert werden
• Die Reihenfolge des Refactorings erläutern

Sie können Verdent bitten, den Plan vor der Ausführung in einer plan.md-Datei zu speichern, um ihn zusätzlich zu prüfen und im Team zu besprechen.

Explorer für umfassende Suchen verwenden:

Bitten Sie Verdent bei komplexen Refactorings explizit, den Explorer-Agenten für eine gründliche Suche zu verwenden:

Use the Explorer agent to find all places where we manually validate email addresses, then refactor them to use a centralized validation utility

So stellen Sie sicher, dass Verdent jede Stelle findet, die aktualisiert werden muss, und verhindern ein inkonsistentes Refactoring in der gesamten Codebasis.

Refactoring über mehrere Dateien

Verdent refaktoriert über mehrere Dateien hinweg und behält dabei Imports, Abhängigkeiten und dateiübergreifende Referenzen bei. Es identifiziert alle betroffenen Dateien, aktualisiert sie in der richtigen Reihenfolge und sorgt für Konsistenz in der gesamten Codebasis.

So funktioniert das Refactoring über mehrere Dateien:

1. Erkennungsphase: Verdent (mit Explorer) findet alle Dateien, die geändert werden müssen
2. Abhängigkeitsanalyse: Identifiziert Abhängigkeiten zwischen Dateien, um die Aktualisierungsreihenfolge festzulegen
3. Planerstellung: Zeigt alle zu ändernden Dateien und die Reihenfolge der Änderungen
4. Sequenzielle Aktualisierungen: Ändert Dateien in Abhängigkeitsreihenfolge (z. B. Typen vor Komponenten, die sie verwenden)
5. Import-Verwaltung: Aktualisiert automatisch Imports, Exports und dateiübergreifende Referenzen
6. Verifizierung: Prüft, ob die Änderungen in allen Dateien konsistent sind

Beispiel:

Rename the User interface to UserProfile across the entire project

Verdent wird:

• Alle Dateien finden, die User importieren oder verwenden
• Typdefinitionen, Implementierungen und Verwendungen identifizieren
• Zuerst die Typdefinitionen aktualisieren, dann die Implementierungen, dann die Verwendungen
• Alle Import-Anweisungen anpassen
• Konsistenz in der gesamten Codebasis sicherstellen

Verwenden Sie Plan Mode, um den Umfang zu prüfen:

Prüfen Sie vor der Ausführung eines Refactorings über mehrere Dateien den vollständigen Umfang in Plan Mode:

In Plan Mode: Extract the authentication logic from UserController into a separate AuthService

Verdent zeigt:

• Welche Dateien erstellt werden (neuer AuthService)
• Welche Dateien geändert werden (UserController und alle, die ihn importieren)
• Welcher Code von UserController zu AuthService verschoben wird
• Wie Imports und Abhängigkeiten aktualisiert werden

Dies verhindert eine ungewollte Ausweitung des Umfangs und stellt sicher, dass Sie die vollständigen Auswirkungen verstehen, bevor Sie fortfahren.

Verbesserungen der Codequalität anfordern

Verdent schlägt Verbesserungen nicht proaktiv vor, ohne dass Sie danach fragen. Sie können jedoch jederzeit Code-Qualitätsprüfungen und Verbesserungsvorschläge anfordern.

Review this code for potential improvements

Suggest ways to improve code quality in the UserService module

Are there any performance optimizations we could make here?

Analyze the PaymentController for maintainability issues

@services/UserService.js Review this module for dependency injection improvements

@controllers/PaymentController.js Identify opportunities to reduce complexity

Groß angelegte Refactoring-Projekte

Verwenden Sie für groß angelegte Refactorings Plan Mode mit einem mehrphasigen Ansatz, um die zuverlässigsten Ergebnisse zu erzielen. Verdent unterteilt das Refactoring in überschaubare Etappen, sodass Sie jede Phase prüfen und genehmigen können, bevor Sie fortfahren.

Mehrphasiger Refactoring-Workflow:

Phase 1: Erste Analyse

Verwenden Sie Plan Mode mit dem Explorer-Agenten, um alle betroffenen Dateien und Abhängigkeiten zu identifizieren:

In Plan Mode: Use Explorer to analyze our codebase and create a plan to replace our custom authentication with OAuth 2.0

Verdent führt eine umfassende Analyse durch:

• Identifiziert den gesamten authentifizierungsbezogenen Code
• Kartiert Abhängigkeiten und Integrationspunkte
• Bewertet Komplexität und Risikobereiche
• Schlägt eine Phasengliederung vor

Phase 2: Phasenplanung

Verdent erstellt einen mehrphasigen Plan zur Prüfung:

Beispielplan:

• Phase 1: OAuth-Bibliothek hinzufügen und Endpunkte konfigurieren
• Phase 2: Benutzermodell und Datenbankschema aktualisieren
• Phase 3: Bestehende Authentifizierungslogik migrieren
• Phase 4: Veralteten Authentifizierungscode entfernen
• Phase 5: Tests und Dokumentation aktualisieren

Jede Phase umfasst:

• Zu ändernde Dateien
• Geschätzte Komplexität
• Abhängigkeiten von vorherigen Phasen
• Risikobewertung

Phase 3: Phasenweise Ausführung

Führen Sie jeweils eine Phase aus und testen Sie zwischen den Phasen:

1. Genehmigen Sie Phase 1 im Plan Mode
2. Wechseln Sie zum Agent Mode und führen Sie sie aus
3. Testen Sie gründlich, um sicherzustellen, dass Phase 1 funktioniert
4. Kehren Sie für Phase 2 zum Plan Mode zurück
5. Wiederholen Sie dies, bis alle Phasen abgeschlossen sind

Phase 4: Iterative Verfeinerung

Prüfen Sie die Ergebnisse nach jeder Phase. Wenn Probleme auftreten:

• Passen Sie den Plan für die verbleibenden Phasen an
• Fügen Sie bei Bedarf korrigierende Phasen hinzu
• Verfeinern Sie den Ansatz basierend auf den Erkenntnissen

Dieser phasenweise Ansatz gewährleistet Sicherheit und ermöglicht Kurskorrekturen, falls bei groß angelegten Refactoring-Projekten Probleme auftreten.

Performance-Optimierung

Verdent analysiert Code auf Performance-Engpässe und schlägt Optimierungen vor, darunter Verbesserungen der Algorithmuskomplexität, effiziente Datenstrukturen und eine reduzierte Ressourcennutzung.

Analyze the performance of this data processing function and suggest improvements

Can we improve the time complexity of this search algorithm?

Optimize the searchProducts function that's currently O(n²)

Optimize this component to reduce unnecessary re-renders

Identify performance bottlenecks in the API request handler

Funktionalität während des Refactorings erhalten

Verdent hat zum Ziel, die Funktionalität des Codes während des Refactorings zu erhalten, indem dieselben Eingaben, Ausgaben und dasselbe Verhalten beibehalten werden, während die interne Implementierung verbessert wird.

So erhält Verdent die Funktionalität:

• Ein-/Ausgabe-Analyse: Identifiziert Funktionssignaturen, API-Verträge und erwartetes Verhalten
• Test-Bewusstsein: Betrachtet bestehende Tests als Verhaltensspezifikationen
• Konservative Änderungen: Nimmt minimale Änderungen vor, um das Refactoring-Ziel zu erreichen
• Verifizierung: Kann Tests generieren oder ausführen, um zu überprüfen, dass die Funktionalität erhalten bleibt

Best Practices für sicheres Refactoring:

1. Refaktorierten Code immer testen – Auch mit der Analyse von Verdent bestätigt manuelles oder automatisiertes Testen, dass die Funktionalität erhalten bleibt, insbesondere bei komplexen Refactorings

2. Versionskontrolle verwenden – Committen Sie vor dem Refactoring, damit Sie bei auftretenden Problemen zurücksetzen können

3. Inkrementell refaktorieren – Teilen Sie große Refactorings in kleinere Schritte auf und testen Sie nach jeder Änderung

4. Änderungen sorgfältig prüfen – Untersuchen Sie den Diff, um zu verstehen, was sich geändert hat und warum

5. Für komplexe Refactorings Plan Mode verwenden – Prüfen Sie den Ansatz vor der Ausführung, um mögliche Probleme zu erkennen

Beispiel: Sichere Refactoring-Anfrage

Refactor the calculateOrderTotal function to use a more maintainable structure, but ensure it produces identical results for all input cases

Verdent wird:

• Die aktuelle Implementierung und Randfälle analysieren
• Eine refaktorierte Struktur vorschlagen
• Erläutern, warum die refaktorierte Version gleichwertig ist
• Testfälle vorschlagen, um die Gleichwertigkeit zu überprüfen

Wenn sich die Funktionalität ändern könnte:

In manchen Fällen ändert das Refactoring absichtlich das Verhalten (Fehlerbehebungen, verbesserte Validierung). Machen Sie dies explizit deutlich:

Refactor the email validation function to correctly handle international domains, which the current implementation doesn't support

Dies signalisiert, dass die Verhaltensänderung erwartet und beabsichtigt ist.

Best Practices

Siehe auch