Refactors reference picker includes to avoid enum

eamodio · eamodio · commit d7bd82be5e98 · 2025-11-20T23:20:09.000-05:00
diff --git a/src/commands/copyDeepLink.ts b/src/commands/copyDeepLink.ts
@@ -6,7 +6,7 @@ import type { GitReference } from '../git/models/reference';
 import { getBranchNameAndRemote } from '../git/utils/branch.utils';
 import { createReference } from '../git/utils/reference.utils';
 import { showGenericErrorMessage } from '../messages';
-import { ReferencesQuickPickIncludes, showReferencePicker } from '../quickpicks/referencePicker';
+import { showReferencePicker2 } from '../quickpicks/referencePicker';
 import { showRemotePicker } from '../quickpicks/remotePicker';
 import { getBestRepositoryOrShowPicker } from '../quickpicks/repositoryPicker';
 import { command } from '../system/-webview/command';
@@ -261,22 +261,22 @@ export class CopyFileDeepLinkCommand extends ActiveEditorCommand {
 		if (!repoPath || !filePath) return;
 
 		if (args?.chooseRef) {
-			const pick = await showReferencePicker(
+			const result = await showReferencePicker2(
 				repoPath,
 				`Copy Link to ${filePath} at Reference`,
 				'Choose a reference (branch, tag, etc) to copy the file link for',
 				{
 					allowedAdditionalInput: { rev: true },
-					include: ReferencesQuickPickIncludes.All,
+					include: ['branches', 'tags', 'workingTree', 'HEAD'],
 				},
 			);
 
-			if (pick == null) {
+			if (result.value == null) {
 				return;
-			} else if (pick.ref === '') {
+			} else if (result.value.ref === '') {
 				ref = undefined;
 			} else {
-				ref = pick;
+				ref = result.value;
 			}
 		}
 
diff --git a/src/commands/diffFolderWithRevisionFrom.ts b/src/commands/diffFolderWithRevisionFrom.ts
@@ -6,7 +6,7 @@ import { openFolderCompare } from '../git/actions/commit';
 import { GitUri } from '../git/gitUri';
 import { shortenRevision } from '../git/utils/revision.utils';
 import { showGenericErrorMessage } from '../messages';
-import { ReferencesQuickPickIncludes, showReferencePicker } from '../quickpicks/referencePicker';
+import { showReferencePicker2 } from '../quickpicks/referencePicker';
 import { getBestRepositoryOrShowPicker } from '../quickpicks/repositoryPicker';
 import { command } from '../system/-webview/command';
 import { isFolderUri } from '../system/-webview/path';
@@ -55,24 +55,24 @@ export class DiffFolderWithRevisionFromCommand extends ActiveEditorCommand {
 					const gitUri = await GitUri.fromUri(uri);
 					args.rhs = gitUri.sha ?? '';
 				} else {
-					const pick = await showReferencePicker(
+					const result = await showReferencePicker2(
 						repoPath,
 						`Open Folder Changes with Branch or Tag${pad(GlyphChars.Dot, 2, 2)}${relativePath}`,
 						'Choose a reference (branch, tag, etc) to compare',
 						{
 							allowedAdditionalInput: { rev: true },
-							include: ReferencesQuickPickIncludes.All,
+							include: ['branches', 'tags', 'workingTree', 'HEAD'],
 							sort: { branches: { current: true }, tags: {} },
 						},
 					);
-					if (pick?.ref == null) return;
+					if (result.value?.ref == null) return;
 
-					args.rhs = pick.ref;
+					args.rhs = result.value.ref;
 				}
 			}
 
 			if (!args.lhs) {
-				const pick = await showReferencePicker(
+				const result = await showReferencePicker2(
 					repoPath,
 					`Open Folder Changes with Branch or Tag${pad(GlyphChars.Dot, 2, 2)}${relativePath}${
 						args.rhs ? ` at ${shortenRevision(args.rhs)}` : ''
@@ -82,13 +82,13 @@ export class DiffFolderWithRevisionFromCommand extends ActiveEditorCommand {
 						allowedAdditionalInput: { rev: true },
 						include:
 							args.rhs === ''
-								? ReferencesQuickPickIncludes.All & ~ReferencesQuickPickIncludes.WorkingTree
-								: ReferencesQuickPickIncludes.All,
+								? ['branches', 'tags', 'HEAD']
+								: ['branches', 'tags', 'workingTree', 'HEAD'],
 					},
 				);
-				if (pick?.ref == null) return;
+				if (result.value?.ref == null) return;
 
-				args.lhs = pick.ref;
+				args.lhs = result.value.ref;
 
 				// If we are trying to compare to the working tree, swap the lhs and rhs
 				if (args.rhs !== '' && args.lhs === '') {
diff --git a/src/commands/explainBranch.ts b/src/commands/explainBranch.ts
@@ -1,11 +1,10 @@
 import type { TextEditor, Uri } from 'vscode';
 import { ProgressLocation } from 'vscode';
 import type { Container } from '../container';
-import type { GitBranchReference } from '../git/models/reference';
 import { getBranchMergeTargetName } from '../git/utils/-webview/branch.utils';
 import { showGenericErrorMessage } from '../messages';
 import { prepareCompareDataForAIRequest } from '../plus/ai/aiProviderService';
-import { ReferencesQuickPickIncludes, showReferencePicker } from '../quickpicks/referencePicker';
+import { showReferencePicker2 } from '../quickpicks/referencePicker';
 import { command } from '../system/-webview/command';
 import { Logger } from '../system/logger';
 import { getNodeRepoPath } from '../views/nodes/abstract/viewNode';
@@ -52,12 +51,12 @@ export class ExplainBranchCommand extends ExplainCommandBase {
 			// Clarifying the head branch
 			if (args.ref == null) {
 				// If no ref is provided, show a picker to select a branch
-				const pick = (await showReferencePicker(svc.path, this.pickerTitle, 'Choose a branch to explain', {
-					include: ReferencesQuickPickIncludes.Branches,
+				const result = await showReferencePicker2(svc.path, this.pickerTitle, 'Choose a branch to explain', {
+					include: ['branches'],
 					sort: { branches: { current: true } },
-				})) as GitBranchReference | undefined;
-				if (pick?.ref == null) return;
-				args.ref = pick.ref;
+				});
+				if (result.value?.ref == null) return;
+				args.ref = result.value.ref;
 			}
 
 			// Get the branch
diff --git a/src/commands/git/search.ts b/src/commands/git/search.ts
@@ -12,7 +12,7 @@ import { showContributorsPicker } from '../../quickpicks/contributorsPicker';
 import type { QuickPickItemOfT } from '../../quickpicks/items/common';
 import { ActionQuickPickItem, createQuickPickSeparator } from '../../quickpicks/items/common';
 import { isDirectiveQuickPickItem } from '../../quickpicks/items/directive';
-import { ReferencesQuickPickIncludes, showReferencePicker2 } from '../../quickpicks/referencePicker';
+import { showReferencePicker2 } from '../../quickpicks/referencePicker';
 import { configuration } from '../../system/-webview/configuration';
 import { getContext } from '../../system/-webview/context';
 import { first, join, map } from '../../system/iterable';
@@ -625,7 +625,7 @@ async function updateSearchQuery(
 			'Choose a reference to search',
 			{
 				allowedAdditionalInput: { range: true, rev: false },
-				include: ReferencesQuickPickIncludes.All,
+				include: ['branches', 'tags', 'HEAD'],
 				picked: refs && first(refs),
 			},
 		);
diff --git a/src/commands/openBranchOnRemote.ts b/src/commands/openBranchOnRemote.ts
@@ -5,7 +5,7 @@ import { RemoteResourceType } from '../git/models/remoteResource';
 import { getBranchNameWithoutRemote, getRemoteNameFromBranchName } from '../git/utils/branch.utils';
 import { showGenericErrorMessage } from '../messages';
 import { CommandQuickPickItem } from '../quickpicks/items/common';
-import { ReferencesQuickPickIncludes, showReferencePicker } from '../quickpicks/referencePicker';
+import { showReferencePicker2 } from '../quickpicks/referencePicker';
 import { getBestRepositoryOrShowPicker } from '../quickpicks/repositoryPicker';
 import { command, executeCommand } from '../system/-webview/command';
 import { Logger } from '../system/logger';
@@ -62,19 +62,21 @@ export class OpenBranchOnRemoteCommand extends ActiveEditorCommand {
 
 		try {
 			if (args.branch == null) {
-				const pick = await showReferencePicker(
+				const result = await showReferencePicker2(
 					repoPath,
 					args.clipboard ? 'Copy Remote Branch URL' : 'Open Branch On Remote',
 					args.clipboard ? 'Choose a branch to copy the URL from' : 'Choose a branch to open',
 					{
 						autoPick: true,
 						// checkmarks: false,
 						filter: { branches: b => b.upstream != null },
-						include: ReferencesQuickPickIncludes.Branches,
+						include: ['branches'],
 						sort: { branches: { current: true }, tags: {} },
 					},
 				);
-				if (pick == null || pick instanceof CommandQuickPickItem) return;
+				if (result.value == null || result.value instanceof CommandQuickPickItem) return;
+
+				const pick = result.value;
 
 				if (pick.refType === 'branch') {
 					if (pick.remote || (pick.upstream != null && !pick.upstream.missing)) {
diff --git a/src/commands/recomposeBranch.ts b/src/commands/recomposeBranch.ts
@@ -2,7 +2,7 @@ import { window } from 'vscode';
 import type { Sources } from '../constants.telemetry';
 import type { Container } from '../container';
 import { CommandQuickPickItem } from '../quickpicks/items/common';
-import { ReferencesQuickPickIncludes, showReferencePicker } from '../quickpicks/referencePicker';
+import { showReferencePicker2 } from '../quickpicks/referencePicker';
 import { getBestRepositoryOrShowPicker } from '../quickpicks/repositoryPicker';
 import { command, executeCommand } from '../system/-webview/command';
 import { getNodeRepoPath } from '../views/nodes/abstract/viewNode';
@@ -47,12 +47,18 @@ export class RecomposeBranchCommand extends GlCommandBase {
 			// Get branch name using picker fallback
 			let branchName = args.branchName;
 			if (!branchName) {
-				const pick = await showReferencePicker(repoPath, 'Recompose Branch', 'Choose a branch to recompose', {
-					include: ReferencesQuickPickIncludes.Branches,
-					sort: { branches: { current: true } },
-				});
-				if (pick == null || pick instanceof CommandQuickPickItem) return;
+				const result = await showReferencePicker2(
+					repoPath,
+					'Recompose Branch',
+					'Choose a branch to recompose',
+					{
+						include: ['branches'],
+						sort: { branches: { current: true } },
+					},
+				);
+				if (result.value == null || result.value instanceof CommandQuickPickItem) return;
 
+				const pick = result.value;
 				if (pick.refType === 'branch') {
 					branchName = pick.name;
 				} else {
diff --git a/src/quickpicks/comparisonPicker.ts b/src/quickpicks/comparisonPicker.ts
@@ -4,7 +4,7 @@ import { getBranchMergeTargetInfo } from '../git/utils/-webview/branch.utils';
 import { createReference, getReferenceLabel, isBranchReference } from '../git/utils/reference.utils';
 import { getRevisionRangeParts, isRevisionRange } from '../git/utils/revision.utils';
 import { Directive } from './items/directive';
-import { ReferencesQuickPickIncludes, showReferencePicker2 } from './referencePicker';
+import { showReferencePicker2 } from './referencePicker';
 import { getRepositoryOrShowPicker } from './repositoryPicker';
 
 export interface ComparisonPickerOptions {
@@ -48,7 +48,7 @@ export async function showComparisonPicker(
 		if (head == null || force) {
 			const pick = await showReferencePicker2(repoPath, title, placeholder, {
 				allowedAdditionalInput: { range: true, rev: true },
-				include: ReferencesQuickPickIncludes.BranchesAndTags | ReferencesQuickPickIncludes.HEAD,
+				include: ['branches', 'tags', 'HEAD'],
 				picked: head?.ref,
 				sort: { branches: { current: true } },
 			});
@@ -96,7 +96,7 @@ export async function showComparisonPicker(
 				allowBack: true,
 				allowedAdditionalInput: { rev: true },
 				exclude: [head.ref],
-				include: ReferencesQuickPickIncludes.BranchesAndTags | ReferencesQuickPickIncludes.HEAD,
+				include: ['branches', 'tags', 'HEAD'],
 				picked: base?.ref,
 				sort: { branches: { current: true } },
 			});
diff --git a/src/quickpicks/contributorsPicker.ts b/src/quickpicks/contributorsPicker.ts
@@ -13,18 +13,20 @@ import { debounce } from '../system/function/debounce';
 import { defer } from '../system/promise';
 import { pad, truncate } from '../system/string';
 
+export interface ContributorQuickPickOptions {
+	appendReposToTitle?: boolean;
+	clearButton?: boolean;
+	ignoreFocusOut?: boolean;
+	multiselect?: boolean;
+	picked?: (contributor: GitContributor) => boolean;
+}
+
 export async function showContributorsPicker(
 	container: Container,
 	repository: Repository,
 	title: string,
 	placeholder: string,
-	options?: {
-		appendReposToTitle?: boolean;
-		clearButton?: boolean;
-		ignoreFocusOut?: boolean;
-		multiselect?: boolean;
-		picked?: (contributor: GitContributor) => boolean;
-	},
+	options?: ContributorQuickPickOptions,
 ): Promise<GitContributor[] | undefined> {
 	const deferred = defer<GitContributor[] | undefined>();
 	const disposables: Disposable[] = [];
diff --git a/src/quickpicks/referencePicker.ts b/src/quickpicks/referencePicker.ts
@@ -22,26 +22,15 @@ import type { BranchQuickPickItem, RefQuickPickItem, TagQuickPickItem } from './
 import { createRefQuickPickItem } from './items/gitWizard';
 
 export type ReferencesQuickPickItem = BranchQuickPickItem | TagQuickPickItem | RefQuickPickItem;
-
-export const enum ReferencesQuickPickIncludes {
-	Branches = 1 << 0,
-	Tags = 1 << 1,
-	WorkingTree = 1 << 2,
-	HEAD = 1 << 3,
-
-	AllBranches = 1 << 4,
-
-	BranchesAndTags = Branches | Tags,
-	All = Branches | Tags | WorkingTree | HEAD,
-}
+export type ReferencesQuickPickIncludes = 'branches' | 'tags' | 'workingTree' | 'HEAD' | 'allBranches';
 
 export interface ReferencesQuickPickOptions {
 	allowedAdditionalInput?: { range?: boolean; rev?: boolean };
 	autoPick?: boolean;
 	picked?: string;
 	exclude?: string[];
 	filter?: { branches?(b: GitBranch): boolean; tags?(t: GitTag): boolean };
-	include?: ReferencesQuickPickIncludes;
+	include?: ReferencesQuickPickIncludes[];
 	ignoreFocusOut?: boolean;
 	keyboard?: {
 		keys: Keys[];
@@ -50,8 +39,9 @@ export interface ReferencesQuickPickOptions {
 	sort?: boolean | { branches?: BranchSortOptions; tags?: TagSortOptions };
 }
 
-export interface ReferencesQuickPickOptions2 extends ReferencesQuickPickOptions {
+export interface ReferencesQuickPickOptions2 extends Omit<ReferencesQuickPickOptions, 'include'> {
 	allowBack?: boolean;
+	include?: ReferencesQuickPickIncludes[];
 }
 
 export async function showReferencePicker(
@@ -218,13 +208,13 @@ async function getItems(
 	repoPath: string,
 	options?: ReferencesQuickPickOptions2,
 ): Promise<(ReferencesQuickPickItem | DirectiveQuickPickItem)[]> {
-	const include = options?.include ?? ReferencesQuickPickIncludes.BranchesAndTags;
+	const include = options?.include ?? ['branches', 'tags'];
 
 	const includes: ('branches' | 'tags')[] = [];
-	if (include & ReferencesQuickPickIncludes.Branches) {
+	if (include.includes('branches')) {
 		includes.push('branches');
 	}
-	if (include & ReferencesQuickPickIncludes.Tags) {
+	if (include.includes('tags')) {
 		includes.push('tags');
 	}
 
@@ -248,15 +238,15 @@ async function getItems(
 		}
 	}
 
-	if (include & ReferencesQuickPickIncludes.HEAD) {
+	if (include.includes('HEAD')) {
 		items.unshift(createRefQuickPickItem('HEAD', repoPath, undefined, { icon: true }));
 	}
 
-	if (include & ReferencesQuickPickIncludes.WorkingTree) {
+	if (include.includes('workingTree')) {
 		items.unshift(createRefQuickPickItem('', repoPath, undefined, { icon: true }));
 	}
 
-	if (include & ReferencesQuickPickIncludes.AllBranches) {
+	if (include.includes('allBranches')) {
 		items.unshift(createQuickPickSeparator());
 		items.unshift(createDirectiveQuickPickItem(Directive.RefsAllBranches));
 	}
diff --git a/src/views/searchAndCompareView.ts b/src/views/searchAndCompareView.ts
diff --git a/src/webviews/plus/graph/graphWebview.ts b/src/webviews/plus/graph/graphWebview.ts
diff --git a/src/webviews/plus/patchDetails/patchDetailsWebview.ts b/src/webviews/plus/patchDetails/patchDetailsWebview.ts
diff --git a/src/webviews/plus/timeline/timelineWebview.ts b/src/webviews/plus/timeline/timelineWebview.ts
