simple-git - Rust中简化Git操作的工具库

simple-git 是一个Rust库，它提供了简单易用的API来执行Git版本控制操作，无需直接调用Git命令行工具。

主要特性

• 简化Git命令调用
• 类型安全的API
• 异步支持
• 跨平台兼容
• 错误处理友好

安装

在Cargo.toml中添加依赖：

[dependencies]
simple-git = "0.1"

基本使用方法

初始化仓库

use simple_git::Repository;

async fn init_repo() -> Result<(), Box<dyn std::error::Error>> {
    let repo = Repository::init("/path/to/repo").await?;
    println!("Repository initialized at {:?}", repo.path());
    Ok(())
}

克隆仓库

async fn clone_repo() -> Result<(), Box<dyn std::error::Error>> {
    let repo = Repository::clone("https://github.com/user/repo.git", "/path/to/clone").await?;
    println!("Repository cloned to {:?}", repo.path());
    Ok(())
}

基本操作示例

use simple_git::{Repository, StatusOptions};

async fn git_operations() -> Result<(), Box<dyn std::error::Error>> {
    // 打开现有仓库
    let repo = Repository::open("/path/to/repo").await?;
    
    // 检查状态
    let status = repo.status(StatusOptions::default()).await?;
    println!("Repository status: {:?}", status);
    
    // 添加文件
    repo.add(&["src/main.rs"]).await?;
    
    // 提交更改
    repo.commit("Update main.rs file").await?;
    
    // 推送更改
    repo.push().await?;
    
    // 拉取更新
    repo.pull().await?;
    
    Ok(())
}

分支操作

async fn branch_operations() -> Result<(), Box<dyn std::error::Error>> {
    let repo = Repository::open("/path/to/repo").await?;
    
    // 创建新分支
    repo.create_branch("feature/new-feature").await?;
    
    // 切换分支
    repo.checkout("feature/new-feature").await?;
    
    // 列出所有分支
    let branches = repo.list_branches().await?;
    println!("Available branches: {:?}", branches);
    
    // 合并分支
    repo.merge("main").await?;
    
    Ok(())
}

高级用法

自定义配置

use simple_git::{Repository, Config};

async fn custom_config() -> Result<(), Box<dyn std::error::Error>> {
    let mut config = Config::default();
    config.timeout = Some(std::time::Duration::from_secs(30));
    config.verbose = true;
    
    let repo = Repository::open_with_config("/path/to/repo", config).await?;
    // 使用自定义配置操作仓库...
    Ok(())
}

处理Git钩子

use simple_git::{Repository, Hook};

async fn setup_hooks() -> Result<(), Box<dyn std::error::Error>> {
    let repo = Repository::open("/path/to/repo").await?;
    
    // 设置pre-commit钩子
    repo.set_hook(Hook::PreCommit, "#!/bin/sh\ncargo test").await?;
    
    Ok(())
}

错误处理

simple-git提供了详细的错误类型：

use simple_git::{Repository, GitError};

async fn handle_errors() -> Result<(), GitError> {
    match Repository::open("/invalid/p path").await {
        Ok(repo) => {
            // 操作仓库...
            Ok(())
        },
        Err(GitError::NotFound) => {
            eprintln!("Repository not found");
            Ok(())
        },
        Err(e) => Err(e),
    }
}

完整示例

下面是一个完整的示例，展示了如何使用simple-git库从初始化仓库到推送更改的完整工作流：

use simple_git::{Repository, StatusOptions};
use std::error::Error;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    // 1. 初始化新仓库
    let repo_path = "./my_project";
    let repo = Repository::init(repo_path).await?;
    println!("Initialized new repository at {}", repo_path);

    // 2. 创建新文件并添加到暂存区
    std::fs::write(format!("{}/README.md", repo_path), "# My Project")?;
    repo.add(&["README.md"]).await?;
    println!("Added README.md to staging area");

    // 3. 检查状态
    let status = repo.status(StatusOptions::default()).await?;
    println!("Current repository status: {:?}", status);

    // 4. 提交更改
    repo.commit("Initial commit").await?;
    println!("Committed changes");

    // 5. 创建并切换到新分支
    repo.create_branch("dev").await?;
    repo.checkout("dev").await?;
    println!("Created and switched to 'dev' branch");

    // 6. 修改文件并提交
    std::fs::write(format!("{}/README.md", repo_path), "# My Project\n## Development")?;
    repo.add(&["README.md"]).await?;
    repo.commit("Update README").await?;
    println!("Updated README on dev branch");

    // 7. 合并分支到main
    repo.checkout("main").await?;
    repo.merge("dev").await?;
    println!("Merged dev branch into main");

    // 8. 推送更改到远程仓库(假设已设置远程)
    // repo.push().await?;
    // println!("Pushed changes to remote");

    Ok(())
}

注意事项

1. 所有操作都是异步的，需要使用async/await
2. 路径参数在不同操作系统上表现可能不同
3. 某些高级Git功能可能需要直接使用Git命令行
4. 在生产环境使用前充分测试

simple-git库为Rust开发者提供了操作Git仓库的便捷方式，特别适合需要将Git功能集成到应用程序中的场景。