Adds folder history commands to SCM

Author: eamodio

CHANGELOG.md

@@ -20,7 +20,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
   - Improves hover content and interations
   - Adds explicit zoom in/out buttons and changes mouse zoom to use the mouse wheel — when zoomed, drag to scrub through the history
   - Optimizes chart resizing and axis label rendering with author indicators, and re-adds the legend to the view
-- Adds a new _Folder History_ > _Open Visual Folder History_ command to folders in the _Explorer_ view, and other GitLens views
+- Adds a new _Folder History_ > _Open Visual Folder History_ command to folders in the _Explorer_ view, _Source Control_ view, and other GitLens views
 - Adds new ability to see and act upon a "paused" Git operation, e.g. merge, rebase, cherry-pick, revert, across the _Commits_, _Commit Graph_, and _Home_ views — closes [#3913](https://github.com/gitkraken/vscode-gitlens/issues/3913)
   - Adds a new banner on the _Commit Graph_ and updates the banner on _Home_ with actions to continue, skip, or abort the operation
   - Adds _Continue_, _Skip_, and _Abort_ actions to the _Commits_ view

contributions.json

@@ -3199,6 +3199,12 @@
 						"group": "1_gitlens",
 						"order": 1
 					}
+				],
+				"gitlens/scm/resourceFolder/history": [
+					{
+						"group": "1_gitlens",
+						"order": 2
+					}
 				]
 			}
 		},
@@ -3723,6 +3729,12 @@
 						"group": "1_gitlens",
 						"order": 2
 					}
+				],
+				"gitlens/scm/resourceFolder/history": [
+					{
+						"group": "1_gitlens",
+						"order": 2
+					}
 				]
 			}
 		},
@@ -12116,6 +12128,18 @@
 				]
 			}
 		},
+		"gitlens/scm/resourceFolder/history": {
+			"label": "Folder History",
+			"menus": {
+				"scm/resourceFolder/context": [
+					{
+						"when": "scmResourceGroup =~ /^(workingTree|index|merge)$/ && scmProvider == git && gitlens:enabled && config.gitlens.menus.scmItem.history",
+						"group": "2_gitlens_1",
+						"order": 1
+					}
+				]
+			}
+		},
 		"gitlens/scm/resourceGroup/changes": {
 			"label": "Open Changes",
 			"menus": {

package.json

@@ -13904,6 +13904,16 @@
 					"group": "1_gitlens@2"
 				}
 			],
+			"gitlens/scm/resourceFolder/history": [
+				{
+					"command": "gitlens.openFolderHistory",
+					"group": "1_gitlens@2"
+				},
+				{
+					"command": "gitlens.showFolderInTimeline",
+					"group": "1_gitlens@2"
+				}
+			],
 			"gitlens/scm/resourceGroup/changes": [
 				{
 					"command": "gitlens.externalDiffAll",
@@ -15050,6 +15060,11 @@
 					"when": "scmResourceGroup =~ /^(workingTree|index|merge)$/ && scmProvider == git && gitlens:enabled && config.gitlens.menus.scmItem.compare",
 					"group": "2_gitlens@1"
 				},
+				{
+					"submenu": "gitlens/scm/resourceFolder/history",
+					"when": "scmResourceGroup =~ /^(workingTree|index|merge)$/ && scmProvider == git && gitlens:enabled && config.gitlens.menus.scmItem.history",
+					"group": "2_gitlens_1@1"
+				},
 				{
 					"command": "gitlens.copyPatchToClipboard",
 					"when": "scmResourceGroup =~ /^(workingTree|index)$/ && scmProvider == git && gitlens:enabled && config.gitlens.menus.scmGroup.patch",
@@ -18936,6 +18951,10 @@
 				"id": "gitlens/scm/resourceFolder/changes",
 				"label": "Open Changes with"
 			},
+			{
+				"id": "gitlens/scm/resourceFolder/history",
+				"label": "Folder History"
+			},
 			{
 				"id": "gitlens/scm/resourceGroup/changes",
 				"label": "Open Changes"

src/commands/base.ts

@@ -26,6 +26,7 @@ import { isTag } from '../git/models/tag';
 import { CloudWorkspace, LocalWorkspace } from '../plus/workspaces/models';
 import { sequentialize } from '../system/function';
 import { registerCommand } from '../system/vscode/command';
+import { isScm, isScmResourceGroup, isScmResourceState } from '../system/vscode/scm';
 import { ViewNode } from '../views/nodes/abstract/viewNode';
 import { ViewRefFileNode, ViewRefNode } from '../views/nodes/abstract/viewRefNode';
 
@@ -42,6 +43,8 @@ export interface CommandBaseContext {
 	command: string;
 	editor?: TextEditor;
 	uri?: Uri;
+
+	readonly args: unknown[];
 }
 
 export interface CommandEditorLineContext extends CommandBaseContext {
@@ -237,34 +240,6 @@ export type CommandContext =
 	| CommandViewNodeContext
 	| CommandViewNodesContext;
 
-export function isScm(scm: any): scm is SourceControl {
-	if (scm == null) return false;
-
-	return (
-		(scm as SourceControl).id != null &&
-		(scm as SourceControl).rootUri != null &&
-		(scm as SourceControl).inputBox != null &&
-		(scm as SourceControl).statusBarCommands != null
-	);
-}
-
-function isScmResourceGroup(group: any): group is SourceControlResourceGroup {
-	if (group == null) return false;
-
-	return (
-		(group as SourceControlResourceGroup).id != null &&
-		(group as SourceControlResourceGroup).label != null &&
-		(group as SourceControlResourceGroup).resourceStates != null &&
-		Array.isArray((group as SourceControlResourceGroup).resourceStates)
-	);
-}
-
-function isScmResourceState(resource: any): resource is SourceControlResourceState {
-	if (resource == null) return false;
-
-	return (resource as SourceControlResourceState).resourceUri != null;
-}
-
 function isTimelineItem(item: any): item is TimelineItem {
 	if (item == null) return false;
 
@@ -334,6 +309,7 @@ export function parseCommandContext(
 ): [CommandContext | CommandContext[], any[]] {
 	let editor: TextEditor | undefined = undefined;
 
+	const originalArgs = [...args];
 	let firstArg = args[0];
 
 	if (options?.expectsEditor) {
@@ -357,9 +333,12 @@ export function parseCommandContext(
 
 				const uris = rest[0];
 				if (uris != null && Array.isArray(uris) && uris.length !== 0 && uris[0] instanceof Uri) {
-					return [{ command: command, type: 'uris', editor: editor, uri: uri, uris: uris }, rest.slice(1)];
+					return [
+						{ command: command, type: 'uris', args: originalArgs, editor: editor, uri: uri, uris: uris },
+						rest.slice(1),
+					];
 				}
-				return [{ command: command, type: 'uri', editor: editor, uri: uri }, rest];
+				return [{ command: command, type: 'uri', args: originalArgs, editor: editor, uri: uri }, rest];
 			}
 
 			args = args.slice(1);
@@ -370,6 +349,7 @@ export function parseCommandContext(
 					{
 						command: command,
 						type: 'editorLine',
+						args: originalArgs,
 						editor: undefined,
 						line: firstArg.lineNumber - 1, // convert to zero-based
 						uri: firstArg.uri,
@@ -395,14 +375,14 @@ export function parseCommandContext(
 			const contexts: CommandContext[] = [];
 			for (const n of nodes) {
 				if (n?.constructor === node.constructor) {
-					contexts.push({ command: command, type: 'viewItem', node: n, uri: n.uri });
+					contexts.push({ command: command, type: 'viewItem', args: originalArgs, node: n, uri: n.uri });
 				}
 			}
 
 			return [contexts, rest];
 		}
 
-		return [{ command: command, type: 'viewItem', node: node, uri: node.uri }, rest];
+		return [{ command: command, type: 'viewItem', args: originalArgs, node: node, uri: node.uri }, rest];
 	}
 
 	if (isScmResourceState(firstArg)) {
@@ -416,7 +396,13 @@ export function parseCommandContext(
 		}
 
 		return [
-			{ command: command, type: 'scm-states', scmResourceStates: states, uri: states[0].resourceUri },
+			{
+				command: command,
+				type: 'scm-states',
+				args: originalArgs,
+				scmResourceStates: states,
+				uri: states[0].resourceUri,
+			},
 			args.slice(count),
 		];
 	}
@@ -431,20 +417,23 @@ export function parseCommandContext(
 			groups.push(arg);
 		}
 
-		return [{ command: command, type: 'scm-groups', scmResourceGroups: groups }, args.slice(count)];
+		return [
+			{ command: command, type: 'scm-groups', args: originalArgs, scmResourceGroups: groups },
+			args.slice(count),
+		];
 	}
 
 	if (isGitTimelineItem(firstArg)) {
 		const [item, uri, ...rest] = args as [GitTimelineItem, Uri, any];
-		return [{ command: command, type: 'timeline-item:git', item: item, uri: uri }, rest];
+		return [{ command: command, type: 'timeline-item:git', args: originalArgs, item: item, uri: uri }, rest];
 	}
 
 	if (isScm(firstArg)) {
 		const [scm, ...rest] = args as [SourceControl, any];
-		return [{ command: command, type: 'scm', scm: scm }, rest];
+		return [{ command: command, type: 'scm', args: originalArgs, scm: scm }, rest];
 	}
 
-	return [{ command: command, type: 'unknown', editor: editor, uri: editor?.document.uri }, args];
+	return [{ command: command, type: 'unknown', args: originalArgs, editor: editor, uri: editor?.document.uri }, args];
 }
 
 export abstract class ActiveEditorCommand extends GlCommandBase {

src/commands/showQuickFileHistory.ts

@@ -9,6 +9,7 @@ import type { GitReference } from '../git/models/reference';
 import type { GitTag } from '../git/models/tag';
 import type { CommandQuickPickItem } from '../quickpicks/items/common';
 import { command } from '../system/vscode/command';
+import { getScmResourceFolderUri } from '../system/vscode/scm';
 import type { CommandContext } from './base';
 import { ActiveEditorCachedCommand, getCommandUri } from './base';
 
@@ -36,16 +37,22 @@ export class ShowQuickFileHistoryCommand extends ActiveEditorCachedCommand {
 	}
 
 	protected override preExecute(context: CommandContext, args?: ShowQuickFileHistoryCommandArgs) {
+		let uri = context.uri;
 		if (
 			context.command === GlCommand.OpenFileHistory ||
-			context.command === GlCommand.OpenFolderHistory ||
 			context.command === GlCommand.Deprecated_ShowFileHistoryInView
 		) {
 			args = { ...args };
 			args.showInSideBar = true;
+		} else if (context.command === GlCommand.OpenFolderHistory) {
+			args = { ...args };
+			args.showInSideBar = true;
+			if (context.type === 'scm-states') {
+				uri = getScmResourceFolderUri(context.args) ?? context.uri;
+			}
 		}
 
-		return this.execute(context.editor, context.uri, args);
+		return this.execute(context.editor, uri, args);
 	}
 
 	async execute(editor?: TextEditor, uri?: Uri, args?: ShowQuickFileHistoryCommandArgs) {

src/system/path.ts

@@ -9,9 +9,17 @@ const driveLetterNormalizeRegex = /(?<=^\/?)([A-Z])(?=:\/)/;
 const hasSchemeRegex = /^([a-zA-Z][\w+.-]+):/;
 const pathNormalizeRegex = /\\/g;
 
-export function commonBase(s1: string, s2: string, delimiter: string, ignoreCase?: boolean): string | undefined {
-	const index = commonBaseIndex(s1, s2, delimiter, ignoreCase);
-	return index > 0 ? s1.substring(0, index + 1) : undefined;
+export function commonBase(s: string[], delimiter: string, ignoreCase?: boolean): string | undefined {
+	if (s.length === 0) return undefined;
+
+	let common = s[0];
+	for (let i = 1; i < s.length; i++) {
+		const index = commonBaseIndex(common, s[i], delimiter, ignoreCase);
+		if (index === 0) return undefined;
+		common = common.substring(0, index + 1);
+	}
+
+	return common;
 }
 
 export function commonBaseIndex(s1: string, s2: string, delimiter: string, ignoreCase?: boolean): number {

src/system/vscode/scm.ts

@@ -0,0 +1,55 @@
+import type { SourceControl, SourceControlResourceGroup, SourceControlResourceState } from 'vscode';
+import { Uri } from 'vscode';
+import { commonBase } from '../path';
+
+// Since `scm/resourceFolder/context` commands use the URIs of the files, we have to find the common parent
+export function getScmResourceFolderUri(args: unknown[]): Uri | undefined {
+	const uris = args
+		.map(a => (isScmResourceState(a) ? a.resourceUri : undefined))
+		.filter(<T>(u?: T): u is T => Boolean(u));
+	if (!uris.length) return undefined;
+
+	const [uri] = uris;
+	if (uris.length === 1) {
+		// Strip off the filename
+		return Uri.joinPath(uri, '..');
+	}
+
+	const common = commonBase(
+		uris.map(u => u.path),
+		'/',
+	);
+	return Uri.from({
+		scheme: uri.scheme,
+		authority: uri.authority,
+		path: common,
+	});
+}
+
+export function isScm(scm: unknown): scm is SourceControl {
+	if (scm == null) return false;
+
+	return (
+		(scm as SourceControl).id != null &&
+		(scm as SourceControl).rootUri != null &&
+		(scm as SourceControl).inputBox != null &&
+		(scm as SourceControl).statusBarCommands != null
+	);
+}
+
+export function isScmResourceGroup(group: unknown): group is SourceControlResourceGroup {
+	if (group == null) return false;
+
+	return (
+		(group as SourceControlResourceGroup).id != null &&
+		(group as SourceControlResourceGroup).label != null &&
+		(group as SourceControlResourceGroup).resourceStates != null &&
+		Array.isArray((group as SourceControlResourceGroup).resourceStates)
+	);
+}
+
+export function isScmResourceState(resource: unknown): resource is SourceControlResourceState {
+	if (resource == null) return false;
+
+	return (resource as SourceControlResourceState).resourceUri != null;
+}

src/webviews/plus/graph/registration.ts

@@ -1,12 +1,12 @@
 import { Disposable, ViewColumn } from 'vscode';
-import { isScm } from '../../../commands/base';
 import { GlCommand } from '../../../constants.commands';
 import type { Container } from '../../../container';
 import type { GitReference } from '../../../git/models/reference';
 import type { Repository } from '../../../git/models/repository';
 import { executeCommand, executeCoreCommand, registerCommand } from '../../../system/vscode/command';
 import { configuration } from '../../../system/vscode/configuration';
 import { getContext } from '../../../system/vscode/context';
+import { isScm } from '../../../system/vscode/scm';
 import { ViewNode } from '../../../views/nodes/abstract/viewNode';
 import type { BranchNode } from '../../../views/nodes/branchNode';
 import type { CommitFileNode } from '../../../views/nodes/commitFileNode';

src/webviews/plus/timeline/registration.ts

@@ -3,6 +3,7 @@ import { Disposable, ViewColumn } from 'vscode';
 import { GlCommand } from '../../../constants.commands';
 import { registerCommand } from '../../../system/vscode/command';
 import { configuration } from '../../../system/vscode/configuration';
+import { getScmResourceFolderUri, isScmResourceState } from '../../../system/vscode/scm';
 import type { ViewFileNode } from '../../../views/nodes/abstract/viewFileNode';
 import type { WebviewPanelsProxy, WebviewsController } from '../../webviewsController';
 import type { State } from './protocol';
@@ -64,14 +65,20 @@ export function registerTimelineWebviewCommands<T>(
 	panels: WebviewPanelsProxy<'gitlens.timeline', TimelineWebviewShowingArgs, T>,
 ) {
 	return Disposable.from(
-		registerCommand(
-			GlCommand.ShowFileInTimeline,
-			(...args: TimelineWebviewShowingArgs) => void panels.show(undefined, ...args),
-		),
-		registerCommand(
-			GlCommand.ShowFolderInTimeline,
-			(...args: TimelineWebviewShowingArgs) => void panels.show(undefined, ...args),
-		),
+		registerCommand(GlCommand.ShowFileInTimeline, (...args: TimelineWebviewShowingArgs) => {
+			const [arg] = args;
+			if (isScmResourceState(arg)) {
+				args = [arg.resourceUri];
+			}
+			return void panels.show(undefined, ...args);
+		}),
+		registerCommand(GlCommand.ShowFolderInTimeline, (...args: TimelineWebviewShowingArgs) => {
+			const uri = getScmResourceFolderUri(args);
+			if (uri != null) {
+				args = [uri];
+			}
+			void panels.show(undefined, ...args);
+		}),
 
 		registerCommand(`${panels.id}.refresh`, () => void panels.getActiveInstance()?.refresh(true)),
 		registerCommand(