Adds explain WIP to branch cards

Author: d13

src/commands/commandContext.utils.ts

@@ -15,6 +15,7 @@ import { isRemote } from '../git/models/remote';
 import { Repository } from '../git/models/repository';
 import type { GitTag } from '../git/models/tag';
 import { isTag } from '../git/models/tag';
+import { GitWorktree } from '../git/models/worktree';
 import { CloudWorkspace } from '../plus/workspaces/models/cloudWorkspace';
 import { LocalWorkspace } from '../plus/workspaces/models/localWorkspace';
 import { isScm, isScmResourceGroup, isScmResourceState } from '../system/-webview/scm';
@@ -121,6 +122,14 @@ export function isCommandContextViewNodeHasRemote(
 	return isRemote((context.node as ViewNode & { remote: GitRemote }).remote);
 }
 
+export function isCommandContextViewNodeHasWorktree(
+	context: CommandContext,
+): context is CommandViewNodeContext & { node: ViewNode & { worktree: GitWorktree } } {
+	if (context.type !== 'viewItem') return false;
+
+	return (context.node as ViewNode & { worktree?: GitWorktree }).worktree instanceof GitWorktree;
+}
+
 export function isCommandContextViewNodeHasRepository(
 	context: CommandContext,
 ): context is CommandViewNodeContext & { node: ViewNode & { repo: Repository } } {

src/commands/explainWip.ts

@@ -12,12 +12,17 @@ import { Logger } from '../system/logger';
 import { GlCommandBase } from './commandBase';
 import { getCommandUri } from './commandBase.utils';
 import type { CommandContext } from './commandContext';
-import { isCommandContextViewNodeHasRepoPath, isCommandContextViewNodeHasRepository } from './commandContext.utils';
+import {
+	isCommandContextViewNodeHasRepoPath,
+	isCommandContextViewNodeHasRepository,
+	isCommandContextViewNodeHasWorktree,
+} from './commandContext.utils';
 
 export interface ExplainWipCommandArgs {
 	repoPath?: string | Uri;
 	staged?: boolean;
 	source?: AIExplainSource;
+	worktreePath?: string;
 }
 
 @command()
@@ -27,7 +32,12 @@ export class ExplainWipCommand extends GlCommandBase {
 	}
 
 	protected override preExecute(context: CommandContext, args?: ExplainWipCommandArgs): Promise<void> {
-		if (isCommandContextViewNodeHasRepository(context)) {
+		if (isCommandContextViewNodeHasWorktree(context)) {
+			args = { ...args };
+			args.repoPath = context.node.worktree.repoPath;
+			args.worktreePath = context.node.worktree.path;
+			args.source = args.source ?? { source: 'view', type: 'wip' };
+		} else if (isCommandContextViewNodeHasRepository(context)) {
 			args = { ...args };
 			args.repoPath = context.node.repo.path;
 			args.source = args.source ?? { source: 'view', type: 'wip' };
@@ -45,10 +55,13 @@ export class ExplainWipCommand extends GlCommandBase {
 
 		let repository;
 		if (args?.repoPath != null) {
-			repository = this.container.git.getRepository(args.repoPath);
-		}
-
-		if (repository == null) {
+			if (args.worktreePath) {
+				// TODO use await this.container.git.diff(args.worktreePath) instead, this will be more performant
+				repository = await this.container.git.getOrOpenRepository(args.worktreePath, { closeOnOpen: true });
+			} else {
+				repository = this.container.git.getRepository(args.repoPath);
+			}
+		} else {
 			uri = getCommandUri(uri, editor);
 			const gitUri = uri != null ? await GitUri.fromUri(uri) : undefined;
 			repository = await getBestRepositoryOrShowPicker(
@@ -80,26 +93,50 @@ export class ExplainWipCommand extends GlCommandBase {
 				to = uncommitted;
 			}
 
-			const diff = await diffService.getDiff(to);
+			// If a worktree path is specified, use it for the diff
+			// const options = args?.worktreePath ? { uris: [Uri.file(args.worktreePath)] } : undefined;
+			const options = undefined;
+			const diff = await diffService.getDiff(to, undefined, options);
 			if (!diff?.contents) {
 				void showGenericErrorMessage('No working changes found to explain');
 				return;
 			}
 
+			// Get worktree info
+			let worktreeInfo = '';
+			let worktreeDisplayName = '';
+
+			if (args?.worktreePath) {
+				// Get the worktree name if available
+				const worktrees = await repository.git.worktrees()?.getWorktrees();
+				const worktree = worktrees?.find(w => w.path === args.worktreePath);
+
+				if (worktree) {
+					worktreeInfo = ` in ${worktree.name}`;
+					worktreeDisplayName = ` (${worktree.name})`;
+				} else {
+					worktreeInfo = ` in worktree`;
+					worktreeDisplayName = ` (${args.worktreePath})`;
+				}
+			}
+
 			// Call the AI service to explain the changes
 			const result = await this.container.ai.explainChanges(
 				{
 					diff: diff.contents,
-					message: `${stagedLabel} working changes`,
+					message: `${stagedLabel} working changes${worktreeInfo}`,
 				},
 				args.source ?? { source: 'commandPalette', type: 'wip' },
 				{
-					progress: { location: ProgressLocation.Notification, title: 'Explaining working changes...' },
+					progress: {
+						location: ProgressLocation.Notification,
+						title: `Explaining working changes${worktreeInfo}...`,
+					},
 				},
 			);
 
-			// Display the result
-			let content = `#  Working Changes Summary\n\n`;
+			const title = `Working Changes Summary${worktreeDisplayName}`;
+			let content = `# ${title}\n\n`;
 			if (result != null) {
 				content += `> Generated by ${result.model.name}\n\n## ${stagedLabel} Changes\n\n${result?.parsed.summary}\n\n${result?.parsed.body}`;
 			} else {

src/constants.commands.ts

@@ -54,6 +54,7 @@ type InternalHomeWebviewCommands =
 	| 'gitlens.home.skipPausedOperation'
 	| 'gitlens.home.continuePausedOperation'
 	| 'gitlens.home.abortPausedOperation'
+	| 'gitlens.home.explainWip'
 	| 'gitlens.home.openRebaseEditor';
 
 type InternalHomeWebviewViewCommands =

src/webviews/apps/plus/home/components/branch-card.ts

@@ -1000,6 +1000,16 @@ export class GlBranchCard extends GlBranchCardBase {
 					href=${this.createCommandLink('gitlens.home.openWorktree')}
 				></action-item>`,
 			);
+			// add explain WIP
+			if (this.wip?.workingTreeState != null) {
+				actions.push(
+					html`<action-item
+						label="Explain Changes"
+						icon="sparkle"
+						href=${this.createCommandLink('gitlens.home.explainWip')}
+					></action-item>`,
+				);
+			}
 		} else {
 			actions.push(
 				html`<action-item

src/webviews/home/homeWebview.ts

@@ -5,6 +5,7 @@ import type { CreatePullRequestActionContext } from '../../api/gitlens';
 import type { EnrichedAutolink } from '../../autolinks/models/autolinks';
 import { getAvatarUriFromGravatarEmail } from '../../avatars';
 import type { ChangeBranchMergeTargetCommandArgs } from '../../commands/changeBranchMergeTarget';
+import type { ExplainWipCommandArgs } from '../../commands/explainWip';
 import type { BranchGitCommandArgs } from '../../commands/git/branch';
 import type { OpenPullRequestOnRemoteCommandArgs } from '../../commands/openPullRequestOnRemote';
 import { GlyphChars, urls } from '../../constants';
@@ -352,6 +353,7 @@ export class HomeWebviewProvider implements WebviewProvider<State, State, HomeWe
 			registerCommand('gitlens.home.continuePausedOperation', this.continuePausedOperation, this),
 			registerCommand('gitlens.home.abortPausedOperation', this.abortPausedOperation, this),
 			registerCommand('gitlens.home.openRebaseEditor', this.openRebaseEditor, this),
+			registerCommand('gitlens.home.explainWip', this.explainWip, this),
 		];
 	}
 
@@ -517,6 +519,20 @@ export class HomeWebviewProvider implements WebviewProvider<State, State, HomeWe
 		void RepoActions.rebase(repo, getReferenceFromBranch(branch));
 	}
 
+	@log<HomeWebviewProvider['explainWip']>({ args: { 0: r => r.branchId } })
+	private async explainWip(ref: BranchRef) {
+		const { repo, branch } = await this.getRepoInfoFromRef(ref);
+		if (repo == null) return;
+
+		const worktree = await branch?.getWorktree();
+
+		void executeCommand<ExplainWipCommandArgs>('gitlens.ai.explainWip', {
+			repoPath: repo.path,
+			worktreePath: worktree?.path,
+			source: { source: 'home', type: 'wip' },
+		});
+	}
+
 	@log()
 	private startWork() {
 		this.container.telemetry.sendEvent('home/startWork');