Add section headers for rebase todos, cherry-picks, reverts, and actual commits

Author: stefanhaller

pkg/gui/context/local_commits_context.go

@@ -1,6 +1,7 @@
 package context
 
 import (
+	"fmt"
 	"log"
 	"strings"
 	"time"
@@ -66,6 +67,51 @@ func NewLocalCommitsContext(c *ContextCommon) *LocalCommitsContext {
 		)
 	}
 
+	getNonModelItems := func() []*NonModelItem {
+		result := []*NonModelItem{}
+		if c.Model().WorkingTreeStateAtLastCommitRefresh.CanShowTodos() {
+			if c.Model().WorkingTreeStateAtLastCommitRefresh.Rebasing {
+				result = append(result, &NonModelItem{
+					Index:   0,
+					Content: fmt.Sprintf("--- %s ---", c.Tr.PendingRebaseTodosSectionHeader),
+				})
+			}
+
+			if c.Model().WorkingTreeStateAtLastCommitRefresh.CherryPicking ||
+				c.Model().WorkingTreeStateAtLastCommitRefresh.Reverting {
+				_, firstCherryPickOrRevertTodo, found := lo.FindIndexOf(
+					c.Model().Commits, func(c *models.Commit) bool {
+						return c.Status == models.StatusCherryPickingOrReverting ||
+							c.Status == models.StatusConflicted
+					})
+				if !found {
+					firstCherryPickOrRevertTodo = 0
+				}
+				label := lo.Ternary(c.Model().WorkingTreeStateAtLastCommitRefresh.CherryPicking,
+					c.Tr.PendingCherryPicksSectionHeader,
+					c.Tr.PendingRevertsSectionHeader)
+				result = append(result, &NonModelItem{
+					Index:   firstCherryPickOrRevertTodo,
+					Content: fmt.Sprintf("--- %s ---", label),
+				})
+			}
+
+			_, firstRealCommit, found := lo.FindIndexOf(
+				c.Model().Commits, func(c *models.Commit) bool {
+					return !c.IsTODO()
+				})
+			if !found {
+				firstRealCommit = 0
+			}
+			result = append(result, &NonModelItem{
+				Index:   firstRealCommit,
+				Content: fmt.Sprintf("--- %s ---", c.Tr.CommitsSectionHeader),
+			})
+		}
+
+		return result
+	}
+
 	ctx := &LocalCommitsContext{
 		LocalCommitsViewModel: viewModel,
 		SearchTrait:           NewSearchTrait(c),
@@ -82,6 +128,7 @@ func NewLocalCommitsContext(c *ContextCommon) *LocalCommitsContext {
 			ListRenderer: ListRenderer{
 				list:              viewModel,
 				getDisplayStrings: getDisplayStrings,
+				getNonModelItems:  getNonModelItems,
 			},
 			c:                       c,
 			refreshViewportOnChange: true,

pkg/i18n/english.go

@@ -350,6 +350,10 @@ type TranslationSet struct {
 	NoRoom                                string
 	YouAreHere                            string
 	ConflictLabel                         string
+	PendingRebaseTodosSectionHeader       string
+	PendingCherryPicksSectionHeader       string
+	PendingRevertsSectionHeader           string
+	CommitsSectionHeader                  string
 	YouDied                               string
 	RewordNotSupported                    string
 	ChangingThisActionIsNotAllowed        string
@@ -1419,6 +1423,10 @@ func EnglishTranslationSet() *TranslationSet {
 		NoRoom:                               "Not enough room",
 		YouAreHere:                           "YOU ARE HERE",
 		ConflictLabel:                        "CONFLICT",
+		PendingRebaseTodosSectionHeader:      "Pending rebase todos",
+		PendingCherryPicksSectionHeader:      "Pending cherry-picks",
+		PendingRevertsSectionHeader:          "Pending reverts",
+		CommitsSectionHeader:                 "Commits",
 		YouDied:                              "YOU DIED!",
 		RewordNotSupported:                   "Rewording commits while interactively rebasing is not currently supported",
 		ChangingThisActionIsNotAllowed:       "Changing this kind of rebase todo entry is not allowed",

pkg/integration/tests/branch/rebase_and_drop.go

@@ -51,19 +51,23 @@ var RebaseAndDrop = NewIntegrationTest(NewIntegrationTestArgs{
 		t.Views().Commits().
 			Focus().
 			TopLines(
+				Contains("--- Pending rebase todos ---"),
 				MatchesRegexp(`pick.*to keep`).IsSelected(),
 				MatchesRegexp(`pick.*to remove`),
 				MatchesRegexp(`pick.*CONFLICT.*first change`),
+				Contains("--- Commits ---"),
 				MatchesRegexp("second-change-branch unrelated change"),
 				MatchesRegexp("second change"),
 				MatchesRegexp("original"),
 			).
 			SelectNextItem().
 			Press(keys.Universal.Remove).
 			TopLines(
+				Contains("--- Pending rebase todos ---"),
 				MatchesRegexp(`pick.*to keep`),
 				MatchesRegexp(`drop.*to remove`).IsSelected(),
 				MatchesRegexp(`pick.*CONFLICT.*first change`),
+				Contains("--- Commits ---"),
 				MatchesRegexp("second-change-branch unrelated change"),
 				MatchesRegexp("second change"),
 				MatchesRegexp("original"),

pkg/integration/tests/cherry_pick/cherry_pick_during_rebase.go

@@ -59,7 +59,9 @@ var CherryPickDuringRebase = NewIntegrationTest(NewIntegrationTestArgs{
 			SelectNextItem().
 			Press(keys.Universal.Edit).
 			Lines(
+				Contains("--- Pending rebase todos ---"),
 				Contains("pick  CI two"),
+				Contains("--- Commits ---"),
 				Contains("      CI <-- YOU ARE HERE --- one").IsSelected(),
 				Contains("      CI base"),
 			).
@@ -74,7 +76,9 @@ var CherryPickDuringRebase = NewIntegrationTest(NewIntegrationTestArgs{
 				t.Views().Information().Content(DoesNotContain("commit copied"))
 			}).
 			Lines(
+				Contains("--- Pending rebase todos ---"),
 				Contains("pick  CI two"),
+				Contains("--- Commits ---"),
 				Contains("      CI <-- YOU ARE HERE --- three"),
 				Contains("      CI one"),
 				Contains("      CI base"),

pkg/integration/tests/commit/amend_when_there_are_conflicts_and_amend.go

@@ -29,8 +29,10 @@ var AmendWhenThereAreConflictsAndAmend = NewIntegrationTest(NewIntegrationTestAr
 		t.Views().Commits().
 			Focus().
 			Lines(
+				Contains("--- Pending rebase todos ---"),
 				Contains("pick").Contains("commit three"),
 				Contains("pick").Contains("<-- CONFLICT --- file1 changed in branch"),
+				Contains("--- Commits ---"),
 				Contains("commit two"),
 				Contains("file1 changed in master"),
 				Contains("base commit"),

pkg/integration/tests/commit/amend_when_there_are_conflicts_and_cancel.go

@@ -33,8 +33,10 @@ var AmendWhenThereAreConflictsAndCancel = NewIntegrationTest(NewIntegrationTestA
 		t.Views().Commits().
 			Focus().
 			Lines(
+				Contains("--- Pending rebase todos ---"),
 				Contains("pick").Contains("commit three"),
 				Contains("pick").Contains("<-- CONFLICT --- file1 changed in branch"),
+				Contains("--- Commits ---"),
 				Contains("commit two"),
 				Contains("file1 changed in master"),
 				Contains("base commit"),

pkg/integration/tests/commit/revert_with_conflict_multiple_commits.go

@@ -44,8 +44,10 @@ var RevertWithConflictMultipleCommits = NewIntegrationTest(NewIntegrationTestArg
 					Confirm()
 			}).
 			Lines(
+				Contains("--- Pending reverts ---"),
 				Contains("revert").Contains("CI unrelated change"),
 				Contains("revert").Contains("CI <-- CONFLICT --- add first line"),
+				Contains("--- Commits ---"),
 				Contains("CI ◯ add second line"),
 				Contains("CI ◯ add first line"),
 				Contains("CI ◯ unrelated change"),

pkg/integration/tests/commit/revert_with_conflict_single_commit.go

@@ -39,7 +39,9 @@ var RevertWithConflictSingleCommit = NewIntegrationTest(NewIntegrationTestArgs{
 					Confirm()
 			}).
 			Lines(
+				Contains("--- Pending reverts ---"),
 				Contains("revert").Contains("CI <-- CONFLICT --- add first line"),
+				Contains("--- Commits ---"),
 				Contains("CI ◯ add second line"),
 				Contains("CI ◯ add first line"),
 				Contains("CI ◯ add empty file"),

pkg/integration/tests/commit/shared.go

@@ -43,8 +43,10 @@ func doTheRebaseForAmendTests(t *TestDriver, keys config.KeybindingConfig) {
 
 	t.Views().Commits().
 		Lines(
+			Contains("--- Pending rebase todos ---"),
 			Contains("pick").Contains("commit three"),
 			Contains("pick").Contains("<-- CONFLICT --- file1 changed in branch"),
+			Contains("--- Commits ---"),
 			Contains("commit two"),
 			Contains("file1 changed in master"),
 			Contains("base commit"),

pkg/integration/tests/interactive_rebase/advanced_interactive_rebase.go

@@ -45,19 +45,25 @@ var AdvancedInteractiveRebase = NewIntegrationTest(NewIntegrationTestArgs{
 		t.Views().Commits().
 			IsFocused().
 			Lines(
+				Contains("--- Pending rebase todos ---"),
 				Contains(TOP_COMMIT),
+				Contains("--- Commits ---"),
 				Contains(BASE_COMMIT).Contains("YOU ARE HERE"),
 			).
 			NavigateToLine(Contains(TOP_COMMIT)).
 			Press(keys.Universal.Edit).
 			Lines(
+				Contains("--- Pending rebase todos ---"),
 				Contains(TOP_COMMIT).Contains("edit"),
+				Contains("--- Commits ---"),
 				Contains(BASE_COMMIT).Contains("YOU ARE HERE"),
 			).
 			Tap(func() {
 				t.Common().ContinueRebase()
 			}).
 			Lines(
+				Contains("--- Pending rebase todos ---"),
+				Contains("--- Commits ---"),
 				Contains(TOP_COMMIT).Contains("YOU ARE HERE"),
 				Contains(BASE_COMMIT),
 			)