From f6d13330dd927579034225847420a0611070e2ed Mon Sep 17 00:00:00 2001 From: Stefan Haller Date: Sat, 10 May 2025 18:33:46 +0200 Subject: [PATCH] Add custom patch command "Move patch into new commit before the original commit" This is often useful to extract preparatory refactoring commits from a bigger one. --- pkg/commands/git_commands/patch.go | 23 +++++ .../custom_patch_options_menu_action.go | 41 +++++++++ pkg/i18n/english.go | 6 +- .../patch_building/move_to_new_commit.go | 2 +- .../move_to_new_commit_before.go | 91 +++++++++++++++++++ ...move_to_new_commit_before_no_keep_empty.go | 77 ++++++++++++++++ .../move_to_new_commit_from_added_file.go | 2 +- .../move_to_new_commit_from_deleted_file.go | 2 +- ...commit_in_last_commit_of_stacked_branch.go | 2 +- .../move_to_new_commit_partial_hunk.go | 2 +- pkg/integration/tests/test_list.go | 2 + 11 files changed, 244 insertions(+), 6 deletions(-) create mode 100644 pkg/integration/tests/patch_building/move_to_new_commit_before.go create mode 100644 pkg/integration/tests/patch_building/move_to_new_commit_before_no_keep_empty.go diff --git a/pkg/commands/git_commands/patch.go b/pkg/commands/git_commands/patch.go index 49633cf3b..0b1c3db01 100644 --- a/pkg/commands/git_commands/patch.go +++ b/pkg/commands/git_commands/patch.go @@ -314,6 +314,29 @@ func (self *PatchCommands) PullPatchIntoNewCommit( return self.rebase.ContinueRebase() } +func (self *PatchCommands) PullPatchIntoNewCommitBefore( + commits []*models.Commit, + commitIdx int, + commitSummary string, + commitDescription string, +) error { + if err := self.rebase.BeginInteractiveRebaseForCommit(commits, commitIdx+1, true); err != nil { + return err + } + + if err := self.ApplyCustomPatch(false, false); err != nil { + _ = self.rebase.AbortRebase() + return err + } + + if err := self.commit.CommitCmdObj(commitSummary, commitDescription, false).Run(); err != nil { + return err + } + + self.PatchBuilder.Reset() + return self.rebase.ContinueRebase() +} + // We have just applied a patch in reverse to discard it from a commit; if we // now try to apply the patch again to move it to a later commit, or to the // index, then this would conflict "with itself" in case the patch contained diff --git a/pkg/gui/controllers/custom_patch_options_menu_action.go b/pkg/gui/controllers/custom_patch_options_menu_action.go index 68a419a13..92b77f514 100644 --- a/pkg/gui/controllers/custom_patch_options_menu_action.go +++ b/pkg/gui/controllers/custom_patch_options_menu_action.go @@ -64,6 +64,12 @@ func (self *CustomPatchOptionsMenuAction) Call() error { OnPress: self.handlePullPatchIntoNewCommit, Key: 'n', }, + { + Label: self.c.Tr.MovePatchIntoNewCommitBefore, + Tooltip: self.c.Tr.MovePatchIntoNewCommitBeforeTooltip, + OnPress: self.handlePullPatchIntoNewCommitBefore, + Key: 'N', + }, }...) if self.c.Context().Current().GetKey() == self.c.Contexts().LocalCommits.GetKey() { @@ -223,6 +229,41 @@ func (self *CustomPatchOptionsMenuAction) handlePullPatchIntoNewCommit() error { return nil } +func (self *CustomPatchOptionsMenuAction) handlePullPatchIntoNewCommitBefore() error { + if ok, err := self.validateNormalWorkingTreeState(); !ok { + return err + } + + self.returnFocusFromPatchExplorerIfNecessary() + + commitIndex := self.getPatchCommitIndex() + self.c.Helpers().Commits.OpenCommitMessagePanel( + &helpers.OpenCommitMessagePanelOpts{ + // Pass a commit index of one less than the moved-from commit, so that + // you can press up arrow once to recall the original commit message: + CommitIndex: commitIndex - 1, + InitialMessage: "", + SummaryTitle: self.c.Tr.CommitSummaryTitle, + DescriptionTitle: self.c.Tr.CommitDescriptionTitle, + PreserveMessage: false, + OnConfirm: func(summary string, description string) error { + return self.c.WithWaitingStatus(self.c.Tr.RebasingStatus, func(gocui.Task) error { + self.c.Helpers().Commits.CloseCommitMessagePanel() + self.c.LogAction(self.c.Tr.Actions.MovePatchIntoNewCommit) + err := self.c.Git().Patch.PullPatchIntoNewCommitBefore(self.c.Model().Commits, commitIndex, summary, description) + if err := self.c.Helpers().MergeAndRebase.CheckMergeOrRebase(err); err != nil { + return err + } + self.c.Context().Push(self.c.Contexts().LocalCommits, types.OnFocusOpts{}) + return nil + }) + }, + }, + ) + + return nil +} + func (self *CustomPatchOptionsMenuAction) handleApplyPatch(reverse bool) error { self.returnFocusFromPatchExplorerIfNecessary() diff --git a/pkg/i18n/english.go b/pkg/i18n/english.go index e7311e021..c3487dd1a 100644 --- a/pkg/i18n/english.go +++ b/pkg/i18n/english.go @@ -813,6 +813,8 @@ type TranslationSet struct { MovePatchOutIntoIndexTooltip string MovePatchIntoNewCommit string MovePatchIntoNewCommitTooltip string + MovePatchIntoNewCommitBefore string + MovePatchIntoNewCommitBeforeTooltip string MovePatchToSelectedCommit string MovePatchToSelectedCommitTooltip string CopyPatchToClipboard string @@ -1896,8 +1898,10 @@ func EnglishTranslationSet() *TranslationSet { RemovePatchFromOriginalCommitTooltip: "Remove the current patch from its commit. This is achieved by starting an interactive rebase at the commit, applying the patch in reverse, and then continuing the rebase. If later commits depend on the patch, you may need to resolve conflicts.", MovePatchOutIntoIndex: "Move patch out into index", MovePatchOutIntoIndexTooltip: "Move the patch out of its commit and into the index. This is achieved by starting an interactive rebase at the commit, applying the patch in reverse, continuing the rebase to completion, and then applying the patch to the index. If later commits depend on the patch, you may need to resolve conflicts.", - MovePatchIntoNewCommit: "Move patch into new commit", + MovePatchIntoNewCommit: "Move patch into new commit after the original commit", MovePatchIntoNewCommitTooltip: "Move the patch out of its commit and into a new commit sitting on top of the original commit. This is achieved by starting an interactive rebase at the original commit, applying the patch in reverse, then applying the patch to the index and committing it as a new commit, before continuing the rebase to completion. If later commits depend on the patch, you may need to resolve conflicts.", + MovePatchIntoNewCommitBefore: "Move patch into new commit before the original commit", + MovePatchIntoNewCommitBeforeTooltip: "Move the patch out of its commit and into a new commit before the original commit. This works best when the custom patch contains only entire hunks or even entire files; if it contains partial hunks, you are likely to get conflicts.", MovePatchToSelectedCommit: "Move patch to selected commit (%s)", MovePatchToSelectedCommitTooltip: "Move the patch out of its original commit and into the selected commit. This is achieved by starting an interactive rebase at the original commit, applying the patch in reverse, then continuing the rebase up to the selected commit, before applying the patch forward and amending the selected commit. The rebase is then continued to completion. If commits between the source and destination commit depend on the patch, you may need to resolve conflicts.", CopyPatchToClipboard: "Copy patch to clipboard", diff --git a/pkg/integration/tests/patch_building/move_to_new_commit.go b/pkg/integration/tests/patch_building/move_to_new_commit.go index 1df3e5dcb..8f1c77376 100644 --- a/pkg/integration/tests/patch_building/move_to_new_commit.go +++ b/pkg/integration/tests/patch_building/move_to_new_commit.go @@ -48,7 +48,7 @@ var MoveToNewCommit = NewIntegrationTest(NewIntegrationTestArgs{ t.Views().Information().Content(Contains("Building patch")) - t.Common().SelectPatchOption(Contains("Move patch into new commit")) + t.Common().SelectPatchOption(Contains("Move patch into new commit after the original commit")) t.ExpectPopup().CommitMessagePanel(). InitialText(Equals("")). diff --git a/pkg/integration/tests/patch_building/move_to_new_commit_before.go b/pkg/integration/tests/patch_building/move_to_new_commit_before.go new file mode 100644 index 000000000..79964519e --- /dev/null +++ b/pkg/integration/tests/patch_building/move_to_new_commit_before.go @@ -0,0 +1,91 @@ +package patch_building + +import ( + "github.com/jesseduffield/lazygit/pkg/config" + . "github.com/jesseduffield/lazygit/pkg/integration/components" +) + +var MoveToNewCommitBefore = NewIntegrationTest(NewIntegrationTestArgs{ + Description: "Move a patch from a commit to a new commit before the original one", + ExtraCmdArgs: []string{}, + Skip: false, + GitVersion: AtLeast("2.26.0"), + SetupConfig: func(config *config.AppConfig) {}, + SetupRepo: func(shell *Shell) { + shell.CreateDir("dir") + shell.CreateFileAndAdd("dir/file1", "file1 content") + shell.CreateFileAndAdd("dir/file2", "file2 content") + shell.Commit("first commit") + + shell.UpdateFileAndAdd("dir/file1", "file1 content with old changes") + shell.DeleteFileAndAdd("dir/file2") + shell.CreateFileAndAdd("dir/file3", "file3 content") + shell.Commit("commit to move from") + + shell.UpdateFileAndAdd("dir/file1", "file1 content with new changes") + shell.Commit("third commit") + }, + Run: func(t *TestDriver, keys config.KeybindingConfig) { + t.Views().Commits(). + Focus(). + Lines( + Contains("third commit").IsSelected(), + Contains("commit to move from"), + Contains("first commit"), + ). + SelectNextItem(). + PressEnter() + + t.Views().CommitFiles(). + IsFocused(). + Lines( + Contains("dir").IsSelected(), + Contains(" M file1"), + Contains(" D file2"), + Contains(" A file3"), + ). + PressPrimaryAction(). + PressEscape() + + t.Views().Information().Content(Contains("Building patch")) + + t.Common().SelectPatchOption(Contains("Move patch into new commit before the original commit")) + + t.ExpectPopup().CommitMessagePanel(). + InitialText(Equals("")). + Type("new commit").Confirm() + + t.Views().Commits(). + IsFocused(). + Lines( + Contains("third commit"), + Contains("commit to move from").IsSelected(), + Contains("new commit"), + Contains("first commit"), + ). + SelectNextItem(). + PressEnter() + + t.Views().CommitFiles(). + IsFocused(). + Lines( + Contains("dir").IsSelected(), + Contains(" M file1"), + Contains(" D file2"), + Contains(" A file3"), + ). + PressEscape() + + t.Views().Commits(). + IsFocused(). + SelectPreviousItem(). + PressEnter() + + // the original commit has no more files in it + t.Views().CommitFiles(). + IsFocused(). + Lines( + Contains("(none)"), + ) + }, +}) diff --git a/pkg/integration/tests/patch_building/move_to_new_commit_before_no_keep_empty.go b/pkg/integration/tests/patch_building/move_to_new_commit_before_no_keep_empty.go new file mode 100644 index 000000000..bf4e278ef --- /dev/null +++ b/pkg/integration/tests/patch_building/move_to_new_commit_before_no_keep_empty.go @@ -0,0 +1,77 @@ +package patch_building + +import ( + "github.com/jesseduffield/lazygit/pkg/config" + . "github.com/jesseduffield/lazygit/pkg/integration/components" +) + +var MoveToNewCommitBeforeNoKeepEmpty = NewIntegrationTest(NewIntegrationTestArgs{ + Description: "Move a patch from a commit to a new commit before the original one, for older git versions that don't keep the empty commit", + ExtraCmdArgs: []string{}, + Skip: false, + GitVersion: Before("2.26.0"), + SetupConfig: func(config *config.AppConfig) {}, + SetupRepo: func(shell *Shell) { + shell.CreateDir("dir") + shell.CreateFileAndAdd("dir/file1", "file1 content") + shell.CreateFileAndAdd("dir/file2", "file2 content") + shell.Commit("first commit") + + shell.UpdateFileAndAdd("dir/file1", "file1 content with old changes") + shell.DeleteFileAndAdd("dir/file2") + shell.CreateFileAndAdd("dir/file3", "file3 content") + shell.Commit("commit to move from") + + shell.UpdateFileAndAdd("dir/file1", "file1 content with new changes") + shell.Commit("third commit") + }, + Run: func(t *TestDriver, keys config.KeybindingConfig) { + t.Views().Commits(). + Focus(). + Lines( + Contains("third commit").IsSelected(), + Contains("commit to move from"), + Contains("first commit"), + ). + SelectNextItem(). + PressEnter() + + t.Views().CommitFiles(). + IsFocused(). + Lines( + Contains("dir").IsSelected(), + Contains(" M file1"), + Contains(" D file2"), + Contains(" A file3"), + ). + PressPrimaryAction(). + PressEscape() + + t.Views().Information().Content(Contains("Building patch")) + + t.Common().SelectPatchOption(Contains("Move patch into new commit before the original commit")) + + t.ExpectPopup().CommitMessagePanel(). + InitialText(Equals("")). + Type("new commit").Confirm() + + t.Views().Commits(). + IsFocused(). + Lines( + Contains("third commit"), + Contains("new commit").IsSelected(), + Contains("first commit"), + ). + PressEnter() + + t.Views().CommitFiles(). + IsFocused(). + Lines( + Contains("dir").IsSelected(), + Contains(" M file1"), + Contains(" D file2"), + Contains(" A file3"), + ). + PressEscape() + }, +}) diff --git a/pkg/integration/tests/patch_building/move_to_new_commit_from_added_file.go b/pkg/integration/tests/patch_building/move_to_new_commit_from_added_file.go index 97aaea2db..11abe23f4 100644 --- a/pkg/integration/tests/patch_building/move_to_new_commit_from_added_file.go +++ b/pkg/integration/tests/patch_building/move_to_new_commit_from_added_file.go @@ -39,7 +39,7 @@ var MoveToNewCommitFromAddedFile = NewIntegrationTest(NewIntegrationTestArgs{ t.Views().Information().Content(Contains("Building patch")) - t.Common().SelectPatchOption(Contains("Move patch into new commit")) + t.Common().SelectPatchOption(Contains("Move patch into new commit after the original commit")) t.ExpectPopup().CommitMessagePanel(). InitialText(Equals("")). diff --git a/pkg/integration/tests/patch_building/move_to_new_commit_from_deleted_file.go b/pkg/integration/tests/patch_building/move_to_new_commit_from_deleted_file.go index 2c51acf85..9edc06fb2 100644 --- a/pkg/integration/tests/patch_building/move_to_new_commit_from_deleted_file.go +++ b/pkg/integration/tests/patch_building/move_to_new_commit_from_deleted_file.go @@ -39,7 +39,7 @@ var MoveToNewCommitFromDeletedFile = NewIntegrationTest(NewIntegrationTestArgs{ t.Views().Information().Content(Contains("Building patch")) - t.Common().SelectPatchOption(Contains("Move patch into new commit")) + t.Common().SelectPatchOption(Contains("Move patch into new commit after the original commit")) t.ExpectPopup().CommitMessagePanel(). InitialText(Equals("")). diff --git a/pkg/integration/tests/patch_building/move_to_new_commit_in_last_commit_of_stacked_branch.go b/pkg/integration/tests/patch_building/move_to_new_commit_in_last_commit_of_stacked_branch.go index 645d2a120..ed98657d5 100644 --- a/pkg/integration/tests/patch_building/move_to_new_commit_in_last_commit_of_stacked_branch.go +++ b/pkg/integration/tests/patch_building/move_to_new_commit_in_last_commit_of_stacked_branch.go @@ -52,7 +52,7 @@ var MoveToNewCommitInLastCommitOfStackedBranch = NewIntegrationTest(NewIntegrati t.Views().Information().Content(Contains("Building patch")) - t.Common().SelectPatchOption(Contains("Move patch into new commit")) + t.Common().SelectPatchOption(Contains("Move patch into new commit after the original commit")) t.ExpectPopup().CommitMessagePanel(). InitialText(Equals("")). diff --git a/pkg/integration/tests/patch_building/move_to_new_commit_partial_hunk.go b/pkg/integration/tests/patch_building/move_to_new_commit_partial_hunk.go index 6a86546c9..4d12e0f90 100644 --- a/pkg/integration/tests/patch_building/move_to_new_commit_partial_hunk.go +++ b/pkg/integration/tests/patch_building/move_to_new_commit_partial_hunk.go @@ -44,7 +44,7 @@ var MoveToNewCommitPartialHunk = NewIntegrationTest(NewIntegrationTestArgs{ t.Views().Information().Content(Contains("Building patch")) - t.Common().SelectPatchOption(Contains("Move patch into new commit")) + t.Common().SelectPatchOption(Contains("Move patch into new commit after the original commit")) t.ExpectPopup().CommitMessagePanel(). InitialText(Equals("")). diff --git a/pkg/integration/tests/test_list.go b/pkg/integration/tests/test_list.go index f5f2be22a..0a2a4f46c 100644 --- a/pkg/integration/tests/test_list.go +++ b/pkg/integration/tests/test_list.go @@ -310,6 +310,8 @@ var tests = []*components.IntegrationTest{ patch_building.MoveToLaterCommit, patch_building.MoveToLaterCommitPartialHunk, patch_building.MoveToNewCommit, + patch_building.MoveToNewCommitBefore, + patch_building.MoveToNewCommitBeforeNoKeepEmpty, patch_building.MoveToNewCommitFromAddedFile, patch_building.MoveToNewCommitFromDeletedFile, patch_building.MoveToNewCommitInLastCommitOfStackedBranch,