Add a sort order menu for local branches

pkg/commands/git_commands/branch_loader.go

@@ -3,6 +3,7 @@ package git_commands
 import (
 	"fmt"
 	"regexp"
+	"strconv"
 	"strings"
 
 	"github.com/jesseduffield/generics/set"
@@ -62,33 +63,34 @@ func NewBranchLoader(
 func (self *BranchLoader) Load(reflogCommits []*models.Commit) ([]*models.Branch, error) {
 	branches := self.obtainBranches()
 
-	reflogBranches := self.obtainReflogBranches(reflogCommits)
-
-	// loop through reflog branches. If there is a match, merge them, then remove it from the branches and keep it in the reflog branches
-	branchesWithRecency := make([]*models.Branch, 0)
-outer:
-	for _, reflogBranch := range reflogBranches {
-		for j, branch := range branches {
-			if branch.Head {
-				continue
-			}
-			if strings.EqualFold(reflogBranch.Name, branch.Name) {
-				branch.Recency = reflogBranch.Recency
-				branchesWithRecency = append(branchesWithRecency, branch)
-				branches = utils.Remove(branches, j)
-				continue outer
+	if self.AppState.LocalBranchSortOrder == "recency" {
+		reflogBranches := self.obtainReflogBranches(reflogCommits)
+		// loop through reflog branches. If there is a match, merge them, then remove it from the branches and keep it in the reflog branches
+		branchesWithRecency := make([]*models.Branch, 0)
+	outer:
+		for _, reflogBranch := range reflogBranches {
+			for j, branch := range branches {
+				if branch.Head {
+					continue
+				}
+				if strings.EqualFold(reflogBranch.Name, branch.Name) {
+					branch.Recency = reflogBranch.Recency
+					branchesWithRecency = append(branchesWithRecency, branch)
+					branches = utils.Remove(branches, j)
+					continue outer
+				}
 			}
 		}
+
+		// Sort branches that don't have a recency value alphabetically
+		// (we're really doing this for the sake of deterministic behaviour across git versions)
+		slices.SortFunc(branches, func(a *models.Branch, b *models.Branch) bool {
+			return a.Name < b.Name
+		})
+
+		branches = utils.Prepend(branches, branchesWithRecency...)
 	}
 
-	// Sort branches that don't have a recency value alphabetically
-	// (we're really doing this for the sake of deterministic behaviour across git versions)
-	slices.SortFunc(branches, func(a *models.Branch, b *models.Branch) bool {
-		return a.Name < b.Name
-	})
-
-	branches = utils.Prepend(branches, branchesWithRecency...)
-
 	foundHead := false
 	for i, branch := range branches {
 		if branch.Head {
@@ -144,7 +146,8 @@ func (self *BranchLoader) obtainBranches() []*models.Branch {
 			return nil, false
 		}
 
-		return obtainBranch(split), true
+		storeCommitDateAsRecency := self.AppState.LocalBranchSortOrder != "recency"
+		return obtainBranch(split, storeCommitDateAsRecency), true
 	})
 }
 
@@ -156,8 +159,18 @@ func (self *BranchLoader) getRawBranches() (string, error) {
 		"%00",
 	)
 
+	var sortOrder string
+	switch strings.ToLower(self.AppState.LocalBranchSortOrder) {
+	case "recency", "date":
+		sortOrder = "-committerdate"
+	case "alphabetical":
+		sortOrder = "refname"
+	default:
+		sortOrder = "refname"
+	}
+
 	cmdArgs := NewGitCmd("for-each-ref").
-		Arg("--sort=-committerdate").
+		Arg(fmt.Sprintf("--sort=%s", sortOrder)).
 		Arg(fmt.Sprintf("--format=%s", format)).
 		Arg("refs/heads").
 		ToArgv()
@@ -172,22 +185,32 @@ var branchFields = []string{
 	"upstream:track",
 	"subject",
 	"objectname",
+	"committerdate:unix",
 }
 
 // Obtain branch information from parsed line output of getRawBranches()
-func obtainBranch(split []string) *models.Branch {
+func obtainBranch(split []string, storeCommitDateAsRecency bool) *models.Branch {
 	headMarker := split[0]
 	fullName := split[1]
 	upstreamName := split[2]
 	track := split[3]
 	subject := split[4]
 	commitHash := split[5]
+	commitDate := split[6]
 
 	name := strings.TrimPrefix(fullName, "heads/")
 	pushables, pullables, gone := parseUpstreamInfo(upstreamName, track)
 
+	recency := ""
+	if storeCommitDateAsRecency {
+		if unixTimestamp, err := strconv.ParseInt(commitDate, 10, 64); err == nil {
+			recency = utils.UnixToTimeAgo(unixTimestamp)
+		}
+	}
+
 	return &models.Branch{
 		Name:         name,
+		Recency:      recency,
 		Pushables:    pushables,
 		Pullables:    pullables,
 		UpstreamGone: gone,

pkg/commands/git_commands/branch_loader_test.go

@@ -2,7 +2,9 @@ package git_commands
 
 // "*|feat/detect-purge|origin/feat/detect-purge|[ahead 1]"
 import (
+	"strconv"
 	"testing"
+	"time"
 
 	"github.com/jesseduffield/lazygit/pkg/commands/models"
 	"github.com/stretchr/testify/assert"
@@ -10,15 +12,21 @@ import (
 
 func TestObtainBranch(t *testing.T) {
 	type scenario struct {
-		testName       string
-		input          []string
-		expectedBranch *models.Branch
+		testName                 string
+		input                    []string
+		storeCommitDateAsRecency bool
+		expectedBranch           *models.Branch
 	}
 
+	// Use a time stamp of 2 1/2 hours ago, resulting in a recency string of "2h"
+	now := time.Now().Unix()
+	timeStamp := strconv.Itoa(int(now - 2.5*60*60))
+
 	scenarios := []scenario{
 		{
-			testName: "TrimHeads",
-			input:    []string{"", "heads/a_branch", "", "", "subject", "123"},
+			testName:                 "TrimHeads",
+			input:                    []string{"", "heads/a_branch", "", "", "subject", "123", timeStamp},
+			storeCommitDateAsRecency: false,
 			expectedBranch: &models.Branch{
 				Name:       "a_branch",
 				Pushables:  "?",
@@ -29,8 +37,9 @@ func TestObtainBranch(t *testing.T) {
 			},
 		},
 		{
-			testName: "NoUpstream",
-			input:    []string{"", "a_branch", "", "", "subject", "123"},
+			testName:                 "NoUpstream",
+			input:                    []string{"", "a_branch", "", "", "subject", "123", timeStamp},
+			storeCommitDateAsRecency: false,
 			expectedBranch: &models.Branch{
 				Name:       "a_branch",
 				Pushables:  "?",
@@ -41,8 +50,9 @@ func TestObtainBranch(t *testing.T) {
 			},
 		},
 		{
-			testName: "IsHead",
-			input:    []string{"*", "a_branch", "", "", "subject", "123"},
+			testName:                 "IsHead",
+			input:                    []string{"*", "a_branch", "", "", "subject", "123", timeStamp},
+			storeCommitDateAsRecency: false,
 			expectedBranch: &models.Branch{
 				Name:       "a_branch",
 				Pushables:  "?",
@@ -53,8 +63,9 @@ func TestObtainBranch(t *testing.T) {
 			},
 		},
 		{
-			testName: "IsBehindAndAhead",
-			input:    []string{"", "a_branch", "a_remote/a_branch", "[behind 2, ahead 3]", "subject", "123"},
+			testName:                 "IsBehindAndAhead",
+			input:                    []string{"", "a_branch", "a_remote/a_branch", "[behind 2, ahead 3]", "subject", "123", timeStamp},
+			storeCommitDateAsRecency: false,
 			expectedBranch: &models.Branch{
 				Name:       "a_branch",
 				Pushables:  "3",
@@ -65,8 +76,9 @@ func TestObtainBranch(t *testing.T) {
 			},
 		},
 		{
-			testName: "RemoteBranchIsGone",
-			input:    []string{"", "a_branch", "a_remote/a_branch", "[gone]", "subject", "123"},
+			testName:                 "RemoteBranchIsGone",
+			input:                    []string{"", "a_branch", "a_remote/a_branch", "[gone]", "subject", "123", timeStamp},
+			storeCommitDateAsRecency: false,
 			expectedBranch: &models.Branch{
 				Name:         "a_branch",
 				UpstreamGone: true,
@@ -77,11 +89,25 @@ func TestObtainBranch(t *testing.T) {
 				CommitHash:   "123",
 			},
 		},
+		{
+			testName:                 "WithCommitDateAsRecency",
+			input:                    []string{"", "a_branch", "", "", "subject", "123", timeStamp},
+			storeCommitDateAsRecency: true,
+			expectedBranch: &models.Branch{
+				Name:       "a_branch",
+				Recency:    "2h",
+				Pushables:  "?",
+				Pullables:  "?",
+				Head:       false,
+				Subject:    "subject",
+				CommitHash: "123",
+			},
+		},
 	}
 
 	for _, s := range scenarios {
 		t.Run(s.testName, func(t *testing.T) {
-			branch := obtainBranch(s.input)
+			branch := obtainBranch(s.input, s.storeCommitDateAsRecency)
 			assert.EqualValues(t, s.expectedBranch, branch)
 		})
 	}