Add interactive git restore command by jetm · Pull Request #489 · wfxr/forgit

jetm · 2026-02-02T18:02:48Z

Summary

Add an interactive git restore command (grs) that provides an fzf-based
selector for discarding unstaged changes to working tree files. Closes #447.

Problem

There is no interactive way to selectively discard modifications to working
tree files. Users must either manually type file paths with git restore or
use git checkout, which is the older discouraged syntax.

Changes

Add _forgit_restore function with fzf-based file selector and diff preview
Expose as grs alias, consistent with existing forgit commands
Integrate with shell completion systems across bash/zsh/fish
Add comprehensive test coverage

Check list

I have performed a self-review of my code
I have commented my code in hard-to-understand areas
I have added unit tests for my code
I have made corresponding changes to the documentation

Type of change

Test environment

Shell
- bash
- zsh
- fish
OS
- Linux
- Mac OS X
- Windows
- Others:

Copilot

Pull request overview

This PR adds a new interactive forgit_discard command (aliased as gdc) that combines unstaging and reverting uncommitted changes into a single operation. This fills a gap in forgit's workflow by providing a safe, interactive way to discard staged changes with preview and optional confirmation, consistent with forgit's design philosophy of making destructive operations more deliberate.

Changes:

Added _forgit_discard() function with preview and interactive file selection for discarding staged changes
Integrated the new command across all shell plugins (bash, zsh, fish) and completion systems
Added comprehensive test coverage for the new functionality
Updated documentation with usage examples and configuration options

Reviewed changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
bin/git-forgit	Implements the core discard functionality with `_forgit_discard()`, `_forgit_git_discard()`, and `_forgit_discard_preview()` functions
tests/discard.test.sh	Adds test suite covering empty state, tracked file restoration, new file handling, and unstaging behavior
forgit.plugin.zsh	Registers `forgit::discard()` function and `gdc` alias for zsh
conf.d/forgit.plugin.fish	Registers abbreviation for fish shell
completions/git-forgit.fish	Adds completion support for fish shell
completions/git-forgit.bash	Adds completion support for bash
completions/_git-forgit	Adds completion support for zsh
README.md	Documents the new command in features list and configuration tables
LICENSE	Updates copyright year to 2026

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/discard.test.sh

bin/git-forgit

Currently there is no interactive way to selectively discard modifications to working tree files. Users must either manually type file paths with git restore or use git checkout, which is the older discouraged syntax. This makes it cumbersome to selectively discard changes when reviewing multiple modified files. Add _forgit_restore function that provides an fzf-based selector for modified files with diff preview. This follows the same pattern as existing forgit commands like reset_head and checkout_file, allowing users to interactively review diffs before discarding changes. The command is exposed as 'grs' alias and integrated with shell completion systems across bash/zsh/fish. Signed-off-by: Javier Tia <floss@jetm.me>

Currently the restore functionality lacks automated tests, making it difficult to verify correctness during refactoring and increasing the risk of regressions. Without tests, developers cannot confidently modify the restore behavior or ensure edge cases are handled properly. Add a complete test suite covering core restore scenarios including modified files, untracked files, mixed staged/unstaged changes, and renamed files. These tests validate that restore correctly reverts working tree changes while preserving staged content and ignoring untracked files, ensuring the command behaves consistently with Git's restore semantics. Signed-off-by: Javier Tia <floss@jetm.me>

sandr01d

Thanks for the update @jetm! Looks mostly good, but needs a few changes here and there. The pipeline is failing because we require the usage of conventional commits. I'll do a full functional review, once the code is finalized.

sandr01d · 2026-03-06T23:52:02Z

completions/git-forgit.fish

-        cherry_pick cherry_pick_from_branch clean diff fixup ignore log reflog rebase reset_head \
-        revert_commit reword squash stash_show stash_push switch_branch


There have been some commands removed here, probably by mistake.

sandr01d · 2026-03-06T23:54:29Z

README.md

+# for antidote (in .zsh_plugins.txt)
+wfxr/forgit kind:defer
+


This change does not belong in this PR. Feel free to open a separate one.

sandr01d · 2026-03-06T23:55:23Z

README.md

+
+
+


The empty lines should not be here.

sandr01d · 2026-03-07T00:02:05Z

tests/restore.test.sh

+    echo "staged change" >mixed.txt
+    git add mixed.txt
+    echo "unstaged change" >mixed.txt


You need double >> here to not overwrite the file.

Suggested change

echo "staged change" >mixed.txt

git add mixed.txt

echo "unstaged change" >mixed.txt

echo "staged change" >> mixed.txt

git add mixed.txt

echo "unstaged change" >> mixed.txt

sandr01d · 2026-03-07T00:04:16Z

tests/restore.test.sh

+function test_restore_with_renamed_file() {
+    echo "rename content" >before-rename.txt
+    git add before-rename.txt
+    git commit -q -m "Add file for rename test"
+    git mv before-rename.txt after-rename.txt
+    git commit -q -m "Rename file"
+    echo "modified after rename" >after-rename.txt
+    _forgit_git_restore after-rename.txt
+    assert_same "rename content" "$(cat after-rename.txt)"
+}


Because you commit the file after renaming, the renaming does not have any effect anymore in this case.

sandr01d · 2026-03-07T00:04:51Z

tests/restore.test.sh

+function test_restore_passes_through_arguments_when_non_flags_provided() {
+    echo "original" >passthrough.txt
+    git add passthrough.txt
+    git commit -q -m "Add passthrough file"
+    echo "modified" >passthrough.txt
+    _forgit_restore passthrough.txt
+    assert_same "original" "$(cat passthrough.txt)"
+}


This test has nothing to do with what it's name implies.

sandr01d · 2026-03-07T00:12:11Z

completions/_git-forgit

    reflog) _git-forgit-reflog ;;
    rebase) _git-rebase ;;
    reset_head) _git-staged ;;
+    restore) _git-checkout-file ;;


Git has completions for git restore (_git-restore for zsh and _git_restore for bash). Any reason not to use those?

sandr01d · 2026-03-07T00:17:13Z

bin/git-forgit

+}
+
+# git restore selector
+_forgit_restore() {


One very neat thing about git restore IMO is that it allows to not only discard modified files, but also allows unstaging files with --staged and discarding from the working tree and the index (staged files) with --staged --worktree. I think it would be worth adding support for this, which would require us to do a bit of argument parsing to determine which files to show in the selection:

no --staged -> modified

--staged -> staged files

--staged --worktree -> modified and staged files

Would you be willing to implement this with this PR @jetm?

sandr01d · 2026-03-07T00:20:57Z

tests/restore.test.sh

+    echo "initial" >README.md
+    git add README.md
+    git commit -q -m "Initial commit"


This file is added and committed here, but not actually used in any of the tests, so this section should be removed.

sandr01d · 2026-03-07T00:22:31Z

tests/restore.test.sh

+}
+
+function test_restore_reverts_modified_file_to_committed_state() {
+    echo "original content" >tracked.txt


Very minor nitpick, but could you please add an extra space after the redirects? This applies to all redirects in this file.

Suggested change

echo "original content" >tracked.txt

echo "original content" > tracked.txt

jetm force-pushed the forgit-discard branch from 7cc4276 to 70471e0 Compare February 2, 2026 18:31

wfxr requested a review from Copilot February 5, 2026 11:30

Copilot started reviewing on behalf of wfxr February 5, 2026 11:31 View session

Copilot AI reviewed Feb 5, 2026

View reviewed changes

tests/discard.test.sh Outdated Show resolved Hide resolved

wfxr reviewed Feb 5, 2026

View reviewed changes

bin/git-forgit Outdated Show resolved Hide resolved

jetm force-pushed the forgit-discard branch 2 times, most recently from ea508d8 to 7f90257 Compare February 11, 2026 23:12

jetm changed the title ~~Add interactive git discard command~~ Add interactive git restore and git discard commands Feb 11, 2026

jetm force-pushed the forgit-discard branch 2 times, most recently from 6d49fd7 to 6cfc362 Compare February 11, 2026 23:16

jetm force-pushed the forgit-discard branch from 6cfc362 to 55d5496 Compare March 6, 2026 22:38

jetm added 2 commits March 6, 2026 16:43

jetm force-pushed the forgit-discard branch from 55d5496 to 21d532c Compare March 6, 2026 22:43

jetm changed the title ~~Add interactive git restore and git discard commands~~ Add interactive git restore command Mar 6, 2026

sandr01d requested changes Mar 7, 2026

View reviewed changes

sandr01d reviewed Mar 7, 2026

View reviewed changes

LittleHaku mentioned this pull request Mar 10, 2026

Add support for git restore #447

Open

		cherry_pick cherry_pick_from_branch clean diff fixup ignore log reflog rebase reset_head \
		revert_commit reword squash stash_show stash_push switch_branch

	echo "original content" >tracked.txt
	echo "original content" > tracked.txt

Conversation

jetm commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Problem

Changes

Check list

Type of change

Test environment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

sandr01d left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sandr01d Mar 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jetm commented Feb 2, 2026 •

edited

Loading

sandr01d Mar 7, 2026 •

edited

Loading