feat: add checkout pull request in worktree option

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

Author: Copilot

package.json

@@ -988,6 +988,12 @@
 				"category": "%command.pull.request.category%",
 				"icon": "$(cloud)"
 			},
+			{
+				"command": "pr.pickInWorktree",
+				"title": "%command.pr.pickInWorktree.title%",
+				"category": "%command.pull.request.category%",
+				"icon": "$(folder-library)"
+			},
 			{
 				"command": "pr.exit",
 				"title": "%command.pr.exit.title%",
@@ -2059,6 +2065,10 @@
 					"command": "pr.pickOnCodespaces",
 					"when": "false"
 				},
+				{
+					"command": "pr.pickInWorktree",
+					"when": "false"
+				},
 				{
 					"command": "pr.exit",
 					"when": "github:inReviewMode"
@@ -2857,6 +2867,11 @@
 					"when": "view == pr:github && viewItem =~ /pullrequest(:local)?:nonactive/ && (!isWeb || remoteName != codespaces && virtualWorkspace != vscode-vfs)",
 					"group": "1_pullrequest@3"
 				},
+				{
+					"command": "pr.pickInWorktree",
+					"when": "view == pr:github && viewItem =~ /pullrequest(:local)?:nonactive/ && !isWeb",
+					"group": "1_pullrequest@4"
+				},
 				{
 					"command": "pr.openChanges",
 					"when": "view =~ /(pr|prStatus):github/ && viewItem =~ /(pullrequest|description)/",

package.nls.json

@@ -208,6 +208,7 @@
 	"command.pr.openChanges.title": "Open Changes",
 	"command.pr.pickOnVscodeDev.title": "Checkout Pull Request on vscode.dev",
 	"command.pr.pickOnCodespaces.title": "Checkout Pull Request on Codespaces",
+	"command.pr.pickInWorktree.title": "Checkout Pull Request in Worktree",
 	"command.pr.exit.title": "Checkout Default Branch",
 	"command.pr.dismissNotification.title": "Dismiss Notification",
 	"command.pr.markAllCopilotNotificationsAsRead.title": "Dismiss All Copilot Notifications",

src/commands.ts

@@ -825,6 +825,119 @@ export function registerCommands(
 		),
 	);
 
+	context.subscriptions.push(
+		vscode.commands.registerCommand('pr.pickInWorktree', async (pr: PRNode | RepositoryChangesNode | PullRequestModel) => {
+			if (pr === undefined) {
+				Logger.error('Unexpectedly received undefined when picking a PR for worktree checkout.', logId);
+				return vscode.window.showErrorMessage(vscode.l10n.t('No pull request was selected to checkout, please try again.'));
+			}
+
+			let pullRequestModel: PullRequestModel;
+			let repository: Repository | undefined;
+
+			if (pr instanceof PRNode || pr instanceof RepositoryChangesNode) {
+				pullRequestModel = pr.pullRequestModel;
+				repository = pr.repository;
+			} else {
+				pullRequestModel = pr;
+			}
+
+			// Validate that the PR has a valid head branch
+			if (!pullRequestModel.head) {
+				return vscode.window.showErrorMessage(vscode.l10n.t('Unable to checkout pull request: missing head branch information.'));
+			}
+
+			// Get the folder manager to access the repository
+			const folderManager = reposManager.getManagerForIssueModel(pullRequestModel);
+			if (!folderManager) {
+				return vscode.window.showErrorMessage(vscode.l10n.t('Unable to find repository for this pull request.'));
+			}
+
+			const repositoryToUse = repository || folderManager.repository;
+
+			/* __GDPR__
+				"pr.checkoutInWorktree" : {}
+			*/
+			telemetry.sendTelemetryEvent('pr.checkoutInWorktree');
+
+			return vscode.window.withProgress(
+				{
+					location: vscode.ProgressLocation.Notification,
+					title: vscode.l10n.t('Checking out Pull Request #{0} in worktree', pullRequestModel.number),
+				},
+				async (progress) => {
+					// Generate a branch name for the worktree
+					const branchName = pullRequestModel.head!.ref;
+					const remoteName = pullRequestModel.remote.remoteName;
+
+					// Fetch the PR branch first
+					progress.report({ message: vscode.l10n.t('Fetching branch {0}...', branchName) });
+					try {
+						await repositoryToUse.fetch({ remote: remoteName, ref: branchName });
+					} catch (e) {
+						Logger.appendLine(`Failed to fetch branch ${branchName}: ${e}`, logId);
+						// Continue even if fetch fails - the branch might already be available locally
+					}
+
+					// Ask user for worktree location
+					const repoRootPath = repositoryToUse.rootUri.fsPath;
+					const parentDir = pathLib.dirname(repoRootPath);
+					const defaultWorktreePath = pathLib.join(parentDir, `pr-${pullRequestModel.number}`);
+
+					const worktreeUri = await vscode.window.showSaveDialog({
+						defaultUri: vscode.Uri.file(defaultWorktreePath),
+						title: vscode.l10n.t('Select Worktree Location'),
+						saveLabel: vscode.l10n.t('Create Worktree'),
+					});
+
+					if (!worktreeUri) {
+						return; // User cancelled
+					}
+
+					const worktreePath = worktreeUri.fsPath;
+
+					// Create the worktree using git command
+					progress.report({ message: vscode.l10n.t('Creating worktree at {0}...', worktreePath) });
+
+					const trackedBranchName = `${remoteName}/${branchName}`;
+					const localBranchName = `pr-${pullRequestModel.number}/${branchName}`;
+
+					try {
+						// Execute git worktree add command
+						const terminal = vscode.window.createTerminal({
+							name: vscode.l10n.t('Git Worktree'),
+							cwd: repoRootPath,
+							hideFromUser: true,
+						});
+
+						// Create worktree with a new local branch tracking the remote
+						terminal.sendText(`git worktree add -b "${localBranchName}" "${worktreePath}" "${trackedBranchName}" && exit`);
+
+						// Wait a bit for the command to complete
+						await new Promise(resolve => setTimeout(resolve, 2000));
+
+						terminal.dispose();
+
+						// Ask user if they want to open the worktree
+						const openAction = vscode.l10n.t('Open in New Window');
+						const result = await vscode.window.showInformationMessage(
+							vscode.l10n.t('Worktree created for Pull Request #{0}', pullRequestModel.number),
+							openAction
+						);
+
+						if (result === openAction) {
+							await commands.openFolder(worktreeUri, { forceNewWindow: true });
+						}
+					} catch (e) {
+						const errorMessage = e instanceof Error ? e.message : String(e);
+						Logger.error(`Failed to create worktree: ${errorMessage}`, logId);
+						return vscode.window.showErrorMessage(vscode.l10n.t('Failed to create worktree: {0}', errorMessage));
+					}
+				}
+			);
+		}),
+	);
+
 	context.subscriptions.push(vscode.commands.registerCommand('pr.checkoutOnVscodeDevFromDescription', async (context: BaseContext | undefined) => {
 		if (!context) {
 			return vscode.window.showErrorMessage(vscode.l10n.t('No pull request context provided for checkout.'));