Implement "Delete all local branches"

Author: pol-rivero

app/src/lib/stores/app-store.ts

@@ -5535,6 +5535,24 @@ export class AppStore extends TypedBaseStore<IAppState> {
     })
   }
 
+  public async _deleteLocalBranches(
+    repository: Repository,
+    branches: ReadonlyArray<Branch>
+  ): Promise<void> {
+    return this.withRefreshedGitHubRepository(repository, async repository => {
+      const gitStore = this.gitStoreCache.get(repository)
+
+      // Deleting a local branch is fast, so we can do it sequentially
+      for (const branch of branches) {
+        await gitStore.performFailableOperation(() =>
+          deleteLocalBranch(repository, branch.name)
+        )
+      }
+
+      return this._refreshRepository(repository)
+    })
+  }
+
   /**
    * Deletes the local branch. If the parameter `includeUpstream` is true, the
    * upstream branch will be deleted also.

app/src/models/popup.ts

@@ -32,6 +32,7 @@ import { WorktreeEntry } from './worktree'
 export enum PopupType {
   RenameBranch = 'RenameBranch',
   DeleteBranch = 'DeleteBranch',
+  DeleteAllLocalBranches = 'DeleteAllLocalBranches',
   DeleteRemoteBranch = 'DeleteRemoteBranch',
   ConfirmDiscardChanges = 'ConfirmDiscardChanges',
   Preferences = 'Preferences',
@@ -158,6 +159,11 @@ export type PopupDetail =
       branch: Branch
       existsOnRemote: boolean
     }
+  | {
+      type: PopupType.DeleteAllLocalBranches
+      repository: Repository
+      branches: ReadonlyArray<Branch>
+    }
   | {
       type: PopupType.DeleteRemoteBranch
       repository: Repository

app/src/ui/app.tsx

@@ -51,6 +51,7 @@ import {
   CantDeleteCurrentBranch,
   CantDeleteCurrentBranchUncommittedChanges,
   DeleteBranch,
+  DeleteAllLocalBranches,
   DeleteRemoteBranch,
 } from './delete-branch'
 import { CantDeleteMainBranch } from './delete-branch/cant-delete-main-branch'
@@ -1741,6 +1742,17 @@ export class App extends React.Component<IAppProps, IAppState> {
             onDeleted={this.onBranchDeleted}
           />
         )
+      case PopupType.DeleteAllLocalBranches:
+        return (
+          <DeleteAllLocalBranches
+            key="delete-all-local-branches"
+            dispatcher={this.props.dispatcher}
+            repository={popup.repository}
+            branches={popup.branches}
+            onDismissed={onPopupDismissedFn}
+            onDeleted={this.onBranchDeleted}
+          />
+        )
       case PopupType.DeleteRemoteBranch:
         return (
           <DeleteRemoteBranch

app/src/ui/branches/branch-list-item-context-menu.tsx

@@ -12,6 +12,7 @@ interface IBranchContextMenuConfig {
   onViewPullRequestOnGitHub?: () => void
   onSetAsDefaultBranch?: (branchName: string) => void
   onDeleteBranch?: (branchName: string) => void
+  onDeleteAllLocalBranches?: () => void
   onPullSingleBranch?: (branchName: string) => void
   onCheckoutInNewWorktree?: (branch: Branch) => void
 }
@@ -27,6 +28,7 @@ export function generateBranchContextMenuItems(
     onViewPullRequestOnGitHub,
     onSetAsDefaultBranch,
     onDeleteBranch,
+    onDeleteAllLocalBranches,
     onPullSingleBranch,
     onCheckoutInNewWorktree,
   } = config
@@ -92,6 +94,15 @@ export function generateBranchContextMenuItems(
     })
   }
 
+  if (onDeleteAllLocalBranches !== undefined) {
+    items.push({
+      label: __DARWIN__
+        ? 'Delete All Local Branches…'
+        : 'Delete all local branches…',
+      action: () => onDeleteAllLocalBranches(),
+    })
+  }
+
   return items
 }
 

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

@@ -13,6 +13,7 @@ import { TextBox } from '../lib/text-box'
 
 import {
   groupBranches,
+  isLocalOnlyBranch,
   IBranchListItem,
   BranchGroupIdentifier,
 } from './group-branches'
@@ -145,6 +146,13 @@ interface IBranchListProps {
   /** Optional: Callback for if delete context menu should exist */
   readonly onDeleteBranch?: (branchName: string) => void
 
+  /**
+   * Optional: Callback for if the "delete all local branches" context menu
+   * should exist. It is only shown when the right-clicked branch is local-only
+   * and the repository has at least three local-only branches.
+   */
+  readonly onDeleteAllLocalBranches?: () => void
+
   /** Optional: Callback to checkout a branch in a new worktree */
   readonly onCheckoutInNewWorktree?: (branch: Branch) => void
 
@@ -243,6 +251,7 @@ export class BranchList extends React.Component<IBranchListProps> {
     const {
       onRenameBranch,
       onDeleteBranch,
+      onDeleteAllLocalBranches,
       onCheckoutInNewWorktree,
       onSetAsDefaultBranch,
       onPullSingleBranch,
@@ -259,6 +268,15 @@ export class BranchList extends React.Component<IBranchListProps> {
 
     const { branch } = item
 
+    // Only offer "delete all local branches" when right-clicking a local-only
+    // branch and the repository has at least three local-only branches.
+    const localOnlyBranchCount =
+      this.props.allBranches.filter(isLocalOnlyBranch).length
+    const canDeleteAllLocalBranches =
+      onDeleteAllLocalBranches !== undefined &&
+      isLocalOnlyBranch(branch) &&
+      localOnlyBranchCount >= 3
+
     const items = generateBranchContextMenuItems({
       branch,
       repoType: this.props.repository.gitHubRepository?.type,
@@ -268,6 +286,9 @@ export class BranchList extends React.Component<IBranchListProps> {
           ? undefined
           : onSetAsDefaultBranch,
       onDeleteBranch,
+      onDeleteAllLocalBranches: canDeleteAllLocalBranches
+        ? onDeleteAllLocalBranches
+        : undefined,
       onPullSingleBranch,
       onCheckoutInNewWorktree,
     })

app/src/ui/branches/branches-container.tsx

@@ -54,6 +54,7 @@ interface IBranchesContainerProps {
   readonly onRenameBranch: (branchName: string) => void
   readonly onSetAsDefaultBranch: (branchName: string) => void
   readonly onDeleteBranch: (branchName: string) => void
+  readonly onDeleteAllLocalBranches: () => void
   readonly onCheckoutInNewWorktree?: (branch: Branch) => void
 
   /** Optional callback to checkout a PR in a new worktree */
@@ -298,6 +299,7 @@ export class BranchesContainer extends React.Component<
             onRenameBranch={this.props.onRenameBranch}
             onSetAsDefaultBranch={this.props.onSetAsDefaultBranch}
             onDeleteBranch={this.props.onDeleteBranch}
+            onDeleteAllLocalBranches={this.props.onDeleteAllLocalBranches}
             onPullSingleBranch={this.props.onPullSingleBranch}
             onCheckoutInNewWorktree={
               enableWorktreeSupport()

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

@@ -1,4 +1,4 @@
-import { Branch } from '../../models/branch'
+import { Branch, BranchType } from '../../models/branch'
 import { BranchSortOrder } from '../../models/branch-sort-order'
 import { WorktreeEntry } from '../../models/worktree'
 import { IFilterListGroup, IFilterListItem } from '../lib/filter-list'
@@ -13,11 +13,19 @@ export interface IBranchListItem extends IFilterListItem {
   readonly worktreeInUse: WorktreeEntry | null
 }
 
+/**
+ * Whether a branch is local-only, i.e. a local branch that has either never
+ * been published to a remote or whose upstream has since been deleted.
+ */
+export function isLocalOnlyBranch(branch: Branch): boolean {
+  return branch.type === BranchType.Local && (!branch.upstream || branch.isGone)
+}
+
 /**
  * Finds the worktree where a given branch is currently checked out.
  * Returns null if the branch is not checked out in any worktree.
  */
-function findWorktreeForBranch(
+export function findWorktreeForBranch(
   branchName: string,
   worktrees: ReadonlyArray<WorktreeEntry>
 ): WorktreeEntry | null {

app/src/ui/delete-branch/delete-all-local-branches-dialog.tsx

@@ -0,0 +1,84 @@
+import * as React from 'react'
+
+import { Dispatcher } from '../dispatcher'
+import { Repository } from '../../models/repository'
+import { Branch } from '../../models/branch'
+import { Dialog, DialogContent, DialogFooter } from '../dialog'
+import { Ref } from '../lib/ref'
+import { OkCancelButtonGroup } from '../dialog/ok-cancel-button-group'
+
+interface IDeleteAllLocalBranchesProps {
+  readonly dispatcher: Dispatcher
+  readonly repository: Repository
+  readonly branches: ReadonlyArray<Branch>
+  readonly onDismissed: () => void
+  readonly onDeleted: (repository: Repository) => void
+}
+
+interface IDeleteAllLocalBranchesState {
+  readonly isDeleting: boolean
+}
+
+export class DeleteAllLocalBranches extends React.Component<
+  IDeleteAllLocalBranchesProps,
+  IDeleteAllLocalBranchesState
+> {
+  public constructor(props: IDeleteAllLocalBranchesProps) {
+    super(props)
+
+    this.state = {
+      isDeleting: false,
+    }
+  }
+
+  public render() {
+    const count = this.props.branches.length
+
+    return (
+      <Dialog
+        id="delete-all-local-branches"
+        title={
+          __DARWIN__ ? 'Delete All Local Branches' : 'Delete all local branches'
+        }
+        type="warning"
+        onSubmit={this.deleteBranches}
+        onDismissed={this.props.onDismissed}
+        disabled={this.state.isDeleting}
+        loading={this.state.isDeleting}
+        role="alertdialog"
+        ariaDescribedBy="delete-all-local-branches-message"
+      >
+        <DialogContent>
+          <div id="delete-all-local-branches-message">
+            <p>
+              Delete the following {count}{' '}
+              {count === 1 ? 'local branch' : 'local branches'}?
+            </p>
+            <ul className="delete-all-local-branches-list">
+              {this.props.branches.map(branch => (
+                <li key={branch.name}>
+                  <Ref>{branch.name}</Ref>
+                </li>
+              ))}
+            </ul>
+            <p>This action cannot be undone.</p>
+          </div>
+        </DialogContent>
+        <DialogFooter>
+          <OkCancelButtonGroup destructive={true} okButtonText="Delete" />
+        </DialogFooter>
+      </Dialog>
+    )
+  }
+
+  private deleteBranches = async () => {
+    const { dispatcher, repository, branches } = this.props
+
+    this.setState({ isDeleting: true })
+
+    await dispatcher.deleteLocalBranches(repository, branches)
+    this.props.onDeleted(repository)
+
+    this.props.onDismissed()
+  }
+}

app/src/ui/delete-branch/index.ts

@@ -1,4 +1,5 @@
 export { DeleteBranch } from './delete-branch-dialog'
+export { DeleteAllLocalBranches } from './delete-all-local-branches-dialog'
 export { DeleteRemoteBranch } from './delete-remote-branch-dialog'
 export { CantDeleteCurrentBranch } from './cant-delete-current-branch-dialog'
 export { CantDeleteCurrentBranchUncommittedChanges } from './cant-delete-current-branch-uncommitted-changes-dialog'

app/src/ui/dispatcher/dispatcher.ts

@@ -1015,6 +1015,17 @@ export class Dispatcher {
     return this.appStore._deleteBranch(repository, branch, includeUpstream)
   }
 
+  /**
+   * Delete several local branches in one operation. None of the branches may be
+   * currently checked out (in this or any other worktree).
+   */
+  public deleteLocalBranches(
+    repository: Repository,
+    branches: ReadonlyArray<Branch>
+  ): Promise<void> {
+    return this.appStore._deleteLocalBranches(repository, branches)
+  }
+
   /**
    * Delete the remote branch.
    */