Add worktree removal option when deleting PR branches (#8559)

* Initial plan

* Initial plan for worktree deletion support

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

* 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>

* Address code review: static imports, error handling, documentation

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

* Fix webworker build: move child_process usage to env/node module

Move git worktree operations (child_process/util) into dedicated
env/node/gitWorktree.ts and env/browser/gitWorktree.ts modules,
following the existing env pattern. The webpack alias ensures the
browser/no-op version is used for the webworker target.

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

* Update git API

* refactor: use git API for worktree operations instead of child_process

- Use repository.state.worktrees to find worktrees for a branch
- Use repository.deleteWorktree() to remove worktrees
- Add Worktree interface to api.d.ts
- Remove env/node/gitWorktree.ts and env/browser/gitWorktree.ts
- Remove webpack alias for gitWorktree

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

* Skip worktree deletion when worktree is a workspace folder

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

* Hide worktree delete option when worktree is a workspace folder

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

* Use isDescendant for cross-platform path comparison in worktree workspace check

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

* Remove unused top-level isWorktreeInWorkspace function to fix lint error

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

* Use case-insensitive path comparison for isWorktreeInWorkspace on Windows

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

* Fix worktree/workspace path compare

* Fix error

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
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/api/api.d.ts

@@ -218,6 +218,9 @@ export interface Repository {
 	add(paths: string[]): Promise<void>;
 	merge(ref: string): Promise<void>;
 	mergeAbort(): Promise<void>;
+
+	createWorktree?(options?: { path?: string; commitish?: string; branch?: string }): Promise<string>;
+	deleteWorktree?(path: string, options?: { force?: boolean }): Promise<void>;
 }
 
 /**

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,35 @@ export class FolderRepositoryManager extends Disposable {
 		return await PullRequestGitHelper.getBranchNRemoteForPullRequest(this.repository, pullRequest);
 	}
 
+	getWorktreeForBranch(branchName: string): vscode.Uri | undefined {
+		const worktrees = this.repository.state.worktrees;
+		if (!worktrees) {
+			return undefined;
+		}
+		const refsHeadsPrefix = 'refs/heads/';
+		const worktree = worktrees.find(wt => {
+			if (wt.main) {
+				return false;
+			}
+			const ref = wt.ref.startsWith(refsHeadsPrefix) ? wt.ref.substring(refsHeadsPrefix.length) : wt.ref;
+			return ref === branchName;
+		});
+		return worktree ? vscode.Uri.file(worktree.path) : undefined;
+	}
+
+	async removeWorktree(worktreePath: string): Promise<void> {
+		if (!this.repository.deleteWorktree) {
+			Logger.error(`deleteWorktree is not available on this repository`, this.id);
+			return;
+		}
+		try {
+			await this.repository.deleteWorktree(worktreePath);
+		} catch (e) {
+			Logger.error(`Failed to remove worktree ${worktreePath}: ${e}`, this.id);
+			throw e;
+		}
+	}
+
 	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,9 +289,20 @@ export namespace PullRequestReviewCommon {
 	}
 
 	interface SelectedAction {
-		type: 'remoteHead' | 'local' | 'remote' | 'suspend'
+		type: 'remoteHead' | 'local' | 'remote' | 'suspend' | 'worktree'
+		/** Path to the worktree directory to remove. Only used when type is 'worktree'. */
+		worktreePath?: string;
 	};
 
+	function isWorktreeInWorkspace(worktreePath: vscode.Uri): boolean {
+		const worktreeFsPath = worktreePath.fsPath;
+		return !!vscode.workspace.workspaceFolders?.some(folder => {
+			const folderPath = folder.uri.fsPath;
+			return folderPath === worktreeFsPath ||
+				(process.platform === 'win32' && folderPath.toLowerCase() === worktreeFsPath.toLowerCase());
+		});
+	}
+
 	export async function deleteBranch(folderRepositoryManager: FolderRepositoryManager, item: PullRequestModel): Promise<{ isReply: boolean, message: any }> {
 		const branchInfo = await folderRepositoryManager.getBranchNameForPullRequest(item);
 		const actions: (vscode.QuickPickItem & SelectedAction)[] = [];
@@ -333,6 +344,19 @@ export namespace PullRequestReviewCommon {
 					picked: !!preferredRemoteDeletionMethod,
 				});
 			}
+
+			const worktreePath = folderRepositoryManager.getWorktreeForBranch(branchInfo.branch);
+			if (worktreePath && !isWorktreeInWorkspace(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.fsPath),
+					type: 'worktree',
+					worktreePath: worktreePath.fsPath,
+					picked: !!preferredWorktreeDeletion,
+				});
+			}
 		}
 
 		if (vscode.env.remoteName === 'codespaces') {
@@ -384,7 +408,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 +530,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 = folderRepositoryManager.getWorktreeForBranch(branchInfo.branch);
+			if (worktreePath && !isWorktreeInWorkspace(worktreePath)) {
+				selectedActions.push({ type: 'worktree', worktreePath: worktreePath.fsPath });
+			}
+		}
+
 		// Execute all deletions in parallel
 		const deletedBranchTypes = await performBranchDeletion(folderRepositoryManager, item, defaultBranch, branchInfo!, selectedActions);