Adds command to Explain WIP

Author: d13

contributions.json

@@ -51,7 +51,16 @@
 		},
 		"gitlens.ai.explainWip": {
 			"label": "Explain Working Changes (Preview)...",
-			"commandPalette": "gitlens:enabled && !gitlens:readonly && !gitlens:untrusted && gitlens:gk:organization:ai:enabled"
+			"commandPalette": "gitlens:enabled && !gitlens:readonly && !gitlens:untrusted && gitlens:gk:organization:ai:enabled",
+			"menus": {
+				"view/item/context": [
+					{
+						"when": "viewItem =~ /gitlens:worktree\\b/ && !listMultiSelection && !gitlens:readonly && !gitlens:untrusted && gitlens:gk:organization:ai:enabled",
+						"group": "3_gitlens_ai",
+						"order": 1
+					}
+				]
+			}
 		},
 		"gitlens.ai.generateChangelog": {
 			"label": "Generate Changelog (Preview)...",
@@ -2016,6 +2025,18 @@
 				]
 			}
 		},
+		"gitlens.graph.explainWip": {
+			"label": "Explain Working Changes (Preview)",
+			"menus": {
+				"webview/context": [
+					{
+						"when": "webviewItem =~ /gitlens:wip\\b/ && !listMultiSelection && !gitlens:readonly && !gitlens:untrusted && gitlens:gk:organization:ai:enabled",
+						"group": "1_gitlens_actions_3",
+						"order": 1
+					}
+				]
+			}
+		},
 		"gitlens.graph.fetch": {
 			"label": "Fetch",
 			"icon": "$(repo-fetch)",

package.json

@@ -6840,6 +6840,10 @@
 				"command": "gitlens.graph.explainStash",
 				"title": "Explain Stash (Preview)"
 			},
+			{
+				"command": "gitlens.graph.explainWip",
+				"title": "Explain Working Changes (Preview)"
+			},
 			{
 				"command": "gitlens.graph.fetch",
 				"title": "Fetch",
@@ -10997,6 +11001,10 @@
 					"command": "gitlens.graph.explainStash",
 					"when": "false"
 				},
+				{
+					"command": "gitlens.graph.explainWip",
+					"when": "false"
+				},
 				{
 					"command": "gitlens.graph.fetch",
 					"when": "false"
@@ -17947,6 +17955,11 @@
 					"when": "viewItem =~ /gitlens:worktree\\b/ && !listMultiSelection",
 					"group": "3_gitlens@1"
 				},
+				{
+					"command": "gitlens.ai.explainWip",
+					"when": "viewItem =~ /gitlens:worktree\\b/ && !listMultiSelection && !gitlens:readonly && !gitlens:untrusted && gitlens:gk:organization:ai:enabled",
+					"group": "3_gitlens_ai@1"
+				},
 				{
 					"command": "gitlens.views.deleteWorktree",
 					"when": "viewItem =~ /gitlens:worktree\\b(?!.*?\\b\\+(active|default)\\b)/ && !listMultiSelection && !gitlens:readonly",
@@ -20382,6 +20395,11 @@
 					"when": "webviewItem == gitlens:wip && !listMultiSelection && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders",
 					"group": "1_gitlens_actions@4"
 				},
+				{
+					"command": "gitlens.graph.explainWip",
+					"when": "webviewItem =~ /gitlens:wip\\b/ && !listMultiSelection && !gitlens:readonly && !gitlens:untrusted && gitlens:gk:organization:ai:enabled",
+					"group": "1_gitlens_actions_3@1"
+				},
 				{
 					"command": "gitlens.graph.hideRefGroup",
 					"when": "webviewItemGroup =~ /gitlens:refGroup\\b(?!.*?\\b\\+current\\b)/",

src/commands/explainWip.ts

@@ -12,6 +12,7 @@ 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';
 
 export interface ExplainWipCommandArgs {
 	repoPath?: string | Uri;
@@ -26,21 +27,38 @@ export class ExplainWipCommand extends GlCommandBase {
 	}
 
 	protected override preExecute(context: CommandContext, args?: ExplainWipCommandArgs): Promise<void> {
+		if (isCommandContextViewNodeHasRepository(context)) {
+			args = { ...args };
+			args.repoPath = context.node.repo.path;
+			args.source = args.source ?? { source: 'view', type: 'wip' };
+		} else if (isCommandContextViewNodeHasRepoPath(context)) {
+			args = { ...args };
+			args.repoPath = context.node.repoPath;
+			args.source = args.source ?? { source: 'view', type: 'wip' };
+		}
+
 		return this.execute(context.editor, context.uri, args);
 	}
 
 	async execute(editor?: TextEditor, uri?: Uri, args?: ExplainWipCommandArgs): Promise<void> {
 		args = { ...args };
-		uri = getCommandUri(uri, editor);
 
-		const gitUri = uri != null ? await GitUri.fromUri(uri) : undefined;
+		let repository;
+		if (args?.repoPath != null) {
+			repository = this.container.git.getRepository(args.repoPath);
+		}
+
+		if (repository == null) {
+			uri = getCommandUri(uri, editor);
+			const gitUri = uri != null ? await GitUri.fromUri(uri) : undefined;
+			repository = await getBestRepositoryOrShowPicker(
+				gitUri,
+				editor,
+				'Explain Working Changes',
+				'Choose which repository to explain working changes from',
+			);
+		}
 
-		const repository = await getBestRepositoryOrShowPicker(
-			gitUri,
-			editor,
-			'Explain Working Changes',
-			'Choose which repository to explain working changes from',
-		);
 		if (repository == null) return;
 
 		try {
@@ -51,7 +69,18 @@ export class ExplainWipCommand extends GlCommandBase {
 				return;
 			}
 
-			const diff = await diffService.getDiff(args?.staged ? uncommittedStaged : uncommitted);
+			// If args?.staged is undefined, should we get all changes (staged and unstaged)?
+			let stagedLabel;
+			let to;
+			if (args?.staged === true) {
+				stagedLabel = 'Staged';
+				to = uncommittedStaged;
+			} else {
+				stagedLabel = 'Unstaged';
+				to = uncommitted;
+			}
+
+			const diff = await diffService.getDiff(to);
 			if (!diff?.contents) {
 				void showGenericErrorMessage('No working changes found to explain');
 				return;
@@ -61,7 +90,7 @@ export class ExplainWipCommand extends GlCommandBase {
 			const result = await this.container.ai.explainChanges(
 				{
 					diff: diff.contents,
-					message: args?.staged ? 'Staged working changes' : 'Unstaged working changes',
+					message: `${stagedLabel} working changes`,
 				},
 				args.source ?? { source: 'commandPalette', type: 'wip' },
 				{
@@ -70,9 +99,9 @@ export class ExplainWipCommand extends GlCommandBase {
 			);
 
 			// Display the result
-			let content = `# ${args?.staged ? 'Staged' : 'Unstaged'} Working Changes\n`;
+			let content = `#  Working Changes Summary\n\n`;
 			if (result != null) {
-				content += `> Generated by ${result.model.name}\n\n----\n\n${result?.parsed.summary}\n\n${result?.parsed.body}`;
+				content += `> Generated by ${result.model.name}\n\n## ${stagedLabel} Changes\n\n${result?.parsed.summary}\n\n${result?.parsed.body}`;
 			} else {
 				content += `> No changes found to explain.`;
 			}

src/constants.commands.generated.ts

@@ -73,6 +73,7 @@ export type ContributedCommands =
 	| 'gitlens.graph.deleteTag'
 	| 'gitlens.graph.explainCommit'
 	| 'gitlens.graph.explainStash'
+	| 'gitlens.graph.explainWip'
 	| 'gitlens.graph.fetch'
 	| 'gitlens.graph.hideLocalBranch'
 	| 'gitlens.graph.hideRefGroup'

src/webviews/plus/graph/graphWebview.ts

@@ -688,6 +688,7 @@ export class GraphWebviewProvider implements WebviewProvider<State, State, Graph
 			this.host.registerWebviewCommand('gitlens.graph.ai.generateCommitMessage', this.generateCommitMessage),
 			this.host.registerWebviewCommand('gitlens.graph.explainCommit', this.explainCommit),
 			this.host.registerWebviewCommand('gitlens.graph.explainStash', this.explainStash),
+			this.host.registerWebviewCommand('gitlens.graph.explainWip', this.explainWip),
 
 			this.host.registerWebviewCommand('gitlens.graph.compareSelectedCommits.multi', this.compareSelectedCommits),
 			this.host.registerWebviewCommand('gitlens.graph.abortPausedOperation', this.abortPausedOperation),
@@ -3828,6 +3829,17 @@ export class GraphWebviewProvider implements WebviewProvider<State, State, Graph
 		});
 	}
 
+	@log()
+	private explainWip(item?: GraphItemContext) {
+		const ref = this.getGraphItemRef(item, 'revision');
+		if (ref == null) return Promise.resolve();
+
+		return executeCommand('gitlens.ai.explainWip', {
+			repoPath: ref.repoPath,
+			source: { source: 'graph', type: 'wip' },
+		});
+	}
+
 	@log()
 	private async openFiles(item?: GraphItemContext) {
 		const commit = await this.getCommitFromGraphItemRef(item);