👀 Proposal: Integrate SwiftGitX as an Alternative to the Current Git Implementation

Bắt đầu bằng cách đọc phần triển khai GitClient hiện có và cấu hình dependency của dự án để hiểu cách tích hợp shell-command hiện tại. Đề xuất không xác định các tệp hoặc test cụ thể; để được xem là hoàn thành, công việc cần có một phương án tích hợp SwiftGitX tăng dần đã được thống nhất, các thao tác ban đầu như xem trạng thái repository hoặc liệt kê branch, và coverage cho việc đánh giá.

I would like to propose integrating SwiftGitX into CodeEdit as an alternative to the current GitClient implementation that relies on executing Git shell commands.

Background

Currently, CodeEdit uses a GitClient class that wraps Git shell commands by spawning subprocesses, capturing output, and then parsing the results to build models. While this approach works, it has some limitations:

• Performance Overhead: Each Git operation requires spawning a new process, which can be slow compared to directly interacting with Git data structures.

• Error Handling: Parsing command-line output can be fragile and error-prone, as Git’s output format may change between versions.

• Dependency on Git Executable: The current approach requires the Git binary to be installed and available in the system’s PATH.

About SwiftGitX

SwiftGitX is a Swift-native wrapper around libgit2, providing a structured and efficient way to interact with Git repositories programmatically. Key advantages include:

• Direct Interaction with Git Repositories: No need for shell commands; everything is handled in Swift.

• Better Performance: By avoiding process spawning and output parsing, operations are faster and more efficient.

• No External Dependencies: SwiftGitX does not require an external Git installation; it can be added as a Swift package and works out of the box.

• Well-Tested: The library includes more than 100 unit tests and 90% test-coverage, ensuring reliability and stability.

Proposed Plan for Incremental Integration

To avoid a large and disruptive refactor, I propose an incremental approach:

1. Introduce SwiftGitX as an optional dependency – Add SwiftGitX to the project while keeping the existing GitClient implementation.

2. Implement Core Functionality – Start by replacing a small subset of Git operations (e.g., getting repository status, listing branches) to validate the integration.

3. Expand Coverage – Gradually replace more Git operations with SwiftGitX where it provides clear advantages.

4. Evaluate and Optimize – Compare performance, reliability, and maintainability before considering a full migration.

Next Steps

I’d love to discuss this proposal with the maintainers and contributors of CodeEdit. If this approach sounds reasonable, I can start working on the initial integration and provide PRs step by step.

Looking forward to your feedback!