Add worktree deletion support when deleting PR branches

- Add SELECT_WORKTREE constant in settingKeys.ts
- Add githubPullRequests.defaultDeletionMethod.selectWorktree setting in package.json
- Add NLS description in package.nls.json
- Add getWorktreeForBranch() and removeWorktree() methods to FolderRepositoryManager
- Add worktree option to SelectedAction type and quick pick dropdown
- Add worktree deletion to auto-delete flow (autoDeleteBranchesAfterMerge)
- Ensure worktree removal happens before branch deletion in performBranchDeletion

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

Author: Copilot

package.json

@@ -309,6 +309,11 @@
 					"default": true,
 					"description": "%githubPullRequests.defaultDeletionMethod.selectRemote.description%"
 				},
+				"githubPullRequests.defaultDeletionMethod.selectWorktree": {
+					"type": "boolean",
+					"default": false,
+					"description": "%githubPullRequests.defaultDeletionMethod.selectWorktree.description%"
+				},
 				"githubPullRequests.deleteBranchAfterMerge": {
 					"type": "boolean",
 					"default": false,

package.nls.json

@@ -44,6 +44,7 @@
 	"githubPullRequests.fileAutoReveal.description": "Automatically reveal open files in the pull request changes tree.",
 	"githubPullRequests.defaultDeletionMethod.selectLocalBranch.description": "When true, the option to delete the local branch will be selected by default when deleting a branch from a pull request.",
 	"githubPullRequests.defaultDeletionMethod.selectRemote.description": "When true, the option to delete the remote will be selected by default when deleting a branch from a pull request.",
+	"githubPullRequests.defaultDeletionMethod.selectWorktree.description": "When true, the option to remove the associated worktree will be selected by default when deleting a branch from a pull request.",
 	"githubPullRequests.deleteBranchAfterMerge.description": "Automatically delete the branch after merging a pull request. This setting only applies when the pull request is merged through this extension. When using merge queues, this will only delete the local branch.",
 	"githubPullRequests.terminalLinksHandler.description": "Default handler for terminal links.",
 	"githubPullRequests.terminalLinksHandler.github": "Create the pull request on GitHub.",

src/common/settingKeys.ts

@@ -36,6 +36,7 @@ export const DEFAULT_MERGE_METHOD = 'defaultMergeMethod';
 export const DEFAULT_DELETION_METHOD = 'defaultDeletionMethod';
 export const SELECT_LOCAL_BRANCH = 'selectLocalBranch';
 export const SELECT_REMOTE = 'selectRemote';
+export const SELECT_WORKTREE = 'selectWorktree';
 export const DELETE_BRANCH_AFTER_MERGE = 'deleteBranchAfterMerge';
 export const REMOTES = 'remotes';
 export const PULL_PR_BRANCH_BEFORE_CHECKOUT = 'pullPullRequestBranchBeforeCheckout';

src/github/folderRepositoryManager.ts

@@ -2450,6 +2450,57 @@ export class FolderRepositoryManager extends Disposable {
 		return await PullRequestGitHelper.getBranchNRemoteForPullRequest(this.repository, pullRequest);
 	}
 
+	async getWorktreeForBranch(branchName: string): Promise<string | undefined> {
+		try {
+			const { execFile } = await import('child_process');
+			const { promisify } = await import('util');
+			const execFileAsync = promisify(execFile);
+			const gitPath = vscode.workspace.getConfiguration('git').get<string>('path') || 'git';
+			const { stdout } = await execFileAsync(gitPath, ['worktree', 'list', '--porcelain'], {
+				cwd: this.repository.rootUri.fsPath,
+			});
+
+			const worktrees = stdout.split('\n\n');
+			for (const entry of worktrees) {
+				const lines = entry.trim().split('\n');
+				let worktreePath: string | undefined;
+				let branch: string | undefined;
+				for (const line of lines) {
+					if (line.startsWith('worktree ')) {
+						worktreePath = line.substring('worktree '.length);
+					} else if (line.startsWith('branch ')) {
+						branch = line.substring('branch '.length);
+						// branch line is like "branch refs/heads/branchName"
+						const prefix = 'refs/heads/';
+						if (branch.startsWith(prefix)) {
+							branch = branch.substring(prefix.length);
+						}
+					}
+				}
+				if (branch === branchName && worktreePath) {
+					// Don't return the main worktree (the repository root itself)
+					const repoRoot = this.repository.rootUri.fsPath;
+					if (nodePath.resolve(worktreePath) !== nodePath.resolve(repoRoot)) {
+						return worktreePath;
+					}
+				}
+			}
+		} catch (e) {
+			Logger.error(`Failed to get worktree for branch ${branchName}: ${e}`, this.id);
+		}
+		return undefined;
+	}
+
+	async removeWorktree(worktreePath: string): Promise<void> {
+		const { execFile } = await import('child_process');
+		const { promisify } = await import('util');
+		const execFileAsync = promisify(execFile);
+		const gitPath = vscode.workspace.getConfiguration('git').get<string>('path') || 'git';
+		await execFileAsync(gitPath, ['worktree', 'remove', worktreePath], {
+			cwd: this.repository.rootUri.fsPath,
+		});
+	}
+
 	async fetchAndCheckout(pullRequest: PullRequestModel, progress: vscode.Progress<{ message?: string; increment?: number }>): Promise<void> {
 		await PullRequestGitHelper.fetchAndCheckout(this.repository, this._allGitHubRemotes, pullRequest, progress);
 	}

src/github/pullRequestReviewCommon.ts

@@ -10,7 +10,7 @@ import { IAccount, isITeam, ITeam, MergeMethod, PullRequestMergeability, reviewe
 import { BranchInfo } from './pullRequestGitHelper';
 import { PullRequestModel } from './pullRequestModel';
 import { ConvertToDraftReply, PullRequest, ReadyForReviewReply, ReviewType, SubmitReviewReply } from './views';
-import { DEFAULT_DELETION_METHOD, PR_SETTINGS_NAMESPACE, SELECT_LOCAL_BRANCH, SELECT_REMOTE } from '../common/settingKeys';
+import { DEFAULT_DELETION_METHOD, PR_SETTINGS_NAMESPACE, SELECT_LOCAL_BRANCH, SELECT_REMOTE, SELECT_WORKTREE } from '../common/settingKeys';
 import { ReviewEvent, TimelineEvent } from '../common/timelineEvent';
 import { Schemes } from '../common/uri';
 import { formatError } from '../common/utils';
@@ -289,7 +289,8 @@ export namespace PullRequestReviewCommon {
 	}
 
 	interface SelectedAction {
-		type: 'remoteHead' | 'local' | 'remote' | 'suspend'
+		type: 'remoteHead' | 'local' | 'remote' | 'suspend' | 'worktree'
+		worktreePath?: string;
 	};
 
 	export async function deleteBranch(folderRepositoryManager: FolderRepositoryManager, item: PullRequestModel): Promise<{ isReply: boolean, message: any }> {
@@ -333,6 +334,19 @@ export namespace PullRequestReviewCommon {
 					picked: !!preferredRemoteDeletionMethod,
 				});
 			}
+
+			const worktreePath = await folderRepositoryManager.getWorktreeForBranch(branchInfo.branch);
+			if (worktreePath) {
+				const preferredWorktreeDeletion = vscode.workspace
+					.getConfiguration(PR_SETTINGS_NAMESPACE)
+					.get<boolean>(`${DEFAULT_DELETION_METHOD}.${SELECT_WORKTREE}`);
+				actions.push({
+					label: vscode.l10n.t('Remove worktree {0}', worktreePath),
+					type: 'worktree',
+					worktreePath,
+					picked: !!preferredWorktreeDeletion,
+				});
+			}
 		}
 
 		if (vscode.env.remoteName === 'codespaces') {
@@ -384,7 +398,16 @@ export namespace PullRequestReviewCommon {
 		const isBranchActive = item.equals(folderRepositoryManager.activePullRequest) || (folderRepositoryManager.repository.state.HEAD?.name && folderRepositoryManager.repository.state.HEAD.name === branchInfo?.branch);
 		const deletedBranchTypes: string[] = [];
 
-		const promises = selectedActions.map(async action => {
+		// Remove worktree first, before deleting the branch, since a branch checked out
+		// in a worktree cannot be deleted.
+		const worktreeAction = selectedActions.find(a => a.type === 'worktree');
+		if (worktreeAction?.worktreePath) {
+			await folderRepositoryManager.removeWorktree(worktreeAction.worktreePath);
+			deletedBranchTypes.push(worktreeAction.type);
+		}
+
+		const remainingActions = selectedActions.filter(a => a.type !== 'worktree');
+		const promises = remainingActions.map(async action => {
 			switch (action.type) {
 				case 'remoteHead':
 					await folderRepositoryManager.deleteBranch(item);
@@ -497,6 +520,17 @@ export namespace PullRequestReviewCommon {
 			selectedActions.push({ type: 'remote' });
 		}
 
+		// Remove worktree if preference is set
+		const deleteWorktree = vscode.workspace
+			.getConfiguration(PR_SETTINGS_NAMESPACE)
+			.get<boolean>(`${DEFAULT_DELETION_METHOD}.${SELECT_WORKTREE}`, false);
+		if (branchInfo && deleteWorktree) {
+			const worktreePath = await folderRepositoryManager.getWorktreeForBranch(branchInfo.branch);
+			if (worktreePath) {
+				selectedActions.push({ type: 'worktree', worktreePath });
+			}
+		}
+
 		// Execute all deletions in parallel
 		const deletedBranchTypes = await performBranchDeletion(folderRepositoryManager, item, defaultBranch, branchInfo!, selectedActions);