Offer to delete worktrees from clean up command (#8653)

* Offer to delete worktrees from clean up command
Fixes #8652

* CCR feedback

Author: alexr00

src/@types/git.d.ts

@@ -76,6 +76,14 @@ export interface Remote {
 	readonly isReadOnly: boolean;
 }
 
+export interface Worktree {
+	readonly name: string;
+	readonly path: string;
+	readonly ref: string;
+	readonly main: boolean;
+	readonly detached: boolean;
+}
+
 export const enum Status {
 	INDEX_MODIFIED,
 	INDEX_ADDED,
@@ -113,11 +121,14 @@ export interface Change {
 	readonly status: Status;
 }
 
+export type RepositoryKind = 'repository' | 'submodule' | 'worktree';
+
 export interface RepositoryState {
 	readonly HEAD: Branch | undefined;
 	readonly refs: Ref[];
 	readonly remotes: Remote[];
 	readonly submodules: Submodule[];
+	readonly worktrees: Worktree[];
 	readonly rebaseCommit: Commit | undefined;
 
 	readonly mergeChanges: Change[];
@@ -287,6 +298,15 @@ export interface Repository {
 	applyStash(index?: number): Promise<void>;
 	popStash(index?: number): Promise<void>;
 	dropStash(index?: number): Promise<void>;
+
+	createWorktree?(options?: { path?: string; commitish?: string; branch?: string }): Promise<string>;
+	deleteWorktree?(path: string, options?: { force?: boolean }): Promise<void>;
+
+	migrateChanges?(sourceRepositoryPath: string, options?: { confirmation?: boolean; deleteFromSource?: boolean; untracked?: boolean }): Promise<void>;
+
+	generateRandomBranchName?(): Promise<string | undefined>;
+
+	isBranchProtected?(branch?: Branch): boolean;
 }
 
 export interface RemoteSource {

src/gitProviders/vslsguest.ts

@@ -6,7 +6,7 @@
 import * as vscode from 'vscode';
 
 import { LiveShare, SharedServiceProxy } from 'vsls/vscode.js';
-import { Branch, Change, Commit, Ref, Remote, RepositoryState, Submodule } from '../@types/git';
+import { Branch, Change, Commit, Ref, Remote, RepositoryState, Submodule, Worktree } from '../@types/git';
 import { IGit, Repository } from '../api/api';
 import { Disposable } from '../common/lifecycle';
 import {
@@ -138,6 +138,7 @@ class LiveShareRepositoryState implements RepositoryState {
 	HEAD: Branch | undefined;
 	remotes: Remote[];
 	submodules: Submodule[] = [];
+	worktrees: Worktree[] = [];
 	rebaseCommit: Commit | undefined;
 	mergeChanges: Change[] = [];
 	indexChanges: Change[] = [];

src/github/folderRepositoryManager.ts

@@ -46,13 +46,15 @@ import {
 	CHAT_SETTINGS_NAMESPACE,
 	CHECKOUT_DEFAULT_BRANCH,
 	CHECKOUT_PULL_REQUEST_BASE_BRANCH,
+	DEFAULT_DELETION_METHOD,
 	DISABLE_AI_FEATURES,
 	GIT,
 	POST_DONE,
 	PR_SETTINGS_NAMESPACE,
 	PULL_BEFORE_CHECKOUT,
 	PULL_BRANCH,
 	REMOTES,
+	SELECT_WORKTREE,
 	UPSTREAM_REMOTE,
 } from '../common/settingKeys';
 import { ITelemetry } from '../common/telemetry';
@@ -2148,35 +2150,89 @@ export class FolderRepositoryManager extends Disposable {
 				quickPick.items = [{ label: vscode.l10n.t('No local branches to delete'), picked: false }];
 			}
 
-			let firstStep = true;
+			let step: 'branches' | 'worktrees' | 'remotes' = 'branches';
+			let nonExistantBranches = new Set<string>();
+			let branchPicks: readonly vscode.QuickPickItem[] = [];
+
+			const showWorktreeStep = (worktreeItems: (vscode.QuickPickItem & { worktreePath: string })[]) => {
+				quickPick.canSelectMany = true;
+				quickPick.value = '';
+				quickPick.placeholder = vscode.l10n.t('Do you want to delete the associated worktrees?');
+				quickPick.items = worktreeItems;
+				quickPick.selectedItems = worktreeItems.filter(item => item.picked);
+				step = 'worktrees';
+			};
+
+			const deleteBranchesAndShowRemoteStep = async () => {
+				if (branchPicks.length) {
+					await vscode.window.withProgress({ location: vscode.ProgressLocation.Notification, title: vscode.l10n.t('Cleaning up') }, async (progress) => {
+						try {
+							await this.deleteBranches(branchPicks, nonExistantBranches, progress, branchPicks.length, 0, []);
+						} catch (e) {
+							quickPick.hide();
+							vscode.window.showErrorMessage(vscode.l10n.t('Deleting branches failed: {0} {1}', e.message, e.stderr));
+						}
+					});
+				}
+
+				const remoteItems = await this.getRemoteDeletionItems(nonExistantBranches);
+				if (remoteItems && remoteItems.length) {
+					quickPick.canSelectMany = true;
+					quickPick.placeholder = vscode.l10n.t('Choose remotes you want to delete permanently');
+					quickPick.items = remoteItems;
+					quickPick.selectedItems = remoteItems.filter(item => item.picked);
+					step = 'remotes';
+				} else {
+					quickPick.hide();
+				}
+			};
+
 			quickPick.onDidAccept(async () => {
 				quickPick.busy = true;
 
-				if (firstStep) {
-					const picks = quickPick.selectedItems;
-					const nonExistantBranches = new Set<string>();
-					if (picks.length) {
-						await vscode.window.withProgress({ location: vscode.ProgressLocation.Notification, title: vscode.l10n.t('Cleaning up') }, async (progress) => {
-							try {
-								await this.deleteBranches(picks, nonExistantBranches, progress, picks.length, 0, []);
-							} catch (e) {
-								quickPick.hide();
-								vscode.window.showErrorMessage(vscode.l10n.t('Deleting branches failed: {0} {1}', e.message, e.stderr));
-							}
-						});
+				if (step === 'branches') {
+					branchPicks = quickPick.selectedItems;
+					nonExistantBranches = new Set<string>();
+
+					// Find which selected branches have worktrees (must be deleted before the branch)
+					const preferredWorktreeDeletion = !!vscode.workspace
+						.getConfiguration(PR_SETTINGS_NAMESPACE)
+						.get<boolean>(`${DEFAULT_DELETION_METHOD}.${SELECT_WORKTREE}`);
+					const worktreeItems: (vscode.QuickPickItem & { worktreePath: string })[] = [];
+					for (const pick of branchPicks) {
+						const worktreeUri = this.getWorktreeForBranch(pick.label);
+						if (worktreeUri && !vscode.workspace.workspaceFolders?.some(folder =>
+							folder.uri.fsPath === worktreeUri.fsPath ||
+							(process.platform === 'win32' && folder.uri.fsPath.toLowerCase() === worktreeUri.fsPath.toLowerCase())
+						)) {
+							worktreeItems.push({
+								label: pick.label,
+								description: worktreeUri.fsPath,
+								picked: preferredWorktreeDeletion,
+								worktreePath: worktreeUri.fsPath,
+							});
+						}
 					}
 
-					firstStep = false;
-					const remoteItems = await this.getRemoteDeletionItems(nonExistantBranches);
-
-					if (remoteItems && remoteItems.length) {
-						quickPick.canSelectMany = true;
-						quickPick.placeholder = vscode.l10n.t('Choose remotes you want to delete permanently');
-						quickPick.items = remoteItems;
-						quickPick.selectedItems = remoteItems.filter(item => item.picked);
+					if (worktreeItems.length && this.repository.deleteWorktree) {
+						showWorktreeStep(worktreeItems);
 					} else {
-						quickPick.hide();
+						await deleteBranchesAndShowRemoteStep();
+					}
+				} else if (step === 'worktrees') {
+					const picks = quickPick.selectedItems as readonly (vscode.QuickPickItem & { worktreePath: string })[];
+					if (picks.length) {
+						await vscode.window.withProgress({ location: vscode.ProgressLocation.Notification, title: vscode.l10n.t('Deleting {0} worktrees...', picks.length) }, async () => {
+							for (const pick of picks) {
+								try {
+									await this.removeWorktree(pick.worktreePath);
+								} catch (e) {
+									Logger.error(`Failed to delete worktree ${pick.worktreePath}: ${e}`, this.id);
+								}
+							}
+						});
 					}
+					await deleteBranchesAndShowRemoteStep();
 				} else {
 					// batch deleting the remotes to avoid consuming all available resources
 					const picks = quickPick.selectedItems;