Explain work in progress (wip)

Author: d13

contributions.json

@@ -49,6 +49,10 @@
 				]
 			}
 		},
+		"gitlens.ai.explainWip": {
+			"label": "Explain Working Changes (Preview)...",
+			"commandPalette": "gitlens:enabled && !gitlens:readonly && !gitlens:untrusted && gitlens:gk:organization:ai:enabled"
+		},
 		"gitlens.ai.generateChangelog": {
 			"label": "Generate Changelog (Preview)...",
 			"commandPalette": "gitlens:enabled && !gitlens:untrusted && gitlens:gk:organization:ai:enabled"

package.json

@@ -6064,6 +6064,11 @@
 				"title": "Explain Stash (Preview)...",
 				"category": "GitLens"
 			},
+			{
+				"command": "gitlens.ai.explainWip",
+				"title": "Explain Working Changes (Preview)...",
+				"category": "GitLens"
+			},
 			{
 				"command": "gitlens.ai.generateChangelog",
 				"title": "Generate Changelog (Preview)...",
@@ -10388,6 +10393,10 @@
 					"command": "gitlens.ai.explainStash",
 					"when": "gitlens:enabled && !gitlens:readonly && !gitlens:untrusted && gitlens:gk:organization:ai:enabled"
 				},
+				{
+					"command": "gitlens.ai.explainWip",
+					"when": "gitlens:enabled && !gitlens:readonly && !gitlens:untrusted && gitlens:gk:organization:ai:enabled"
+				},
 				{
 					"command": "gitlens.ai.generateChangelog",
 					"when": "gitlens:enabled && !gitlens:untrusted && gitlens:gk:organization:ai:enabled"

src/commands.ts

@@ -23,6 +23,7 @@ import './commands/diffWithWorking';
 import './commands/externalDiff';
 import './commands/explainCommit';
 import './commands/explainStash';
+import './commands/explainWip';
 import './commands/generateChangelog';
 import './commands/generateCommitMessage';
 import './commands/ghpr/openOrCreateWorktree';

src/commands/explainWip.ts

@@ -0,0 +1,85 @@
+import type { TextEditor, Uri } from 'vscode';
+import { ProgressLocation } from 'vscode';
+import type { Container } from '../container';
+import { GitUri } from '../git/gitUri';
+import { uncommitted, uncommittedStaged } from '../git/models/revision';
+import { showGenericErrorMessage } from '../messages';
+import type { AIExplainSource } from '../plus/ai/aiProviderService';
+import { getBestRepositoryOrShowPicker } from '../quickpicks/repositoryPicker';
+import { command } from '../system/-webview/command';
+import { showMarkdownPreview } from '../system/-webview/markdown';
+import { Logger } from '../system/logger';
+import { GlCommandBase } from './commandBase';
+import { getCommandUri } from './commandBase.utils';
+import type { CommandContext } from './commandContext';
+
+export interface ExplainWipCommandArgs {
+	repoPath?: string | Uri;
+	staged?: boolean;
+	source?: AIExplainSource;
+}
+
+@command()
+export class ExplainWipCommand extends GlCommandBase {
+	constructor(private readonly container: Container) {
+		super('gitlens.ai.explainWip');
+	}
+
+	protected override preExecute(context: CommandContext, args?: ExplainWipCommandArgs): Promise<void> {
+		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;
+
+		const repository = await getBestRepositoryOrShowPicker(
+			gitUri,
+			editor,
+			'Explain Working Changes',
+			'Choose which repository to explain working changes from',
+		);
+		if (repository == null) return;
+
+		try {
+			// Get the diff of working changes
+			const diffService = repository.git.diff();
+			if (diffService?.getDiff === undefined) {
+				void showGenericErrorMessage('Unable to get diff service');
+				return;
+			}
+
+			const diff = await diffService.getDiff(args?.staged ? uncommittedStaged : uncommitted);
+			if (!diff?.contents) {
+				void showGenericErrorMessage('No working changes found to explain');
+				return;
+			}
+
+			// Call the AI service to explain the changes
+			const result = await this.container.ai.explainChanges(
+				{
+					diff: diff.contents,
+					message: args?.staged ? 'Staged working changes' : 'Unstaged working changes',
+				},
+				args.source ?? { source: 'commandPalette', type: 'wip' },
+				{
+					progress: { location: ProgressLocation.Notification, title: 'Explaining working changes...' },
+				},
+			);
+
+			// Display the result
+			let content = `# ${args?.staged ? 'Staged' : 'Unstaged'} Working Changes\n`;
+			if (result != null) {
+				content += `> Generated by ${result.model.name}\n\n----\n\n${result?.parsed.summary}\n\n${result?.parsed.body}`;
+			} else {
+				content += `> No changes found to explain.`;
+			}
+			void showMarkdownPreview(content);
+		} catch (ex) {
+			Logger.error(ex, 'ExplainWipCommand', 'execute');
+			void showGenericErrorMessage('Unable to explain working changes');
+		}
+	}
+}

src/constants.commands.generated.ts

@@ -615,6 +615,7 @@ export type ContributedPaletteCommands =
 	| 'gitlens.addAuthors'
 	| 'gitlens.ai.explainCommit'
 	| 'gitlens.ai.explainStash'
+	| 'gitlens.ai.explainWip'
 	| 'gitlens.ai.generateChangelog'
 	| 'gitlens.ai.generateCommitMessage'
 	| 'gitlens.applyPatchFromClipboard'