🛠️ Git Editor - Complete Technical Documentation

# Download the latest release for your platform
wget https://github.com/rohansen856/git-editor/releases/latest/download/git-editor-linux-x86_64.tar.gz
tar -xzf git-editor-linux-x86_64.tar.gz
sudo mv git-editor-linux-x86_64 /usr/local/bin/git-editor

# Verify installation
git-editor --help

# Prerequisites: Rust 1.87+ and a C compiler (libgit2 is built from source)
rustup update stable

# Clone and build
git clone https://github.com/rohansen856/git-editor.git
cd git-editor

# Build release binary
cargo build --release

# Install globally
sudo cp target/release/git-editor /usr/local/bin/

# Or use cargo install
cargo install --path .

# Build Docker image
docker build -t git-editor .

# Run with repository mounted (-it is required: every prompt needs a TTY).
# The image runs as root; on Linux with rootful Docker, pass your uid so that
# libgit2's repository-ownership check passes and no root-owned files are written:
docker run -it --user "$(id -u):$(id -g)" -e HOME=/tmp \
  -v /path/to/repo:/workspace git-editor --repo-path /workspace -s

git-editor/
├── src/
│   ├── main.rs              # Entry point and mode dispatch
│   ├── lib.rs               # Library re-exports (args, rewrite, utils)
│   ├── args.rs              # CLI argument parsing (clap)
│   ├── docs.rs              # Documentation generation
│   ├── rewrite/
│   │   ├── mod.rs           # Rewrite module exports
│   │   ├── rewrite_all.rs   # Full history rewriting
│   │   ├── rewrite_specific.rs # Interactive commit selection
│   │   └── rewrite_range.rs # Range-based editing (crossterm TUI)
│   └── utils/
│       ├── mod.rs           # Utility module exports
│       ├── types.rs         # Common types and aliases
│       ├── validator.rs     # Input validation
│       ├── datetime.rs      # Timestamp generation
│       ├── commit_history.rs# Git operations
│       ├── prompt.rs        # User interaction
│       ├── git_clone.rs     # Repository cloning
│       ├── git_config.rs    # Git configuration
│       ├── message_trailers.rs # Signed-off-by / Co-authored-by rewrites
│       ├── simulation.rs    # Dry-run functionality
│       └── help.rs          # Custom help text (unused; clap --help is primary)
├── docs/
│   └── template.html        # Documentation template
├── tests/
│   └── integration_tests.rs # Integration test suite
├── Cargo.toml              # Dependencies and metadata
├── Dockerfile              # Container configuration
└── Makefile                # Build automation

# Development build (fast compilation)
cargo build

# Release build (optimized)
cargo build --release

# Run with arguments
cargo run -- --help
cargo run -- --repo-path . -s

# Watch mode for development
cargo watch -x "run -- --docs"

# Run all tests (unit, engine, end-to-end, integration)
cargo test

# Run unit tests only
cargo test --lib

# Run the rewrite engine and end-to-end suites
cargo test --test engine
cargo test --test e2e

# Run integration tests only
cargo test --test integration_tests

# Run specific test with output
cargo test --test integration_tests test_show_history_mode_integration -- --nocapture

# Run tests without browser opening (for development)
GIT_EDITOR_NO_BROWSER=1 cargo test --all

# Format code
cargo fmt

# Check formatting without changes
cargo fmt --check

# Run linter
cargo clippy

# Run linter with strict warnings (CI requirement)
cargo clippy --all-targets --all-features -- -D warnings

# Security audit
cargo audit

# Check for outdated dependencies
cargo outdated

# Build release binary
make build

# Run all tests
make test

# Check code formatting
make fmt

# Run clippy linter
make lint

# Run with default parameters
make run

# Run with custom environment variables
make run-custom

# Clean build artifacts
make clean

# Build Docker image
make docker-build

# Run in Docker container
make docker-run

# Install binary to /usr/local/bin
make install

# Show all available commands
make help

// Walk HEAD and optionally print history
pub fn get_commit_history(args: &Args, print: bool) -> Result<Vec<CommitInfo>>

// Generate random-gap timestamps for full rewrite (mutates args if cloning)
pub fn generate_timestamps(args: &mut Args) -> Result<Vec<NaiveDateTime>>

// Full repository history rewrite (timestamps from generate_timestamps)
pub fn rewrite_all_commits(args: &Args, timestamps: Vec<NaiveDateTime>) -> Result<()>

// Interactive single-commit selection and editing
pub fn rewrite_specific_commits(args: &Args) -> Result<()>

// Range-based commit editing (crossterm TUI)
pub fn rewrite_range_commits(args: &Args) -> Result<()>

pub struct CommitInfo {
    pub oid: git2::Oid,            // Full commit object id
    pub short_hash: String,        // Abbreviated hash
    pub timestamp: NaiveDateTime,  // Commit timestamp
    pub author_name: String,       // Author display name
    pub author_email: String,      // Author email address
    pub message: String,           // Commit message
    pub parent_count: usize,       // Number of parent commits
}

pub struct EditOptions {
    pub author_name: Option<String>,
    pub author_email: Option<String>,
    pub timestamp: Option<NaiveDateTime>,
    pub message: Option<String>,
}