VShell 工具的 Git Rebase 和代码重构

Diese Woche hatte ich die Gelegenheit, mich intensiver mit der Verwendung von Git Rebase zu befassen, während ich die Codebasis für mein VShell-Tool umgestaltete. Meine Hauptaufgabe bestand darin, die Struktur und Wartbarkeit des Codes zu verbessern und dabei das DRY-Prinzip (Don't Repeat Yourself) einzuhalten, das wesentlich ist, um Code lesbarer, wartbarer und einfacher zu debuggen. Darüber hinaus habe ich verschiedene im Refactoring-Katalog beschriebene Refactoring-Muster befolgt, z. B. das Extrahieren von Funktionen, das Extrahieren von Klassen und das Umbenennen von Variablen.

Bevor ich auf die Details meiner Refactoring-Bemühungen eingehe, werde ich Entwicklern, die sich noch mit dieser leistungsstarken Git-Funktion vertraut machen, einen Überblick über den Git-Rebase-Prozess geben.

Git-Rebase-Übersicht

Grundlegende Befehle:

• git rebase : Dieser Befehl verschiebt die Commits vom aktuellen Branch auf den angegebenen Branch, wodurch der aktuelle Branch effektiv neu basiert.

• git rebase : Dieser Befehl rebasiert den Themenzweig auf den Basiszweig, ohne dass der Themenzweig zuerst ausgecheckt werden muss.
  Beispiel: Normalerweise würden Sie den Themenzweig auschecken und git rebase ausführen, aber dieser Befehl ermöglicht ein Rebasing, während Sie im Basiszweig bleiben.

Konfliktbehandlung:

• git rebase --abort: Bricht das Rebase ab und stellt den Zweig in seinem vorherigen Zustand wieder her.
• git add : Fügt gelöste Konflikte dem Staging-Bereich hinzu, nachdem Zusammenführungskonflikte gelöst wurden.
• git rebase --continue: Setzt den Rebase-Prozess fort, nachdem Konflikte gelöst wurden.

Interaktive Rebase:

• Verwenden Sie git rebase -i zum Zusammenfassen mehrerer Commits in einem.
• Nach einem erfolgreichen Rebase können die Themenzweige gelöscht werden, da alle Änderungen integriert sind. Verwenden Sie git branch -d um den Zweig zu entfernen.

Wichtige Hinweise::

• Vermeiden Sie eine Neubasierung des Hauptzweigs, da dies Auswirkungen auf andere Mitarbeiter hat.
• Rebasieren Sie nur auf Ihrem Themenzweig, um Ihre Arbeit vor dem Pushen zu bereinigen.

→ Rebasieren Sie lokale Änderungen, bevor Sie Ihre Arbeit bereinigen, aber rebasieren Sie niemals etwas, das Sie irgendwohin verschoben haben.

Refactoring-Prozess

1. Erstellen eines Refactoring-Zweigs
   Um zu verhindern, dass der aktuelle Arbeitscode beschädigt wird, habe ich einen separaten Refactoring-Zweig basierend auf dem Hauptzweig erstellt. Dadurch konnte ich sicher mit Änderungen experimentieren.

2. Analyse und Refactoring des Codes
   Obwohl ich zunächst ein modulares Muster auf den VShell-Code angewendet habe, waren weitere Verbesserungen erforderlich, um größere Module aufzuteilen und einen besser lesbaren Codefluss zu schaffen.

   • Quelle/Server:
     • Ich habe die Logik für die wiederholte Protokollierung in eine handleDebugMessage()-Funktion umgestaltet, um eine zentralisierte Protokollierung über den stderr-Stream zu ermöglichen.
     • Ich habe außerdem eine neue ConfigHandler-Klasse in ConfigHandler.js erstellt, um die Verarbeitung der Konfigurations-.toml-Datei zu übernehmen. Die Methoden getTomlFiles() und loadConfig() wurden zur modularen Handhabung von Einstellungen in diese Klasse gekapselt.

• ai_config/grogConfig.js:

  • Bei zwei Möglichkeiten, Antworten von der ChatCompletion-KI zurückzugeben, kam es beim Abruf der Token-Nutzung zu Duplikaten. Ich habe diese Logik in eine getTokenUsage()-Funktion extrahiert, sodass sowohl readStream() als auch promptGroq() sie wiederverwenden können.
  • Zusätzlich habe ich den Tippfehler in promptGroq() behoben und die Temperaturvariable zur besseren Übersichtlichkeit umbenannt.

• src/ai.js:

  • Ich habe die Funktion handleOutput() in ein Modul handleOutputFile() verschoben, um eine zukünftige Wiederverwendbarkeit zu ermöglichen.

• src/getFileContent.js:

  • Hier waren minimale Änderungen erforderlich; Ich habe einfach Dateipfade und Variablennamen umbenannt, um die Lesbarkeit und Klarheit zu verbessern.

Git-Rebase nach dem Refactoring

Nachdem während des Refactoring-Prozesses 11 Commits vorgenommen wurden, wurde es notwendig, diese zu konsolidieren. Um den Commit-Verlauf sauber zu halten, habe ich ein interaktives Rebase durchgeführt mit:

git rebase main -i

VSCode, konfiguriert als mein Git-Editor, hat mich dazu aufgefordert, die Commits zu unterdrücken. Nach dem Squash hatte ich einen einzigen Commit mit allen relevanten Änderungen. Ich habe dann git commit --amend verwendet, um die Commit-Nachricht zu aktualisieren, anstatt vor dem Zusammenführen in den Hauptzweig einen neuen Commit zu erstellen.

结论

本周 git rebase 的经验为我提供了宝贵的见解。 Rebase 是维护干净、线性提交历史记录、避免不必要的合并的重要工具。通过掌握 git rebase，我现在能够有效地组织提交消息，最大限度地减少混乱并确保简化的开发工作流程。

重构工作改进了 VShell 代码库的结构和可维护性。通过应用提取函数和类等关键设计模式，我使代码库更加模块化、可重用，并且更易于后续工作。

以上是VShell 工具的 Git Rebase 和代码重构的详细内容。更多信息请关注PHP中文网其他相关文章！