Add a commit menu to the commit message panel

And move the "switch to editor" command into this menu. So far this is the only
entry, but we'll add another one in the next commit.

Author: 2KAbhishek

docs/Config.md

@@ -271,7 +271,7 @@ keybinding:
     update: 'u'
     bulkMenu: 'b'
   commitMessage:
-    switchToEditor: '<c-o>'
+    commitMenu: '<c-o>'
   amendAttribute:
     addCoAuthor: 'c'
     resetAuthor: 'a'

pkg/config/user_config.go

@@ -440,7 +440,7 @@ type KeybindingSubmodulesConfig struct {
 }
 
 type KeybindingCommitMessageConfig struct {
-	SwitchToEditor string `yaml:"switchToEditor"`
+	CommitMenu string `yaml:"commitMenu"`
 }
 
 // OSConfig contains config on the level of the os
@@ -829,7 +829,7 @@ func GetDefaultConfig() *UserConfig {
 				BulkMenu: "b",
 			},
 			CommitMessage: KeybindingCommitMessageConfig{
-				SwitchToEditor: "<c-o>",
+				CommitMenu: "<c-o>",
 			},
 		},
 		OS:                           OSConfig{},

pkg/gui/context/commit_message_context.go

@@ -115,8 +115,8 @@ func (self *CommitMessageContext) SetPanelState(
 	subtitleTemplate := lo.Ternary(onSwitchToEditor != nil, self.c.Tr.CommitDescriptionSubTitle, self.c.Tr.CommitDescriptionSubTitleNoSwitch)
 	self.c.Views().CommitDescription.Subtitle = utils.ResolvePlaceholderString(subtitleTemplate,
 		map[string]string{
-			"togglePanelKeyBinding":    keybindings.Label(self.c.UserConfig.Keybinding.Universal.TogglePanel),
-			"switchToEditorKeyBinding": keybindings.Label(self.c.UserConfig.Keybinding.CommitMessage.SwitchToEditor),
+			"togglePanelKeyBinding": keybindings.Label(self.c.UserConfig.Keybinding.Universal.TogglePanel),
+			"commitMenuKeybinding":  keybindings.Label(self.c.UserConfig.Keybinding.CommitMessage.CommitMenu),
 		})
 }
 

pkg/gui/controllers/commit_description_controller.go

@@ -36,8 +36,8 @@ func (self *CommitDescriptionController) GetKeybindings(opts types.KeybindingsOp
 			Handler: self.confirm,
 		},
 		{
-			Key:     opts.GetKey(opts.Config.CommitMessage.SwitchToEditor),
-			Handler: self.switchToEditor,
+			Key:     opts.GetKey(opts.Config.CommitMessage.CommitMenu),
+			Handler: self.openCommitMenu,
 		},
 	}
 
@@ -64,6 +64,7 @@ func (self *CommitDescriptionController) confirm() error {
 	return self.c.Helpers().Commits.HandleCommitConfirm()
 }
 
-func (self *CommitDescriptionController) switchToEditor() error {
-	return self.c.Helpers().Commits.SwitchToEditor()
+func (self *CommitDescriptionController) openCommitMenu() error {
+	authorSuggestion := self.c.Helpers().Suggestions.GetAuthorsSuggestionsFunc()
+	return self.c.Helpers().Commits.OpenCommitMenu(authorSuggestion)
 }

pkg/gui/controllers/commit_message_controller.go

@@ -47,8 +47,8 @@ func (self *CommitMessageController) GetKeybindings(opts types.KeybindingsOpts)
 			Handler: self.switchToCommitDescription,
 		},
 		{
-			Key:     opts.GetKey(opts.Config.CommitMessage.SwitchToEditor),
-			Handler: self.switchToEditor,
+			Key:     opts.GetKey(opts.Config.CommitMessage.CommitMenu),
+			Handler: self.openCommitMenu,
 		},
 	}
 
@@ -88,10 +88,6 @@ func (self *CommitMessageController) switchToCommitDescription() error {
 	return nil
 }
 
-func (self *CommitMessageController) switchToEditor() error {
-	return self.c.Helpers().Commits.SwitchToEditor()
-}
-
 func (self *CommitMessageController) handleCommitIndexChange(value int) error {
 	currentIndex := self.context().GetSelectedIndex()
 	newIndex := currentIndex + value
@@ -130,3 +126,8 @@ func (self *CommitMessageController) confirm() error {
 func (self *CommitMessageController) close() error {
 	return self.c.Helpers().Commits.CloseCommitMessagePanel()
 }
+
+func (self *CommitMessageController) openCommitMenu() error {
+	authorSuggestion := self.c.Helpers().Suggestions.GetAuthorsSuggestionsFunc()
+	return self.c.Helpers().Commits.OpenCommitMenu(authorSuggestion)
+}

pkg/gui/controllers/helpers/commits_helper.go

@@ -191,3 +191,19 @@ func (self *CommitsHelper) commitMessageContexts() []types.Context {
 		self.c.Contexts().CommitMessage,
 	}
 }
+
+func (self *CommitsHelper) OpenCommitMenu(suggestionFunc func(string) []*types.Suggestion) error {
+	menuItems := []*types.MenuItem{
+		{
+			Label: self.c.Tr.OpenInEditor,
+			OnPress: func() error {
+				return self.SwitchToEditor()
+			},
+			Key: 'e',
+		},
+	}
+	return self.c.Menu(types.CreateMenuOptions{
+		Title: self.c.Tr.CommitMenuTitle,
+		Items: menuItems,
+	})
+}

pkg/i18n/english.go

@@ -208,6 +208,7 @@ type TranslationSet struct {
 	SearchTitle                         string
 	TagsTitle                           string
 	MenuTitle                           string
+	CommitMenuTitle                     string
 	RemotesTitle                        string
 	RemoteBranchesTitle                 string
 	PatchBuildingTitle                  string
@@ -1000,12 +1001,13 @@ func EnglishTranslationSet() TranslationSet {
 		RebaseOptionsTitle:                  "Rebase options",
 		CommitSummaryTitle:                  "Commit summary",
 		CommitDescriptionTitle:              "Commit description",
-		CommitDescriptionSubTitle:           "Press {{.togglePanelKeyBinding}} to toggle focus, {{.switchToEditorKeyBinding}} to switch to editor",
+		CommitDescriptionSubTitle:           "Toggle focus {{.togglePanelKeyBinding}}, Open menu {{.commitMenuKeybinding}}",
 		CommitDescriptionSubTitleNoSwitch:   "Press {{.togglePanelKeyBinding}} to toggle focus",
 		LocalBranchesTitle:                  "Local branches",
 		SearchTitle:                         "Search",
 		TagsTitle:                           "Tags",
 		MenuTitle:                           "Menu",
+		CommitMenuTitle:                     "Commit Menu",
 		RemotesTitle:                        "Remotes",
 		RemoteBranchesTitle:                 "Remote branches",
 		PatchBuildingTitle:                  "Main panel (patch building)",

pkg/integration/components/commit_message_panel_driver.go

@@ -74,10 +74,6 @@ func (self *CommitMessagePanelDriver) Cancel() {
 	self.getViewDriver().PressEscape()
 }
 
-func (self *CommitMessagePanelDriver) SwitchToEditor() {
-	self.getViewDriver().Press(self.t.keys.CommitMessage.SwitchToEditor)
-}
-
 func (self *CommitMessagePanelDriver) SelectPreviousMessage() *CommitMessagePanelDriver {
 	self.getViewDriver().SelectPreviousItem()
 	return self
@@ -87,3 +83,8 @@ func (self *CommitMessagePanelDriver) SelectNextMessage() *CommitMessagePanelDri
 	self.getViewDriver().SelectNextItem()
 	return self
 }
+
+func (self *CommitMessagePanelDriver) OpenCommitMenu() *CommitMessagePanelDriver {
+	self.t.press(self.t.keys.CommitMessage.CommitMenu)
+	return self
+}

pkg/integration/tests/commit/commit_switch_to_editor.go

@@ -33,7 +33,8 @@ var CommitSwitchToEditor = NewIntegrationTest(NewIntegrationTestArgs{
 			SwitchToDescription().
 			Type("second line").
 			SwitchToSummary().
-			SwitchToEditor()
+			OpenCommitMenu().
+			Type("e")
 		t.Views().Commits().
 			Lines(
 				Contains("first line"),