Skip to content

Add comprehensive tag and stash management API #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eugener merged 2 commits into from
Sep 21, 2025
Merged

Add comprehensive tag and stash management API #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2896794
feat(tags): add comprehensive tag management API
eugener Sep 21, 2025
7038d1d
feat(stash): add comprehensive stash management API
eugener Sep 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
- Author struct: name, email, timestamp with Display implementation
- CommitMessage: subject and optional body parsing
- CommitDetails: full commit info including file changes and diff stats
- **Core types**: Hash (in src/types.rs), IndexStatus, WorktreeStatus, FileEntry (in src/commands/status.rs), Branch, BranchList, BranchType (in src/commands/branch.rs), Commit, CommitLog, Author, CommitMessage, CommitDetails, LogOptions (in src/commands/log.rs), RepoConfig (in src/commands/config.rs), Remote, RemoteList, FetchOptions, PushOptions (in src/commands/remote.rs), RestoreOptions, RemoveOptions, MoveOptions (in src/commands/files.rs), DiffOutput, FileDiff, DiffStatus, DiffOptions, DiffStats, DiffChunk, DiffLine, DiffLineType (in src/commands/diff.rs)
- **Core types**: Hash (in src/types.rs), IndexStatus, WorktreeStatus, FileEntry (in src/commands/status.rs), Branch, BranchList, BranchType (in src/commands/branch.rs), Commit, CommitLog, Author, CommitMessage, CommitDetails, LogOptions (in src/commands/log.rs), RepoConfig (in src/commands/config.rs), Remote, RemoteList, FetchOptions, PushOptions (in src/commands/remote.rs), RestoreOptions, RemoveOptions, MoveOptions (in src/commands/files.rs), DiffOutput, FileDiff, DiffStatus, DiffOptions, DiffStats, DiffChunk, DiffLine, DiffLineType (in src/commands/diff.rs), Tag, TagList, TagType, TagOptions (in src/commands/tag.rs), Stash, StashList, StashOptions, StashApplyOptions (in src/commands/stash.rs)
- **Utility functions**: git(args, working_dir) -> Result<String>, git_raw(args, working_dir) -> Result<Output>
- **Remote management**: Full remote operations with network support
- Repository::add_remote(name, url) -> Result<()> - add remote repository
Expand Down Expand Up @@ -99,8 +99,32 @@
- DiffOptions: context_lines, whitespace handling, path filtering, output formats (name-only, stat, numstat)
- DiffStats: files_changed, insertions, deletions with aggregate statistics
- Complete filtering: files_with_status(), iter(), is_empty(), len() for result analysis
- **Command modules**: status.rs, add.rs, commit.rs, branch.rs, log.rs, config.rs, remote.rs, files.rs, diff.rs (in src/commands/)
- **Testing**: 144+ tests covering all functionality with comprehensive edge cases
- **Tag operations**: Complete tag management with type-safe API
- Repository::tags() -> Result<TagList> - list all tags with comprehensive filtering
- Repository::create_tag(name, target) -> Result<Tag> - create lightweight tag
- Repository::create_tag_with_options(name, target, options) -> Result<Tag> - create tag with options
- Repository::delete_tag(name) -> Result<()> - delete tag
- Repository::show_tag(name) -> Result<Tag> - detailed tag information
- Tag struct: name, hash, tag_type, message, tagger, timestamp
Copy link

Copilot AI Sep 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation claims complete tag metadata (including timestamp), but current implementation derives tagger/timestamp incorrectly (timestamp defaults to now). Update docs or fix parsing to align with the stated capabilities.

Suggested change
- Tag struct: name, hash, tag_type, message, tagger, timestamp
- Tag struct: name, hash, tag_type, message, tagger (may default), timestamp (may default to now if not parsed)

Copilot uses AI. Check for mistakes.
- TagType enum: Lightweight, Annotated
- TagList: Box<[Tag]> with iterator methods (iter, lightweight, annotated), search (find, find_containing, for_commit), counting (len, lightweight_count, annotated_count)
- TagOptions builder: annotated, force, message, sign with builder pattern (with_annotated, with_force, with_message, with_sign)
- Author struct: name, email, timestamp for annotated tag metadata
- **Stash operations**: Complete stash management with type-safe API
- Repository::stash_list() -> Result<StashList> - list all stashes with comprehensive filtering
- Repository::stash_save(message) -> Result<Stash> - create simple stash
- Repository::stash_push(message, options) -> Result<Stash> - create stash with options
- Repository::stash_apply(index, options) -> Result<()> - apply stash without removing it
- Repository::stash_pop(index, options) -> Result<()> - apply and remove stash
- Repository::stash_show(index) -> Result<String> - show stash contents
- Repository::stash_drop(index) -> Result<()> - remove specific stash
- Repository::stash_clear() -> Result<()> - remove all stashes
- Stash struct: index, message, hash, branch, timestamp
- StashList: Box<[Stash]> with iterator methods (iter), search (find_containing, for_branch), access (latest, get), counting (len, is_empty)
- StashOptions builder: untracked, keep_index, patch, staged_only, paths with builder pattern (with_untracked, with_keep_index, with_patch, with_staged_only, with_paths)
- StashApplyOptions builder: restore_index, quiet with builder pattern (with_index, with_quiet)
- **Command modules**: status.rs, add.rs, commit.rs, branch.rs, log.rs, config.rs, remote.rs, files.rs, diff.rs, tag.rs, stash.rs (in src/commands/)
- **Testing**: 161+ tests covering all functionality with comprehensive edge cases
- Run `cargo fmt && cargo build && cargo test && cargo clippy --all-targets --all-features -- -D warnings` after code changes
- Make sure all examples are running

Expand All @@ -118,6 +142,8 @@ The `examples/` directory contains comprehensive demonstrations of library funct
- **remote_operations.rs**: Complete remote management - add/remove/rename remotes, fetch/push operations with options, network operations, error handling
- **file_lifecycle_operations.rs**: Comprehensive file management - restore/reset/remove/move operations, .gitignore management, advanced file lifecycle workflows, staging area manipulation
- **diff_operations.rs**: Comprehensive diff operations showcase - unstaged/staged diffs, commit comparisons, advanced options (whitespace handling, path filtering), output formats (name-only, stat, numstat), and change analysis
- **tag_operations.rs**: Complete tag management - create/delete/list tags, lightweight vs annotated tags, TagOptions builder, tag filtering and search, comprehensive tag workflows
- **stash_operations.rs**: Complete stash management - save/apply/pop/list stashes, advanced options (untracked files, keep index, specific paths), stash filtering and search, comprehensive stash workflows
- **error_handling.rs**: Comprehensive error handling patterns - GitError variants, recovery strategies

Run examples with: `cargo run --example <example_name>`
Expand Down
53 changes: 34 additions & 19 deletions PLAN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
- **Remote management with full CRUD operations**
- **Network operations (fetch, push, clone) with advanced options**
- **File lifecycle operations (restore, reset, remove, move, .gitignore management)**
- **Diff operations with multi-level API and comprehensive options**
- **Tag management with comprehensive operations and filtering**
- **Stash operations with comprehensive management and filtering**

## ✅ Phase 1: Essential Remote Operations (COMPLETED)

Expand Down Expand Up @@ -61,29 +64,41 @@
- [ ] Pull operations (fetch + merge)


## Phase 3: Release Management (Medium Priority)
## ✅ Phase 3: Tag Operations (COMPLETED)

### Tag Operations
- [ ] `repo.create_tag(name, message)` - Create annotated tag
- [ ] `repo.create_lightweight_tag(name)` - Create lightweight tag
- [ ] `repo.list_tags()` - List tags with filtering options
- [ ] `repo.delete_tag(name)` - Delete tag
- [ ] `repo.tag_info(name)` - Get tag details
- [ ] `repo.push_tags()` - Push tags to remote
### ✅ Tag Management
- [x] `repo.tags()` - List all tags with comprehensive filtering
- [x] `repo.create_tag(name, target)` - Create lightweight tag
- [x] `repo.create_tag_with_options(name, target, options)` - Create tag with options
- [x] `repo.delete_tag(name)` - Delete tag
- [x] `repo.show_tag(name)` - Get detailed tag information
- [x] TagList with filtering (lightweight, annotated, find_containing, for_commit)
- [x] TagOptions builder with force, message, sign, annotated options
- [x] Type-safe TagType enum (Lightweight, Annotated)
- [x] Complete tag metadata support (message, tagger, timestamp)

## Phase 5: Release Management (Medium Priority)

### Archive & Export
- [ ] `repo.archive(format, output_path)` - Create repository archive
- [ ] `repo.export_commit(hash, path)` - Export specific commit

## Phase 4: Development Workflow (Medium Priority)
## ✅ Phase 4: Stash Operations (COMPLETED)

### ✅ Stash Management
- [x] `repo.stash_save(message)` - Save current changes
- [x] `repo.stash_push(message, options)` - Stash with advanced options
- [x] `repo.stash_list()` - List all stashes with comprehensive filtering
- [x] `repo.stash_apply(index, options)` - Apply stash without removing it
- [x] `repo.stash_pop(index, options)` - Apply and remove stash
- [x] `repo.stash_drop(index)` / `repo.stash_clear()` - Remove stashes
- [x] `repo.stash_show(index)` - Show stash contents
- [x] StashList with filtering (find_containing, for_branch, latest, get)
- [x] StashOptions builder with untracked, keep_index, patch, staged_only, paths
- [x] StashApplyOptions builder with restore_index, quiet options
- [x] Complete stash metadata support (index, message, hash, branch, timestamp)

### Stash Management
- [ ] `repo.stash_save(message)` - Save current changes
- [ ] `repo.stash_push(files, message)` - Stash specific files
- [ ] `repo.stash_list()` - List all stashes
- [ ] `repo.stash_pop()` / `repo.stash_apply(index)` - Apply stashes
- [ ] `repo.stash_drop(index)` / `repo.stash_clear()` - Remove stashes
- [ ] `repo.stash_show(index)` - Show stash contents
## Phase 6: Development Workflow (Medium Priority)

### Merge & Rebase
- [ ] `repo.merge(branch)` / `repo.merge_commit(hash)` - Merge operations
Expand All @@ -92,7 +107,7 @@
- [ ] Conflict resolution helpers and status
- [ ] `repo.abort_merge()` / `repo.abort_rebase()` - Abort operations

## Phase 5: Advanced Configuration (Medium Priority)
## Phase 7: Advanced Configuration (Medium Priority)

### Enhanced Configuration
- [ ] `Config::global()` - Global git configuration
Expand All @@ -107,7 +122,7 @@
- [ ] `repo.hooks().remove(hook_type)` - Remove hooks
- [ ] Pre-built common hooks (pre-commit, pre-push, etc.)

## Phase 6: Repository Analysis (Low Priority)
## Phase 8: Repository Analysis (Low Priority)

### History & Inspection
- [ ] `repo.show(hash)` - Show commit with full diff
Expand All @@ -121,7 +136,7 @@
- [ ] `repo.size_analysis()` - Large files, repository size analysis
- [ ] `repo.gc()` / `repo.fsck()` - Maintenance operations

## Phase 7: Advanced Features (Low Priority)
## Phase 9: Advanced Features (Low Priority)

### Worktree Support
- [ ] `repo.worktree_add(path, branch)` - Add worktree
Expand Down
Loading