Sort branches by date

Use the newly added author date to implement alternative sortings.
TODO: Add sort settings page and update groups() in branch-list.tsx to use the selected sort instead of hardcoding BranchSortOrder.LastModified.

Author: pol-rivero

app/src/models/branch-sort-order.ts

@@ -0,0 +1,6 @@
+export enum BranchSortOrder {
+  Alphabetical = 'Alphabetical',
+  LastModified = 'LastModified',
+}
+
+export const DEFAULT_BRANCH_SORT_ORDER = BranchSortOrder.LastModified

app/src/ui/branches/branch-list.tsx

@@ -26,6 +26,7 @@ import * as octicons from '../octicons/octicons.generated'
 import memoizeOne from 'memoize-one'
 import { Repository } from '../../models/repository'
 import { formatDate } from '../../lib/format-date'
+import { BranchSortOrder } from '../../models/branch-sort-order'
 
 const RowHeight = 30
 
@@ -175,10 +176,10 @@ export class BranchList extends React.Component<IBranchListProps> {
   private get groups() {
     return this.getGroups(
       this.props.defaultBranch,
-      this.props.currentBranch,
       this.props.allBranches,
       this.props.recentBranches,
-      this.props.allWorktrees
+      this.props.allWorktrees,
+      BranchSortOrder.LastModified
     )
   }
 

app/src/ui/branches/group-branches.ts

@@ -1,4 +1,5 @@
 import { Branch } from '../../models/branch'
+import { BranchSortOrder } from '../../models/branch-sort-order'
 import { WorktreeEntry } from '../../models/worktree'
 import { IFilterListGroup, IFilterListItem } from '../lib/filter-list'
 
@@ -35,10 +36,10 @@ function findWorktreeForBranch(
 
 export function groupBranches(
   defaultBranch: Branch | null,
-  currentBranch: Branch | null,
   allBranches: ReadonlyArray<Branch>,
   recentBranches: ReadonlyArray<Branch>,
-  allWorktrees: ReadonlyArray<WorktreeEntry>
+  allWorktrees: ReadonlyArray<WorktreeEntry>,
+  sortOrder: BranchSortOrder
 ): ReadonlyArray<IFilterListGroup<IBranchListItem>> {
   const groups = new Array<IFilterListGroup<IBranchListItem>>()
 
@@ -91,8 +92,13 @@ export function groupBranches(
       !recentBranchNames.has(b.name) &&
       !b.isDesktopForkRemoteBranch
   )
+  const branchComparer = getBranchComparer(sortOrder)
+  const sortedRemainingBranches = remainingBranches.sort((a, b) =>
+    // Local branches are always sorted above remote branches, regardless of the sort order
+    a.type === b.type ? branchComparer(a, b) : a.type - b.type
+  )
 
-  const remainingItems = remainingBranches.map(b => {
+  const remainingItems = sortedRemainingBranches.map(b => {
     const worktreeInUse = findWorktreeForBranch(b.name, allWorktrees)
     return {
       text: [b.name],
@@ -108,3 +114,14 @@ export function groupBranches(
 
   return groups
 }
+
+function getBranchComparer(
+  sortOrder: BranchSortOrder
+): (a: Branch, b: Branch) => number {
+  switch (sortOrder) {
+    case BranchSortOrder.Alphabetical:
+      return (a, b) => a.name.localeCompare(b.name)
+    case BranchSortOrder.LastModified:
+      return (a, b) => b.tip.author.date.getTime() - a.tip.author.date.getTime()
+  }
+}

app/test/unit/group-branches-test.ts

@@ -3,6 +3,7 @@ import assert from 'node:assert'
 import { groupBranches } from '../../src/ui/branches'
 import { Branch, BranchType } from '../../src/models/branch'
 import { CommitIdentity } from '../../src/models/commit-identity'
+import { BranchSortOrder } from '../../src/models/branch-sort-order'
 
 describe('Branches grouping', () => {
   const author = new CommitIdentity('Hubot', 'hubot@github.com', new Date())
@@ -52,10 +53,10 @@ describe('Branches grouping', () => {
   it('should group branches', () => {
     const groups = groupBranches(
       defaultBranch,
-      currentBranch,
       allBranches,
       recentBranches,
-      []
+      [],
+      BranchSortOrder.Alphabetical
     )
     assert.equal(groups.length, 3)