VShell 工具的 Git Rebase 與程式碼重構

本週，我有機會深入研究如何使用 git rebase，同時重構我的 VShell 工具的程式碼庫。我的主要任務是改進程式碼的結構和可維護性，同時遵守 DRY（不要重複自己）原則，這對於使程式碼更具可讀性、可維護性和更易於調試至關重要。此外，我遵循了重構目錄中概述的各種重構模式，例如提取函數、提取類別和重命名變數。

在深入探討我的重構工作的細節之前，我將為仍在熟悉這個強大的 Git 功能的開發人員提供 git rebase 流程的概述。

Git 變基概述

基本指令:

• git rebase ：此指令將目前分支的提交移至指定分支的頂部，從而有效地重新確定目前分支的基礎。

• git rebase ; ：此指令將主題分支重新設定為基礎分支，而無需先檢出主題分支。
  範例：通常，您會檢查主題分支並執行 git rebase，但此指令允許在保留基礎分支的同時進行變基。

衝突處理：

• git rebase --abort：取消 rebase 並將分支恢復到先前的狀態。
• git add ：解決合併衝突後將已解決的衝突新增至暫存區。
• git rebase --continue：衝突解決後繼續 rebase 程序。

互動式變基:

• 使用 git rebase -i ;用於將多個提交壓縮為一個。
• 成功變基後，可以刪除主題分支，因為所有變更都已整合。使用 gitbranch -d ;刪除分支。

重要提示：：

• 避免主分支變基，因為它會影響其他協作者。
• 僅在您的主題分支上重新建立基礎，以便在推送之前清理您的工作。

→ 在推動清理工作之前重新調整本地變更的基礎，但切勿重新調整已推送到某處的任何內容。

重構過程

1. 建立重構分支
   為了防止破壞當前工作程式碼，我基於主分支創建了一個單獨的重構分支。這使我能夠安全地嘗試更改。

2. 分析與重構程式碼
   儘管我最初將模組化模式應用於 VShell 程式碼，但仍需要進一步改進以拆分更大的模組並創建更具可讀性的程式碼流。

   • 原始碼/伺服器：
     • 我將重複的日誌記錄邏輯重構為handleDebugMessage() 函數，允許透過stderr 流進行集中日誌記錄。
     • 我還在 ConfigHandler.js 中建立了一個新的 ConfigHandler 類別來處理配置 .toml 檔案處理。 getTomlFiles() 和 loadConfig() 方法被封裝到此類中，用於設定的模組化處理。

• ai_config/grogConfig.js：

  • 從 chatCompletion AI 回傳回應的兩種方法在令牌使用檢索中存在重複。我將此邏輯提取到 getTokenUsage() 函數中，允許 readStream() 和 PromptGroq() 重複使用它。
  • 此外，我修復了 PromptGroq() 中的拼字錯誤，並重新命名了溫度變數以便更清晰。

• src/ai.js:

  • 我將handleOutput() 函數移至模組handleOutputFile() 中以允許將來重複使用。

• src/getFileContent.js:

  • 此處需要進行最小的更改；我只是重命名了檔案路徑和變數名稱，以提高可讀性和清晰度。

重構後的 Git Rebase

在重構過程中進行了 11 次提交後，有必要對它們進行整合。為了保持提交歷史記錄乾淨，我使用以下命令執行了互動式變基：

git rebase main -i

VSCode，配置為我的 Git 編輯器，提示我壓縮提交。壓縮後，我進行了一次包含所有相關變更的提交。然後我使用 git commit --amend 更新提交訊息，而不是在合併到主分支之前建立新的提交。

Conclusion

This week's experience with git rebase has provided me with valuable insights. Rebase is an essential tool for maintaining a clean, linear commit history, free from unnecessary merges. By mastering git rebase, I am now able to organize commit messages efficiently, minimizing confusion and ensuring a streamlined development workflow.

The refactoring effort has improved the structure and maintainability of the VShell codebase. Applying key design patterns like extracting functions and classes, I have made the codebase more modular, reusable, and easier to work with moving forward.

以上是VShell 工具的 Git Rebase 與程式碼重構的詳細內容。更多資訊請關注PHP中文網其他相關文章！