Better tag creation UX

Previously we used a single-line prompt for a tag annotation. Now we're using the commit message
prompt.

I've had to update other uses of that prompt to allow the summary and description labels to
be passed in

Author: jesseduffield

pkg/cheatsheet/generate.go

@@ -101,7 +101,7 @@ func localisedTitle(tr *i18n.TranslationSet, str string) string {
 		"reflogCommits":     tr.ReflogCommitsTitle,
 		"tags":              tr.TagsTitle,
 		"commitFiles":       tr.CommitFilesTitle,
-		"commitMessage":     tr.CommitMessageTitle,
+		"commitMessage":     tr.CommitSummaryTitle,
 		"commitDescription": tr.CommitDescriptionTitle,
 		"commits":           tr.CommitsTitle,
 		"confirmation":      tr.ConfirmationTitle,

pkg/commands/git_commands/commit.go

@@ -50,13 +50,13 @@ func (self *CommitCommands) ResetToCommit(sha string, strength string, envVars [
 		Run()
 }
 
-func (self *CommitCommands) CommitCmdObj(message string) oscommands.ICmdObj {
-	messageArgs := self.commitMessageArgs(message)
+func (self *CommitCommands) CommitCmdObj(summary string, description string) oscommands.ICmdObj {
+	messageArgs := self.commitMessageArgs(summary, description)
 
 	skipHookPrefix := self.UserConfig.Git.SkipHookPrefix
 
 	cmdArgs := NewGitCmd("commit").
-		ArgIf(skipHookPrefix != "" && strings.HasPrefix(message, skipHookPrefix), "--no-verify").
+		ArgIf(skipHookPrefix != "" && strings.HasPrefix(summary, skipHookPrefix), "--no-verify").
 		ArgIf(self.signoffFlag() != "", self.signoffFlag()).
 		Arg(messageArgs...).
 		ToArgv()
@@ -69,8 +69,8 @@ func (self *CommitCommands) RewordLastCommitInEditorCmdObj() oscommands.ICmdObj
 }
 
 // RewordLastCommit rewords the topmost commit with the given message
-func (self *CommitCommands) RewordLastCommit(message string) error {
-	messageArgs := self.commitMessageArgs(message)
+func (self *CommitCommands) RewordLastCommit(summary string, description string) error {
+	messageArgs := self.commitMessageArgs(summary, description)
 
 	cmdArgs := NewGitCmd("commit").
 		Arg("--allow-empty", "--amend", "--only").
@@ -80,9 +80,8 @@ func (self *CommitCommands) RewordLastCommit(message string) error {
 	return self.cmd.New(cmdArgs).Run()
 }
 
-func (self *CommitCommands) commitMessageArgs(message string) []string {
-	msg, description, _ := strings.Cut(message, "\n")
-	args := []string{"-m", msg}
+func (self *CommitCommands) commitMessageArgs(summary string, description string) []string {
+	args := []string{"-m", summary}
 
 	if description != "" {
 		args = append(args, "-m", description)

pkg/commands/git_commands/commit_test.go

@@ -10,28 +10,31 @@ import (
 
 func TestCommitRewordCommit(t *testing.T) {
 	type scenario struct {
-		testName string
-		runner   *oscommands.FakeCmdObjRunner
-		input    string
+		testName    string
+		runner      *oscommands.FakeCmdObjRunner
+		summary     string
+		description 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",
+			"test",
+			"line 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(s.input))
+			assert.NoError(t, instance.RewordLastCommit(s.summary, s.description))
 			s.runner.CheckForMissingCalls()
 		})
 	}
@@ -50,7 +53,8 @@ func TestCommitResetToCommit(t *testing.T) {
 func TestCommitCommitCmdObj(t *testing.T) {
 	type scenario struct {
 		testName             string
-		message              string
+		summary              string
+		description          string
 		configSignoff        bool
 		configSkipHookPrefix string
 		expectedArgs         []string
@@ -59,35 +63,36 @@ func TestCommitCommitCmdObj(t *testing.T) {
 	scenarios := []scenario{
 		{
 			testName:             "Commit",
-			message:              "test",
+			summary:              "test",
 			configSignoff:        false,
 			configSkipHookPrefix: "",
 			expectedArgs:         []string{"commit", "-m", "test"},
 		},
 		{
 			testName:             "Commit with --no-verify flag",
-			message:              "WIP: test",
+			summary:              "WIP: test",
 			configSignoff:        false,
 			configSkipHookPrefix: "WIP",
 			expectedArgs:         []string{"commit", "--no-verify", "-m", "WIP: test"},
 		},
 		{
 			testName:             "Commit with multiline message",
-			message:              "line1\nline2",
+			summary:              "line1",
+			description:          "line2",
 			configSignoff:        false,
 			configSkipHookPrefix: "",
 			expectedArgs:         []string{"commit", "-m", "line1", "-m", "line2"},
 		},
 		{
 			testName:             "Commit with signoff",
-			message:              "test",
+			summary:              "test",
 			configSignoff:        true,
 			configSkipHookPrefix: "",
 			expectedArgs:         []string{"commit", "--signoff", "-m", "test"},
 		},
 		{
 			testName:             "Commit with signoff and no-verify",
-			message:              "WIP: test",
+			summary:              "WIP: test",
 			configSignoff:        true,
 			configSkipHookPrefix: "WIP",
 			expectedArgs:         []string{"commit", "--no-verify", "--signoff", "-m", "WIP: test"},
@@ -104,7 +109,7 @@ func TestCommitCommitCmdObj(t *testing.T) {
 			runner := oscommands.NewFakeRunner(t).ExpectGitArgs(s.expectedArgs, "", nil)
 			instance := buildCommitCommands(commonDeps{userConfig: userConfig, runner: runner})
 
-			assert.NoError(t, instance.CommitCmdObj(s.message).Run())
+			assert.NoError(t, instance.CommitCmdObj(s.summary, s.description).Run())
 			runner.CheckForMissingCalls()
 		})
 	}

pkg/commands/git_commands/patch.go

@@ -302,7 +302,7 @@ func (self *PatchCommands) PullPatchIntoNewCommit(commits []*models.Commit, comm
 
 	head_message, _ := self.commit.GetHeadCommitMessage()
 	new_message := fmt.Sprintf("Split from \"%s\"", head_message)
-	if err := self.commit.CommitCmdObj(new_message).Run(); err != nil {
+	if err := self.commit.CommitCmdObj(new_message, "").Run(); err != nil {
 		return err
 	}
 

pkg/commands/git_commands/rebase.go

@@ -35,10 +35,10 @@ func NewRebaseCommands(
 	}
 }
 
-func (self *RebaseCommands) RewordCommit(commits []*models.Commit, index int, message string) error {
+func (self *RebaseCommands) RewordCommit(commits []*models.Commit, index int, summary string, description string) error {
 	if models.IsHeadCommit(commits, index) {
 		// we've selected the top commit so no rebase is required
-		return self.commit.RewordLastCommit(message)
+		return self.commit.RewordLastCommit(summary, description)
 	}
 
 	err := self.BeginInteractiveRebaseForCommit(commits, index, false)
@@ -47,7 +47,7 @@ func (self *RebaseCommands) RewordCommit(commits []*models.Commit, index int, me
 	}
 
 	// now the selected commit should be our head so we'll amend it with the new message
-	err = self.commit.RewordLastCommit(message)
+	err = self.commit.RewordLastCommit(summary, description)
 	if err != nil {
 		return err
 	}

pkg/gui/context/commit_message_context.go

@@ -31,7 +31,7 @@ type CommitMessageViewModel struct {
 	// the full preserved message (combined summary and description)
 	preservedMessage string
 	// invoked when pressing enter in the commit message panel
-	onConfirm func(string) error
+	onConfirm func(string, string) error
 
 	// The message typed in before cycling through history
 	// We store this separately to 'preservedMessage' because 'preservedMessage'
@@ -88,15 +88,22 @@ 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) OnConfirm(summary string, description string) error {
+	return self.viewModel.onConfirm(summary, description)
 }
 
-func (self *CommitMessageContext) SetPanelState(index int, title string, preserveMessage bool, onConfirm func(string) error) {
+func (self *CommitMessageContext) SetPanelState(
+	index int,
+	summaryTitle string,
+	descriptionTitle string,
+	preserveMessage bool,
+	onConfirm func(string, string) error,
+) {
 	self.viewModel.selectedindex = index
 	self.viewModel.preserveMessage = preserveMessage
 	self.viewModel.onConfirm = onConfirm
-	self.GetView().Title = title
+	self.GetView().Title = summaryTitle
+	self.c.Views().CommitDescription.Title = descriptionTitle
 }
 
 func (self *CommitMessageContext) RenderCommitLength() {

pkg/gui/controllers.go

@@ -74,7 +74,7 @@ func (gui *Gui) resetHelpersAndControllers() {
 		Suggestions:     suggestionsHelper,
 		Files:           helpers.NewFilesHelper(helperCommon),
 		WorkingTree:     helpers.NewWorkingTreeHelper(helperCommon, refsHelper, commitsHelper, gpgHelper),
-		Tags:            helpers.NewTagsHelper(helperCommon),
+		Tags:            helpers.NewTagsHelper(helperCommon, commitsHelper),
 		GPG:             helpers.NewGpgHelper(helperCommon),
 		MergeAndRebase:  rebaseHelper,
 		MergeConflicts:  mergeConflictsHelper,

pkg/gui/controllers/branches_controller.go

@@ -395,7 +395,7 @@ func (self *BranchesController) fastForward(branch *models.Branch) error {
 }
 
 func (self *BranchesController) createTag(branch *models.Branch) error {
-	return self.c.Helpers().Tags.CreateTagMenu(branch.FullRefName(), func() {})
+	return self.c.Helpers().Tags.OpenCreateTagPrompt(branch.FullRefName(), func() {})
 }
 
 func (self *BranchesController) createResetMenu(selectedBranch *models.Branch) error {

pkg/gui/controllers/helpers/commits_helper.go

@@ -77,19 +77,29 @@ func (self *CommitsHelper) UpdateCommitPanelView(message string) {
 }
 
 type OpenCommitMessagePanelOpts struct {
-	CommitIndex     int
-	Title           string
-	PreserveMessage bool
-	OnConfirm       func(string) error
-	InitialMessage  string
+	CommitIndex      int
+	SummaryTitle     string
+	DescriptionTitle string
+	PreserveMessage  bool
+	OnConfirm        func(summary string, description string) error
+	InitialMessage   string
 }
 
 func (self *CommitsHelper) OpenCommitMessagePanel(opts *OpenCommitMessagePanelOpts) error {
+	onConfirm := func(summary string, description string) error {
+		if err := self.CloseCommitMessagePanel(); err != nil {
+			return err
+		}
+
+		return opts.OnConfirm(summary, description)
+	}
+
 	self.c.Contexts().CommitMessage.SetPanelState(
 		opts.CommitIndex,
-		opts.Title,
+		opts.SummaryTitle,
+		opts.DescriptionTitle,
 		opts.PreserveMessage,
-		opts.OnConfirm,
+		onConfirm,
 	)
 
 	self.UpdateCommitPanelView(opts.InitialMessage)
@@ -102,17 +112,16 @@ func (self *CommitsHelper) OnCommitSuccess() {
 	if self.c.Contexts().CommitMessage.GetPreserveMessage() {
 		self.c.Contexts().CommitMessage.SetPreservedMessage("")
 	}
-	self.SetMessageAndDescriptionInView("")
 }
 
 func (self *CommitsHelper) HandleCommitConfirm() error {
-	fullMessage := self.JoinCommitMessageAndDescription()
+	summary, description := self.getCommitSummary(), self.getCommitDescription()
 
-	if fullMessage == "" {
+	if summary == "" {
 		return self.c.ErrorMsg(self.c.Tr.CommitWithoutMessageErr)
 	}
 
-	err := self.c.Contexts().CommitMessage.OnConfirm(fullMessage)
+	err := self.c.Contexts().CommitMessage.OnConfirm(summary, description)
 	if err != nil {
 		return err
 	}