mirror of
https://github.com/jesseduffield/lazygit.git
synced 2025-04-19 17:02:18 +03:00
9d68b287db
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.
125 lines
3.4 KiB
Go
125 lines
3.4 KiB
Go
package controllers
|
|
|
|
import (
|
|
"github.com/jesseduffield/lazygit/pkg/commands/git_commands"
|
|
"github.com/jesseduffield/lazygit/pkg/gui/context"
|
|
"github.com/jesseduffield/lazygit/pkg/gui/types"
|
|
)
|
|
|
|
type CommitMessageController struct {
|
|
baseController
|
|
c *ControllerCommon
|
|
}
|
|
|
|
var _ types.IController = &CommitMessageController{}
|
|
|
|
func NewCommitMessageController(
|
|
common *ControllerCommon,
|
|
) *CommitMessageController {
|
|
return &CommitMessageController{
|
|
baseController: baseController{},
|
|
c: common,
|
|
}
|
|
}
|
|
|
|
// TODO: merge that commit panel PR because we're not currently showing how to add a newline as it's
|
|
// handled by the editor func rather than by the controller here.
|
|
func (self *CommitMessageController) GetKeybindings(opts types.KeybindingsOpts) []*types.Binding {
|
|
bindings := []*types.Binding{
|
|
{
|
|
Key: opts.GetKey(opts.Config.Universal.SubmitEditorText),
|
|
Handler: self.confirm,
|
|
Description: self.c.Tr.LcConfirm,
|
|
},
|
|
{
|
|
Key: opts.GetKey(opts.Config.Universal.Return),
|
|
Handler: self.close,
|
|
Description: self.c.Tr.LcClose,
|
|
},
|
|
{
|
|
Key: opts.GetKey(opts.Config.Universal.PrevItem),
|
|
Handler: self.handlePreviousCommit,
|
|
},
|
|
{
|
|
Key: opts.GetKey(opts.Config.Universal.NextItem),
|
|
Handler: self.handleNextCommit,
|
|
},
|
|
{
|
|
Key: opts.GetKey(opts.Config.Universal.TogglePanel),
|
|
Handler: self.switchToCommitDescription,
|
|
},
|
|
}
|
|
|
|
return bindings
|
|
}
|
|
|
|
func (self *CommitMessageController) GetOnFocusLost() func(types.OnFocusLostOpts) error {
|
|
return func(types.OnFocusLostOpts) error {
|
|
self.context().RenderCommitLength()
|
|
return nil
|
|
}
|
|
}
|
|
|
|
func (self *CommitMessageController) Context() types.Context {
|
|
return self.context()
|
|
}
|
|
|
|
func (self *CommitMessageController) context() *context.CommitMessageContext {
|
|
return self.c.Contexts().CommitMessage
|
|
}
|
|
|
|
func (self *CommitMessageController) handlePreviousCommit() error {
|
|
return self.handleCommitIndexChange(1)
|
|
}
|
|
|
|
func (self *CommitMessageController) handleNextCommit() error {
|
|
if self.context().GetSelectedIndex() == context.NoCommitIndex {
|
|
return nil
|
|
}
|
|
return self.handleCommitIndexChange(-1)
|
|
}
|
|
|
|
func (self *CommitMessageController) switchToCommitDescription() error {
|
|
if err := self.c.PushContext(self.c.Contexts().CommitDescription); err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (self *CommitMessageController) handleCommitIndexChange(value int) error {
|
|
currentIndex := self.context().GetSelectedIndex()
|
|
newIndex := currentIndex + value
|
|
if newIndex == context.NoCommitIndex {
|
|
self.context().SetSelectedIndex(newIndex)
|
|
self.c.Helpers().Commits.SetMessageAndDescriptionInView("")
|
|
return nil
|
|
}
|
|
|
|
validCommit, err := self.setCommitMessageAtIndex(newIndex)
|
|
if validCommit {
|
|
self.context().SetSelectedIndex(newIndex)
|
|
}
|
|
return err
|
|
}
|
|
|
|
// returns true if the given index is for a valid commit
|
|
func (self *CommitMessageController) setCommitMessageAtIndex(index int) (bool, error) {
|
|
commitMessage, err := self.c.Git().Commit.GetCommitMessageFromHistory(index)
|
|
if err != nil {
|
|
if err == git_commands.ErrInvalidCommitIndex {
|
|
return false, nil
|
|
}
|
|
return false, self.c.ErrorMsg(self.c.Tr.CommitWithoutMessageErr)
|
|
}
|
|
self.c.Helpers().Commits.UpdateCommitPanelView(commitMessage)
|
|
return true, nil
|
|
}
|
|
|
|
func (self *CommitMessageController) confirm() error {
|
|
return self.c.Helpers().Commits.HandleCommitConfirm()
|
|
}
|
|
|
|
func (self *CommitMessageController) close() error {
|
|
return self.c.Helpers().Commits.CloseCommitMessagePanel()
|
|
}
|