Add customizable PR checkout branch name setting

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

Author: Copilot

package.json

@@ -158,6 +158,11 @@
 					"default": "template",
 					"description": "%githubPullRequests.pullRequestDescription.description%"
 				},
+				"githubPullRequests.pullRequestCheckoutBranchTitle": {
+					"type": "string",
+					"default": "pr/${owner}/${number}",
+					"markdownDescription": "%githubPullRequests.pullRequestCheckoutBranchTitle.markdownDescription%"
+				},
 				"githubPullRequests.defaultCreateOption": {
 					"type": "string",
 					"enum": [

package.nls.json

@@ -6,6 +6,13 @@
 	"githubPullRequests.pullRequestDescription.commit": "Use the latest commit message only",
 	"githubPullRequests.pullRequestDescription.none": "Do not have a default description",
 	"githubPullRequests.pullRequestDescription.copilot": "Generate a pull request title and description from GitHub Copilot. Requires that the GitHub Copilot extension is installed and authenticated. Will fall back to `commit` if Copilot is not set up.",
+	"githubPullRequests.pullRequestCheckoutBranchTitle.markdownDescription": {
+		"message": "Advanced settings for the name of the branch that is created when you check out a pull request. \n- `${owner}` will be replaced with the pull request author's username \n- `${number}` will be replaced with the pull request number \n- `${title}` will be replaced with the pull request title, with all spaces and unsupported characters (https://git-scm.com/docs/git-check-ref-format) removed. For lowercase, use `${sanitizedLowercaseTitle}` ",
+		"comment": [
+			"{Locked='${...}'}",
+			"Do not translate what's inside of the '${..}'. It is an internal syntax for the extension"
+		]
+	},
 	"githubPullRequests.defaultCreateOption.description": "The create option that the \"Create\" button will default to when creating a pull request.",
 	"githubPullRequests.defaultCreateOption.lastUsed": "The most recently used create option.",
 	"githubPullRequests.defaultCreateOption.create": "The pull request will be created.",

src/common/settingKeys.ts

@@ -18,6 +18,7 @@ export const NEVER_IGNORE_DEFAULT_BRANCH = 'neverIgnoreDefaultBranch';
 export const OVERRIDE_DEFAULT_BRANCH = 'overrideDefaultBranch';
 export const PULL_BRANCH = 'pullBranch';
 export const PULL_REQUEST_DESCRIPTION = 'pullRequestDescription';
+export const PULL_REQUEST_CHECKOUT_BRANCH_TITLE = 'pullRequestCheckoutBranchTitle';
 export const NOTIFICATION_SETTING = 'notifications';
 export type NotificationVariants = 'off' | 'pullRequests';
 export const POST_CREATE = 'postCreate';

src/github/pullRequestGitHelper.ts

@@ -8,11 +8,12 @@
  */
 import * as vscode from 'vscode';
 import { IResolvedPullRequestModel, PullRequestModel } from './pullRequestModel';
+import { sanitizeIssueTitle } from './utils';
 import { Branch, Repository } from '../api/api';
 import Logger from '../common/logger';
 import { Protocol } from '../common/protocol';
 import { parseRepositoryRemotes, Remote } from '../common/remote';
-import { PR_SETTINGS_NAMESPACE, PULL_PR_BRANCH_BEFORE_CHECKOUT, PullPRBranchVariants } from '../common/settingKeys';
+import { PR_SETTINGS_NAMESPACE, PULL_PR_BRANCH_BEFORE_CHECKOUT, PULL_REQUEST_CHECKOUT_BRANCH_TITLE, PullPRBranchVariants } from '../common/settingKeys';
 
 const PullRequestRemoteMetadataKey = 'github-pr-remote';
 export const PullRequestMetadataKey = 'github-pr-owner-number';
@@ -367,11 +368,36 @@ export class PullRequestGitHelper {
 		}
 	}
 
+	private static prBranchNameVariableSubstitution(
+		template: string,
+		pullRequest: PullRequestModel,
+	): string {
+		const VARIABLE_PATTERN = /\$\{([^}]*?)\}/g;
+		return template.replace(VARIABLE_PATTERN, (match: string, variable: string) => {
+			switch (variable) {
+				case 'owner':
+					return pullRequest.author.login;
+				case 'number':
+					return `${pullRequest.number}`;
+				case 'title':
+					return sanitizeIssueTitle(pullRequest.title);
+				case 'sanitizedLowercaseTitle':
+					return sanitizeIssueTitle(pullRequest.title).toLowerCase();
+				default:
+					return match;
+			}
+		});
+	}
+
 	static async calculateUniqueBranchNameForPR(
 		repository: Repository,
 		pullRequest: PullRequestModel,
 	): Promise<string> {
-		const branchName = `pr/${pullRequest.author.login}/${pullRequest.number}`;
+		const template = vscode.workspace
+			.getConfiguration(PR_SETTINGS_NAMESPACE)
+			.get<string>(PULL_REQUEST_CHECKOUT_BRANCH_TITLE)!;
+
+		const branchName = PullRequestGitHelper.prBranchNameVariableSubstitution(template, pullRequest);
 		let result = branchName;
 		let number = 1;