Improves range entry in ref pickers

eamodio · eamodio · commit e6ffb9341d82 · 2025-11-01T18:15:04.000-04:00
diff --git a/src/commands/copyDeepLink.ts b/src/commands/copyDeepLink.ts
@@ -266,7 +266,7 @@ export class CopyFileDeepLinkCommand extends ActiveEditorCommand {
 				`Copy Link to ${filePath} at Reference`,
 				'Choose a reference (branch, tag, etc) to copy the file link for',
 				{
-					allowRevisions: true,
+					allowedAdditionalInput: { rev: true },
 					include: ReferencesQuickPickIncludes.All,
 				},
 			);
diff --git a/src/commands/diffFolderWithRevisionFrom.ts b/src/commands/diffFolderWithRevisionFrom.ts
@@ -60,7 +60,7 @@ export class DiffFolderWithRevisionFromCommand extends ActiveEditorCommand {
 						`Open Folder Changes with Branch or Tag${pad(GlyphChars.Dot, 2, 2)}${relativePath}`,
 						'Choose a reference (branch, tag, etc) to compare',
 						{
-							allowRevisions: true,
+							allowedAdditionalInput: { rev: true },
 							include: ReferencesQuickPickIncludes.All,
 							sort: { branches: { current: true }, tags: {} },
 						},
@@ -79,7 +79,7 @@ export class DiffFolderWithRevisionFromCommand extends ActiveEditorCommand {
 					}`,
 					'Choose a reference (branch, tag, etc) to compare with',
 					{
-						allowRevisions: true,
+						allowedAdditionalInput: { rev: true },
 						include:
 							args.rhs === ''
 								? ReferencesQuickPickIncludes.All & ~ReferencesQuickPickIncludes.WorkingTree
diff --git a/src/commands/diffWithRevisionFrom.ts b/src/commands/diffWithRevisionFrom.ts
@@ -71,7 +71,7 @@ export class DiffWithRevisionFromCommand extends ActiveEditorCommand {
 				`${title}${gitUri.getFormattedFileName({ truncateTo: quickPickTitleMaxChars - title.length })}`,
 				'Choose a reference (branch, tag, etc) to compare with',
 				{
-					allowRevisions: true,
+					allowedAdditionalInput: { rev: true },
 				},
 			);
 			if (pick == null) return;
diff --git a/src/commands/openDirectoryCompare.ts b/src/commands/openDirectoryCompare.ts
@@ -74,7 +74,7 @@ export class OpenDirectoryCompareCommand extends ActiveEditorCommand {
 					'Directory Compare Working Tree with',
 					'Choose a branch or tag to compare with',
 					{
-						allowRevisions: true,
+						allowedAdditionalInput: { rev: true },
 					},
 				);
 				if (pick == null) return;
diff --git a/src/commands/openFileAtRevisionFrom.ts b/src/commands/openFileAtRevisionFrom.ts
@@ -69,7 +69,7 @@ export class OpenFileAtRevisionFromCommand extends ActiveEditorCommand {
 					`${title}${gitUri.getFormattedFileName({ truncateTo: quickPickTitleMaxChars - title.length })}`,
 					'Choose a branch or tag to open the file revision from',
 					{
-						allowRevisions: true,
+						allowedAdditionalInput: { rev: true },
 						keyboard: {
 							keys: ['right', 'alt+right', 'ctrl+right'],
 							onDidPressKey: async (_key, item) => {
diff --git a/src/commands/openFileOnRemote.ts b/src/commands/openFileOnRemote.ts
@@ -165,7 +165,7 @@ export class OpenFileOnRemoteCommand extends ActiveEditorCommand {
 							: `Open File on Remote From${pad(GlyphChars.Dot, 2, 2)}${gitUri.relativePath}`,
 						`Choose a branch or tag to ${args.clipboard ? 'copy' : 'open'} the file revision from`,
 						{
-							allowRevisions: true,
+							allowedAdditionalInput: { rev: true },
 							autoPick: true,
 							filter: { branches: b => b.remote || b.upstream != null },
 							picked: args.branchOrTag,
diff --git a/src/commands/quickCommand.steps.ts b/src/commands/quickCommand.steps.ts
@@ -50,7 +50,7 @@ import {
 	isTagReference,
 } from '../git/utils/reference.utils';
 import { getHighlanderProviderName } from '../git/utils/remote.utils';
-import { createRevisionRange, isRevisionRange } from '../git/utils/revision.utils';
+import { createRevisionRange, getRevisionRangeParts, isRevisionRange, isSha } from '../git/utils/revision.utils';
 import { getSubscriptionNextPaidPlanId, isSubscriptionPaidPlan } from '../plus/gk/utils/subscription.utils';
 import type { LaunchpadCommandArgs } from '../plus/launchpad/launchpad';
 import {
@@ -493,27 +493,51 @@ export async function getBranchesAndOrTags(
 
 export function getValidateGitReferenceFn(
 	repos: Repository | Repository[] | undefined,
-	options?: { buttons?: QuickInputButton[]; ranges?: boolean },
+	options?: {
+		revs?: { allow: boolean; buttons?: QuickInputButton[] };
+		ranges?: { allow: boolean; buttons?: QuickInputButton[]; validate?: boolean };
+	},
 ) {
 	return async (quickpick: QuickPick<any>, value: string): Promise<boolean> => {
-		let inRefMode = false;
-		if (value.startsWith('#')) {
-			inRefMode = true;
-			value = value.substring(1);
-		}
-
 		if (repos == null) return false;
 		if (Array.isArray(repos)) {
 			if (repos.length !== 1) return false;
 
 			repos = repos[0];
 		}
 
-		if (inRefMode && options?.ranges && isRevisionRange(value)) {
+		let allowRevs = false;
+		if (value.startsWith('#')) {
+			allowRevs = options?.revs?.allow ?? true;
+			value = value.substring(1);
+			allowRevs = true;
+		} else if (isSha(value)) {
+			allowRevs = options?.revs?.allow ?? true;
+		}
+
+		if (options?.ranges?.allow && isRevisionRange(value)) {
+			if (options?.ranges?.validate) {
+				// Validate the parts of the range
+				const parts = getRevisionRangeParts(value);
+				const [leftResult, rightResult] = await Promise.allSettled([
+					parts?.left != null ? repos.git.refs.isValidReference(parts.left) : Promise.resolve(true),
+					parts?.right != null ? repos.git.refs.isValidReference(parts.right) : Promise.resolve(true),
+				]);
+
+				if (!getSettledValue(leftResult, false) || !getSettledValue(rightResult, false)) {
+					quickpick.items = [
+						createDirectiveQuickPickItem(Directive.Noop, true, {
+							label: `Invalid Range: ${value}`,
+						}),
+					];
+					return true;
+				}
+			}
+
 			quickpick.items = [
 				createRefQuickPickItem(value, repos.path, true, {
 					alwaysShow: true,
-					buttons: options?.buttons,
+					buttons: options?.ranges?.buttons,
 					ref: false,
 					icon: false,
 				}),
@@ -522,9 +546,9 @@ export function getValidateGitReferenceFn(
 		}
 
 		if (!(await repos.git.refs.isValidReference(value))) {
-			if (inRefMode) {
+			if (allowRevs) {
 				quickpick.items = [
-					createDirectiveQuickPickItem(Directive.Back, true, {
+					createDirectiveQuickPickItem(Directive.Noop, true, {
 						label: 'Enter a reference or commit SHA',
 					}),
 				];
@@ -534,7 +558,7 @@ export function getValidateGitReferenceFn(
 			return false;
 		}
 
-		if (!inRefMode) {
+		if (!allowRevs) {
 			if (
 				await repos.git.refs.hasBranchOrTag({
 					filter: { branches: b => b.name.includes(value), tags: t => t.name.includes(value) },
@@ -548,7 +572,7 @@ export function getValidateGitReferenceFn(
 		quickpick.items = [
 			await createCommitQuickPickItem(commit!, true, {
 				alwaysShow: true,
-				buttons: options?.buttons,
+				buttons: options?.revs?.buttons,
 				compact: true,
 				icon: 'avatar',
 			}),
@@ -1028,7 +1052,10 @@ export function* pickBranchOrTagStep<
 				void showCommitInDetailsView(item, { pin: false, preserveFocus: true });
 			}
 		},
-		onValidateValue: getValidateGitReferenceFn(state.repo, { ranges: ranges }),
+		onValidateValue: getValidateGitReferenceFn(
+			state.repo,
+			ranges ? { ranges: { allow: true, validate: true } } : undefined,
+		),
 	});
 
 	const selection: StepSelection<typeof step> = yield step;
@@ -1307,7 +1334,7 @@ export async function* pickCommitStep<
 			}
 		},
 		onValidateValue: getValidateGitReferenceFn(state.repo, {
-			buttons: [ShowDetailsViewQuickInputButton, RevealInSideBarQuickInputButton],
+			revs: { allow: true, buttons: [ShowDetailsViewQuickInputButton, RevealInSideBarQuickInputButton] },
 		}),
 	});
 
diff --git a/src/env/node/git/sub-providers/commits.ts b/src/env/node/git/sub-providers/commits.ts
@@ -506,7 +506,7 @@ export class CommitsGitSubProvider implements GitCommitsSubProvider {
 			const log: GitLog = {
 				repoPath: repoPath,
 				commits: commits,
-				sha: rev,
+				sha: isRevisionRange(rev) ? undefined : rev,
 				count: commits.size,
 				limit: limit,
 				hasMore: overrideHasMore ?? count - countStashChildCommits > commits.size,
diff --git a/src/quickpicks/comparisonPicker.ts b/src/quickpicks/comparisonPicker.ts
@@ -47,7 +47,7 @@ export async function showComparisonPicker(
 
 		if (head == null || force) {
 			const pick = await showReferencePicker2(repoPath, title, placeholder, {
-				allowRevisions: { ranges: true },
+				allowedAdditionalInput: { range: true, rev: true },
 				include: ReferencesQuickPickIncludes.BranchesAndTags | ReferencesQuickPickIncludes.HEAD,
 				picked: head?.ref,
 				sort: { branches: { current: true } },
@@ -94,7 +94,7 @@ export async function showComparisonPicker(
 
 			const pick = await showReferencePicker2(repoPath, title, placeholder, {
 				allowBack: true,
-				allowRevisions: true,
+				allowedAdditionalInput: { rev: true },
 				exclude: [head.ref],
 				include: ReferencesQuickPickIncludes.BranchesAndTags | ReferencesQuickPickIncludes.HEAD,
 				picked: base?.ref,
diff --git a/src/quickpicks/referencePicker.ts b/src/quickpicks/referencePicker.ts
@@ -36,7 +36,7 @@ export const enum ReferencesQuickPickIncludes {
 }
 
 export interface ReferencesQuickPickOptions {
-	allowRevisions?: boolean | { ranges?: boolean };
+	allowedAdditionalInput?: { range?: boolean; rev?: boolean };
 	autoPick?: boolean;
 	picked?: string;
 	exclude?: string[];
@@ -73,11 +73,17 @@ export async function showReferencePicker2(
 	const quickpick = window.createQuickPick<ReferencesQuickPickItem | DirectiveQuickPickItem>();
 	quickpick.ignoreFocusOut = options?.ignoreFocusOut ?? getQuickPickIgnoreFocusOut();
 
+	const { range: allowRanges, rev: allowRevs } = options?.allowedAdditionalInput ?? {};
+
 	quickpick.title = title;
 	quickpick.placeholder =
-		options?.allowRevisions != null && options.allowRevisions !== false
-			? `${placeholder} (or enter a revision using #)`
-			: placeholder;
+		allowRanges && allowRevs
+			? `${placeholder} (or enter a range, or a revision prefixed with #)`
+			: allowRanges
+				? `${placeholder} (or enter a range)`
+				: allowRevs
+					? `${placeholder} (or enter a revision prefixed with #)`
+					: placeholder;
 	quickpick.matchOnDescription = true;
 	if (options?.allowBack) {
 		quickpick.buttons = [QuickInputButtons.Back];
@@ -133,11 +139,8 @@ export async function showReferencePicker2(
 	quickpick.show();
 
 	const getValidateGitReference = getValidateGitReferenceFn(Container.instance.git.getRepository(repoPath), {
-		buttons: [RevealInSideBarQuickInputButton],
-		ranges:
-			options?.allowRevisions && typeof options.allowRevisions !== 'boolean'
-				? options.allowRevisions.ranges
-				: undefined,
+		revs: { allow: allowRevs ?? false, buttons: [RevealInSideBarQuickInputButton] },
+		ranges: { allow: allowRanges ?? false, validate: true },
 	});
 
 	quickpick.items = await items;
@@ -159,6 +162,8 @@ export async function showReferencePicker2(
 
 					const [item] = quickpick.activeItems;
 					if (isDirectiveQuickPickItem(item)) {
+						if (item.directive === Directive.Noop) return;
+
 						resolve({ directive: item.directive });
 					} else {
 						resolve({ value: item?.item });
@@ -174,7 +179,7 @@ export async function showReferencePicker2(
 						}
 					}
 
-					if (options?.allowRevisions) {
+					if (options?.allowedAdditionalInput) {
 						if (!(await getValidateGitReference(quickpick, e))) {
 							quickpick.items = await items;
 						}
diff --git a/src/views/nodes/compareBranchNode.ts b/src/views/nodes/compareBranchNode.ts
@@ -286,7 +286,7 @@ export class CompareBranchNode extends SubscribeableViewNode<
 			`Compare ${this.branch.name}${this.compareWithWorkingTree ? ' (working)' : ''} with`,
 			'Choose a reference (branch, tag, etc) to compare with',
 			{
-				allowRevisions: true,
+				allowedAdditionalInput: { rev: true },
 				picked: this.branch.ref,
 				sort: { branches: { current: true }, tags: {} },
 			},
diff --git a/src/views/nodes/fileHistoryTrackerNode.ts b/src/views/nodes/fileHistoryTrackerNode.ts
@@ -164,7 +164,7 @@ export class FileHistoryTrackerNode extends SubscribeableViewNode<'file-history-
 			'Change File History Base',
 			'Choose a reference to set as the new base',
 			{
-				allowRevisions: true,
+				allowedAdditionalInput: { rev: true },
 				picked: this._base,
 				sort: { branches: { current: true }, tags: {} },
 			},
diff --git a/src/views/nodes/lineHistoryTrackerNode.ts b/src/views/nodes/lineHistoryTrackerNode.ts
@@ -181,7 +181,7 @@ export class LineHistoryTrackerNode extends SubscribeableViewNode<
 			'Change Line History Base',
 			'Choose a reference to set as the new base',
 			{
-				allowRevisions: true,
+				allowedAdditionalInput: { rev: true },
 				picked: this._base,
 				sort: { branches: { current: true }, tags: {} },
 			},
diff --git a/src/views/searchAndCompareView.ts b/src/views/searchAndCompareView.ts
@@ -161,7 +161,7 @@ export class SearchAndCompareViewNode extends ViewNode<'search-compare', SearchA
 				`Compare ${this.getRefName(selectedRef.ref)} with`,
 				'Choose a reference (branch, tag, etc) to compare with',
 				{
-					allowRevisions: true,
+					allowedAdditionalInput: { rev: true },
 					picked: typeof selectedRef.ref === 'string' ? selectedRef.ref : selectedRef.ref.ref,
 					// checkmarks: true,
 					include: ReferencesQuickPickIncludes.BranchesAndTags | ReferencesQuickPickIncludes.HEAD,
@@ -202,7 +202,7 @@ export class SearchAndCompareViewNode extends ViewNode<'search-compare', SearchA
 				'Compare',
 				'Choose a reference (branch, tag, etc) to compare',
 				{
-					allowRevisions: { ranges: true },
+					allowedAdditionalInput: { range: true, rev: true },
 					include: ReferencesQuickPickIncludes.All,
 					sort: { branches: { current: true }, tags: {} },
 				},
diff --git a/src/webviews/plus/patchDetails/patchDetailsWebview.ts b/src/webviews/plus/patchDetails/patchDetailsWebview.ts
@@ -1497,7 +1497,7 @@ export class PatchDetailsWebviewProvider
 								`Choose New Base for Patch`,
 								`Choose a new base to apply the patch onto`,
 								{
-									allowRevisions: true,
+									allowedAdditionalInput: { rev: true },
 									include:
 										ReferencesQuickPickIncludes.BranchesAndTags | ReferencesQuickPickIncludes.HEAD,
 								},
diff --git a/src/webviews/plus/timeline/timelineWebview.ts b/src/webviews/plus/timeline/timelineWebview.ts
@@ -374,8 +374,7 @@ export class TimelineWebviewProvider implements WebviewProvider<State, State, Ti
 				? 'Choose a reference (branch, tag, etc) as the base to view history from'
 				: 'Choose a reference (branch, tag, etc) as the head to view history for',
 			{
-				// allowRevisions: { ranges: true },
-				allowRevisions: true,
+				allowedAdditionalInput: { rev: true /*, range: true */ },
 				picked: ref?.ref,
 				include:
 					ReferencesQuickPickIncludes.BranchesAndTags |

Original file line number	Diff line number	Diff line change
`@@ -266,7 +266,7 @@ export class CopyFileDeepLinkCommand extends ActiveEditorCommand {`
`266`	`266`	`Copy Link to ${filePath} at Reference`,
`267`	`267`	`'Choose a reference (branch, tag, etc) to copy the file link for',`
`268`	`268`	`{`
`269`		`- allowRevisions: true,`
	`269`	`+ allowedAdditionalInput: { rev: true },`
`270`	`270`	`include: ReferencesQuickPickIncludes.All,`
`271`	`271`	`},`
`272`	`272`	`);`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ export class DiffWithRevisionFromCommand extends ActiveEditorCommand {`
`71`	`71`	`${title}${gitUri.getFormattedFileName({ truncateTo: quickPickTitleMaxChars - title.length })}`,
`72`	`72`	`'Choose a reference (branch, tag, etc) to compare with',`
`73`	`73`	`{`
`74`		`- allowRevisions: true,`
	`74`	`+ allowedAdditionalInput: { rev: true },`
`75`	`75`	`},`
`76`	`76`	`);`
`77`	`77`	`if (pick == null) return;`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ export class OpenDirectoryCompareCommand extends ActiveEditorCommand {`
`74`	`74`	`'Directory Compare Working Tree with',`
`75`	`75`	`'Choose a branch or tag to compare with',`
`76`	`76`	`{`
`77`		`- allowRevisions: true,`
	`77`	`+ allowedAdditionalInput: { rev: true },`
`78`	`78`	`},`
`79`	`79`	`);`
`80`	`80`	`if (pick == null) return;`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ export class OpenFileAtRevisionFromCommand extends ActiveEditorCommand {`
`69`	`69`	`${title}${gitUri.getFormattedFileName({ truncateTo: quickPickTitleMaxChars - title.length })}`,
`70`	`70`	`'Choose a branch or tag to open the file revision from',`
`71`	`71`	`{`
`72`		`- allowRevisions: true,`
	`72`	`+ allowedAdditionalInput: { rev: true },`
`73`	`73`	`keyboard: {`
`74`	`74`	`keys: ['right', 'alt+right', 'ctrl+right'],`
`75`	`75`	`onDidPressKey: async (_key, item) => {`
Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,7 @@ export class OpenFileOnRemoteCommand extends ActiveEditorCommand {`
`165`	`165`	: `Open File on Remote From${pad(GlyphChars.Dot, 2, 2)}${gitUri.relativePath}`,
`166`	`166`	`Choose a branch or tag to ${args.clipboard ? 'copy' : 'open'} the file revision from`,
`167`	`167`	`{`
`168`		`- allowRevisions: true,`
	`168`	`+ allowedAdditionalInput: { rev: true },`
`169`	`169`	`autoPick: true,`
`170`	`170`	`filter: { branches: b => b.remote \|\| b.upstream != null },`
`171`	`171`	`picked: args.branchOrTag,`