Split commit message panel into commit summary and commit description…

… panel

When we use the one panel for the entire commit message, its tricky to have a keybinding both for adding a newline and submitting.
By having two panels: one for the summary line and one for the description, we allow for 'enter' to submit the message when done from the summary panel,
and 'enter' to add a newline when done from the description panel. Alt-enter, for those who can use that key combo, also works for submitting the message
from the description panel. For those who can't use that key combo, and don't want to remap the keybinding, they can hit tab to go back to the summary panel
and then 'enter' to submit the message.

We have some awkwardness in that both contexts (i.e. panels) need to appear and disappear in tandem and we don't have a great way of handling that concept,
so we just push both contexts one after the other, and likewise remove both contexts when we escape.

docs/Config.md

@@ -171,7 +171,6 @@ keybinding:
  diffingMenu-alt: '<c-e>' # deprecated
  copyToClipboard: '<c-o>'
  submitEditorText: '<enter>'
- appendNewline: '<a-enter>'
  extrasMenu: '@'
  toggleWhitespaceInDiffView: '<c-w>'
  increaseContextInDiffView: '}'

pkg/cheatsheet/generate.go

@@ -87,33 +87,34 @@ func writeString(file *os.File, str string) {
 
 func localisedTitle(tr *i18n.TranslationSet, str string) string {
  contextTitleMap := map[string]string{
- "global": tr.GlobalTitle,
- "navigation": tr.NavigationTitle,
- "branches": tr.BranchesTitle,
- "localBranches": tr.LocalBranchesTitle,
- "files": tr.FilesTitle,
- "status": tr.StatusTitle,
- "submodules": tr.SubmodulesTitle,
- "subCommits": tr.SubCommitsTitle,
- "remoteBranches": tr.RemoteBranchesTitle,
- "remotes": tr.RemotesTitle,
- "reflogCommits": tr.ReflogCommitsTitle,
- "tags": tr.TagsTitle,
- "commitFiles": tr.CommitFilesTitle,
- "commitMessage": tr.CommitMessageTitle,
- "commits": tr.CommitsTitle,
- "confirmation": tr.ConfirmationTitle,
- "information": tr.InformationTitle,
- "main": tr.NormalTitle,
- "patchBuilding": tr.PatchBuildingTitle,
- "mergeConflicts": tr.MergingTitle,
- "staging": tr.StagingTitle,
- "menu": tr.MenuTitle,
- "search": tr.SearchTitle,
- "secondary": tr.SecondaryTitle,
- "stash": tr.StashTitle,
- "suggestions": tr.SuggestionsCheatsheetTitle,
- "extras": tr.ExtrasTitle,
+ "global": tr.GlobalTitle,
+ "navigation": tr.NavigationTitle,
+ "branches": tr.BranchesTitle,
+ "localBranches": tr.LocalBranchesTitle,
+ "files": tr.FilesTitle,
+ "status": tr.StatusTitle,
+ "submodules": tr.SubmodulesTitle,
+ "subCommits": tr.SubCommitsTitle,
+ "remoteBranches": tr.RemoteBranchesTitle,
+ "remotes": tr.RemotesTitle,
+ "reflogCommits": tr.ReflogCommitsTitle,
+ "tags": tr.TagsTitle,
+ "commitFiles": tr.CommitFilesTitle,
+ "commitMessage": tr.CommitMessageTitle,
+ "commitDescription": tr.CommitDescriptionTitle,
+ "commits": tr.CommitsTitle,
+ "confirmation": tr.ConfirmationTitle,
+ "information": tr.InformationTitle,
+ "main": tr.NormalTitle,
+ "patchBuilding": tr.PatchBuildingTitle,
+ "mergeConflicts": tr.MergingTitle,
+ "staging": tr.StagingTitle,
+ "menu": tr.MenuTitle,
+ "search": tr.SearchTitle,
+ "secondary": tr.SecondaryTitle,
+ "stash": tr.StashTitle,
+ "suggestions": tr.SuggestionsCheatsheetTitle,
+ "extras": tr.ExtrasTitle,
  }
 
  title, ok := contextTitleMap[str]

pkg/commands/git_commands/commit.go

@@ -8,6 +8,8 @@ import (
  "github.com/jesseduffield/lazygit/pkg/commands/oscommands"
 )
 
+var ErrInvalidCommitIndex = errors.New("invalid commit index")
+
 type CommitCommands struct {
  *GitCommon
 }
@@ -18,11 +20,6 @@ func NewCommitCommands(gitCommon *GitCommon) *CommitCommands {
  }
 }
 
-// RewordLastCommit rewords the topmost commit with the given message
-func (self *CommitCommands) RewordLastCommit(message string) error {
- return self.cmd.New("git commit --allow-empty --amend --only -m " + self.cmd.Quote(message)).Run()
-}
-
 // ResetAuthor resets the author of the topmost commit
 func (self *CommitCommands) ResetAuthor() error {
  return self.cmd.New("git commit --allow-empty --only --no-edit --amend --reset-author").Run()
@@ -45,19 +42,31 @@ func (self *CommitCommands) ResetToCommit(sha string, strength string, envVars [
 }
 
 func (self *CommitCommands) CommitCmdObj(message string) oscommands.ICmdObj {
- splitMessage := strings.Split(message, "\n")
- lineArgs := ""
- for _, line := range splitMessage {
- lineArgs += fmt.Sprintf(" -m %s", self.cmd.Quote(line))
- }
+ messageArgs := self.commitMessageArgs(message)
 
  skipHookPrefix := self.UserConfig.Git.SkipHookPrefix
  noVerifyFlag := ""
  if skipHookPrefix != "" && strings.HasPrefix(message, skipHookPrefix) {
  noVerifyFlag = " --no-verify"
  }
 
- return self.cmd.New(fmt.Sprintf("git commit%s%s%s", noVerifyFlag, self.signoffFlag(), lineArgs))
+ return self.cmd.New(fmt.Sprintf("git commit%s%s%s", noVerifyFlag, self.signoffFlag(), messageArgs))
+}
+
+// RewordLastCommit rewords the topmost commit with the given message
+func (self *CommitCommands) RewordLastCommit(message string) error {
+ messageArgs := self.commitMessageArgs(message)
+ return self.cmd.New(fmt.Sprintf("git commit --allow-empty --amend --only%s", messageArgs)).Run()
+}
+
+func (self *CommitCommands) commitMessageArgs(message string) string {
+ msg, description, _ := strings.Cut(message, "\n")
+ descriptionArgs := ""
+ if description != "" {
+ descriptionArgs = fmt.Sprintf(" -m %s", self.cmd.Quote(description))
+ }
+
+ return fmt.Sprintf(" -m %s%s", self.cmd.Quote(msg), descriptionArgs)
 }
 
 // runs git commit without the -m argument meaning it will invoke the user's editor
@@ -178,3 +187,13 @@ func (self *CommitCommands) RevertMerge(sha string, parentNumber int) error {
 func (self *CommitCommands) CreateFixupCommit(sha string) error {
  return self.cmd.New(fmt.Sprintf("git commit --fixup=%s", sha)).Run()
 }
+
+// a value of 0 means the head commit, 1 is the parent commit, etc
+func (self *CommitCommands) GetCommitMessageFromHistory(value int) (string, error) {
+ hash, _ := self.cmd.New(fmt.Sprintf("git log -1 --skip=%d --pretty=%%H", value)).DontLog().RunWithOutput()
+ formattedHash := strings.TrimSpace(hash)
+ if len(formattedHash) == 0 {
+ return "", ErrInvalidCommitIndex
+ }
+ return self.GetCommitMessage(formattedHash)
+}

pkg/commands/git_commands/commit_test.go

@@ -9,12 +9,32 @@ import (
 )
 
 func TestCommitRewordCommit(t *testing.T) {
- runner := oscommands.NewFakeRunner(t).
- ExpectGitArgs([]string{"commit", "--allow-empty", "--amend", "--only", "-m", "test"}, "", nil)
- instance := buildCommitCommands(commonDeps{runner: runner})
+ type scenario struct {
+ testName string
+ runner *oscommands.FakeCmdObjRunner
+ input string
+ }
+ scenarios := []scenario{
+ {
+ "Single line reword",
+ oscommands.NewFakeRunner(t).ExpectGitArgs([]string{"commit", "--allow-empty", "--amend", "--only", "-m", "test"}, "", nil),
+ "test",
+ },
+ {
+ "Multi line reword",
+ oscommands.NewFakeRunner(t).ExpectGitArgs([]string{"commit", "--allow-empty", "--amend", "--only", "-m", "test", "-m", "line 2\nline 3"}, "", nil),
+ "test\nline 2\nline 3",
+ },
+ }
+ for _, s := range scenarios {
+ s := s
+ t.Run(s.testName, func(t *testing.T) {
+ instance := buildCommitCommands(commonDeps{runner: s.runner})
 
- assert.NoError(t, instance.RewordLastCommit("test"))
- runner.CheckForMissingCalls()
+ assert.NoError(t, instance.RewordLastCommit(s.input))
+ s.runner.CheckForMissingCalls()
+ })
+ }
 }
 
 func TestCommitResetToCommit(t *testing.T) {
@@ -274,3 +294,40 @@ Merge pull request #1750 from mark2185/fix-issue-template
  })
  }
 }
+
+func TestGetCommitMessageFromHistory(t *testing.T) {
+ type scenario struct {
+ testName string
+ runner *oscommands.FakeCmdObjRunner
+ test func(string, error)
+ }
+ scenarios := []scenario{
+ {
+ "Empty message",
+ oscommands.NewFakeRunner(t).Expect("git log -1 --skip=2 --pretty=%H", "", nil).Expect("git rev-list --format=%B --max-count=1 ", "", nil),
+ func(output string, err error) {
+ assert.Error(t, err)
+ },
+ },
+ {
+ "Default case to retrieve a commit in history",
+ oscommands.NewFakeRunner(t).Expect("git log -1 --skip=2 --pretty=%H", "sha3 \n", nil).Expect("git rev-list --format=%B --max-count=1 sha3", `commit sha3
+ use generics to DRY up context code`, nil),
+ func(output string, err error) {
+ assert.NoError(t, err)
+ assert.Equal(t, "use generics to DRY up context code", output)
+ },
+ },
+ }
+
+ for _, s := range scenarios {
+ s := s
+ t.Run(s.testName, func(t *testing.T) {
+ instance := buildCommitCommands(commonDeps{runner: s.runner})
+
+ output, err := instance.GetCommitMessageFromHistory(2)
+
+ s.test(output, err)
+ })
+ }
+}

pkg/config/user_config.go

@@ -165,6 +165,7 @@ type KeybindingUniversalConfig struct {
  Select string `yaml:"select"`
  GoInto string `yaml:"goInto"`
  Confirm string `yaml:"confirm"`
+ ConfirmInEditor string `yaml:"confirmInEditor"`
  Remove string `yaml:"remove"`
  New string `yaml:"new"`
  Edit string `yaml:"edit"`
@@ -193,7 +194,6 @@ type KeybindingUniversalConfig struct {
  CopyToClipboard string `yaml:"copyToClipboard"`
  OpenRecentRepos string `yaml:"openRecentRepos"`
  SubmitEditorText string `yaml:"submitEditorText"`
- AppendNewline string `yaml:"appendNewline"`
  ExtrasMenu string `yaml:"extrasMenu"`
  ToggleWhitespaceInDiffView string `yaml:"toggleWhitespaceInDiffView"`
  IncreaseContextInDiffView string `yaml:"increaseContextInDiffView"`
@@ -492,6 +492,7 @@ func GetDefaultConfig() *UserConfig {
  Select: "<space>",
  GoInto: "<enter>",
  Confirm: "<enter>",
+ ConfirmInEditor: "<a-enter>",
  Remove: "d",
  New: "n",
  Edit: "e",
@@ -520,7 +521,6 @@ func GetDefaultConfig() *UserConfig {
  DiffingMenuAlt: "<c-e>",
  CopyToClipboard: "<c-o>",
  SubmitEditorText: "<enter>",
- AppendNewline: "<a-enter>",
  ExtrasMenu: "@",
  ToggleWhitespaceInDiffView: "<c-w>",
  IncreaseContextInDiffView: "}",

pkg/gui/context.go

@@ -7,6 +7,7 @@ import (
  "github.com/jesseduffield/generics/slices"
  "github.com/jesseduffield/lazygit/pkg/gui/context"
  "github.com/jesseduffield/lazygit/pkg/gui/types"
+ "github.com/samber/lo"
 )
 
 // This file is for the management of contexts. There is a context stack such that
@@ -164,6 +165,36 @@ func (self *ContextMgr) Pop() error {
  return self.activateContext(newContext, types.OnFocusOpts{})
 }
 
+func (self *ContextMgr) RemoveContexts(contextsToRemove []types.Context) error {
+ self.Lock()
+
+ if len(self.ContextStack) == 1 {
+ self.Unlock()
+ return nil
+ }
+
+ rest := lo.Filter(self.ContextStack, func(context types.Context, _ int) bool {
+ for _, contextToRemove := range contextsToRemove {
+ if context.GetKey() == contextToRemove.GetKey() {
+ return false
+ }
+ }
+ return true
+ })
+ self.ContextStack = rest
+ contextToActivate := rest[len(rest)-1]
+ self.Unlock()
+
+ for _, context := range contextsToRemove {
+ if err := self.deactivateContext(context, types.OnFocusLostOpts{NewContextKey: contextToActivate.GetKey()}); err != nil {
+ return err
+ }
+ }
+
+ // activate the item at the top of the stack
+ return self.activateContext(contextToActivate, types.OnFocusOpts{})
+}
+
 func (self *ContextMgr) deactivateContext(c types.Context, opts types.OnFocusLostOpts) error {
  view, _ := self.gui.c.GocuiGui().View(c.GetViewName())
 

pkg/gui/context/commit_message_context.go

@@ -9,18 +9,45 @@ import (
 )
 
 type CommitMessageContext struct {
- *SimpleContext
  c *ContextCommon
+ types.Context
+ viewModel *CommitMessageViewModel
 }
 
 var _ types.Context = (*CommitMessageContext)(nil)
 
+// when selectedIndex (see below) is set to this value, it means that we're not
+// currently viewing a commit message of an existing commit: instead we're making our own
+// new commit message
+const NoCommitIndex = -1
+
+type CommitMessageViewModel struct {
+ // index of the commit message, where -1 is 'no commit', 0 is the HEAD commit, 1
+ // is the prior commit, and so on
+ selectedindex int
+ // if true, then upon escaping from the commit message panel, we will preserve
+ // the message so that it's still shown next time we open the panel
+ preserveMessage bool
+ // the full preserved message (combined summary and description)
+ preservedMessage string
+ // invoked when pressing enter in the commit message panel
+ onConfirm func(string) error
+
+ // The message typed in before cycling through history
+ // We store this separately to 'preservedMessage' because 'preservedMessage'
+ // is specifically for committing staged files and we don't want this affected
+ // by cycling through history in the context of rewording an old commit.
+ historyMessage string
+}
+
 func NewCommitMessageContext(
  c *ContextCommon,
 ) *CommitMessageContext {
+ viewModel := &CommitMessageViewModel{}
  return &CommitMessageContext{
- c: c,
- SimpleContext: NewSimpleContext(
+ c: c,
+ viewModel: viewModel,
+ Context: NewSimpleContext(
  NewBaseContext(NewBaseContextOpts{
  Kind: types.PERSISTENT_POPUP,
  View: c.Views().CommitMessage,
@@ -33,6 +60,45 @@ func NewCommitMessageContext(
  }
 }
 
+func (self *CommitMessageContext) SetSelectedIndex(value int) {
+ self.viewModel.selectedindex = value
+}
+
+func (self *CommitMessageContext) GetSelectedIndex() int {
+ return self.viewModel.selectedindex
+}
+
+func (self *CommitMessageContext) GetPreserveMessage() bool {
+ return self.viewModel.preserveMessage
+}
+
+func (self *CommitMessageContext) GetPreservedMessage() string {
+ return self.viewModel.preservedMessage
+}
+
+func (self *CommitMessageContext) SetPreservedMessage(message string) {
+ self.viewModel.preservedMessage = message
+}
+
+func (self *CommitMessageContext) GetHistoryMessage() string {
+ return self.viewModel.historyMessage
+}
+
+func (self *CommitMessageContext) SetHistoryMessage(message string) {
+ self.viewModel.historyMessage = message
+}
+
+func (self *CommitMessageContext) OnConfirm(message string) error {
+ return self.viewModel.onConfirm(message)
+}
+
+func (self *CommitMessageContext) SetPanelState(index int, title string, preserveMessage bool, onConfirm func(string) error) {
+ self.viewModel.selectedindex = index
+ self.viewModel.preserveMessage = preserveMessage
+ self.viewModel.onConfirm = onConfirm
+ self.GetView().Title = title
+}
+
 func (self *CommitMessageContext) RenderCommitLength() {
  if !self.c.UserConfig.Gui.CommitLength.Show {
  return