Adds explain stash command

Author: d13

contributions.json

@@ -36,6 +36,21 @@
 				]
 			}
 		},
+		"gitlens.ai.explainStash": {
+			"label": "Explain Stash (Preview)...",
+			"commandPalette": "gitlens:enabled && !gitlens:readonly && !gitlens:untrusted && gitlens:gk:organization:ai:enabled",
+			"menus": {
+				"view/item/context": [
+					{
+						"when": "viewItem =~ /gitlens:stash\\b/ && !listMultiSelection && !gitlens:readonly && !gitlens:untrusted && gitlens:gk:organization:ai:enabled",
+						"group": "3_gitlens_ai",
+						"order": 1
+					}
+				]
+			}
+		},
+			"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

@@ -6032,6 +6032,11 @@
 				"title": "Explain Commit",
 				"category": "GitLens"
 			},
+			{
+				"command": "gitlens.ai.explainStash",
+				"title": "Explain Stash (Preview)...",
+				"category": "GitLens"
+			},
 			{
 				"command": "gitlens.ai.generateChangelog",
 				"title": "Generate Changelog (Preview)...",
@@ -10335,6 +10340,10 @@
 					"command": "gitlens.addAuthors",
 					"when": "gitlens:enabled && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders"
 				},
+				{
+					"command": "gitlens.ai.explainStash",
+					"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"
@@ -17603,6 +17612,11 @@
 					"when": "viewItem == gitlens:stash && listMultiSelection && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders",
 					"group": "1_gitlens_actions@3"
 				},
+				{
+					"command": "gitlens.ai.explainStash",
+					"when": "viewItem =~ /gitlens:stash\\b/ && !listMultiSelection && !gitlens:readonly && !gitlens:untrusted && gitlens:gk:organization:ai:enabled",
+					"group": "3_gitlens_ai@1"
+				},
 				{
 					"command": "gitlens.stashSave",
 					"when": "viewItem =~ /^gitlens:(stashes|status:files)$/ && !gitlens:readonly && !gitlens:untrusted && !gitlens:hasVirtualFolders",

src/commands.ts

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

src/commands/explainStash.ts

@@ -0,0 +1,101 @@
+import type { TextEditor, Uri } from 'vscode';
+import { ProgressLocation } from 'vscode';
+import type { Container } from '../container';
+import { GitUri } from '../git/gitUri';
+import type { GitStashCommit } from '../git/models/commit';
+import { showGenericErrorMessage } from '../messages';
+import type { AIExplainSource } from '../plus/ai/aiProviderService';
+import { getBestRepositoryOrShowPicker } from '../quickpicks/repositoryPicker';
+import { showStashPicker } from '../quickpicks/stashPicker';
+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';
+import { isCommandContextViewNodeHasCommit } from './commandContext.utils';
+
+export interface ExplainStashCommandArgs {
+	repoPath?: string | Uri;
+	ref?: string;
+	source?: AIExplainSource;
+}
+
+@command()
+export class ExplainStashCommand extends GlCommandBase {
+	constructor(private readonly container: Container) {
+		super('gitlens.ai.explainStash');
+	}
+
+	protected override preExecute(context: CommandContext, args?: ExplainStashCommandArgs): Promise<void> {
+		// Check if the command is being called from a CommitNode
+		if (isCommandContextViewNodeHasCommit<GitStashCommit>(context)) {
+			args = { ...args };
+			args.repoPath = args.repoPath ?? context.node.commit.repoPath;
+			args.ref = args.ref ?? context.node.commit.sha;
+			args.source = args.source ?? { source: 'view', type: 'stash' };
+		}
+
+		return this.execute(context.editor, context.uri, args);
+	}
+
+	async execute(editor?: TextEditor, uri?: Uri, args?: ExplainStashCommandArgs): Promise<void> {
+		args = { ...args };
+
+		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 Stash',
+				'Choose which repository to explain a stash from',
+			);
+		}
+
+		if (repository == null) return;
+
+		try {
+			// If no ref is provided, show a picker to select a stash
+			if (args.ref == null) {
+				const pick = await showStashPicker('Explain Stash', 'Choose a stash to explain', repository);
+				if (pick?.ref == null) return;
+				args.ref = pick.ref;
+			}
+
+			// Get the stash commit
+			const commit = await repository.git.commits().getCommit(args.ref);
+			if (commit == null) {
+				void showGenericErrorMessage('Unable to find the specified stash commit');
+				return;
+			}
+
+			// Call the AI service to explain the stash
+			const result = await this.container.ai.explainCommit(
+				commit,
+				args.source ?? { source: 'commandPalette', type: 'stash' },
+				{
+					progress: { location: ProgressLocation.Notification, title: 'Explaining stash...' },
+				},
+			);
+
+			// Display the result
+			let content = `# Stash Summary\n\n`;
+			if (result != null) {
+				content += `> Generated by ${result.model.name}\n\n## ${commit.message || commit.ref}}\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, 'ExplainStashCommand', 'execute');
+			void showGenericErrorMessage('Unable to explain stash');
+		}
+	}
+}

src/constants.commands.generated.ts

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

src/quickpicks/stashPicker.ts

@@ -0,0 +1,93 @@
+import type { Disposable } from 'vscode';
+import { window } from 'vscode';
+import { RevealInSideBarQuickInputButton, ShowDetailsViewQuickInputButton } from '../commands/quickCommand.buttons';
+import * as StashActions from '../git/actions/stash';
+import type { GitStashCommit } from '../git/models/commit';
+import { Repository } from '../git/models/repository';
+import { getQuickPickIgnoreFocusOut } from '../system/-webview/vscode';
+import type { CommitQuickPickItem } from './items/gitWizard';
+import { createStashQuickPickItem } from './items/gitWizard';
+
+export async function showStashPicker(
+	title: string | undefined,
+	placeholder?: string,
+	repository?: Repository | Repository[],
+	options?: {
+		filter?: (b: GitStashCommit) => boolean;
+	},
+): Promise<GitStashCommit | undefined> {
+	if (repository == null) {
+		return undefined;
+	}
+
+	if (repository instanceof Repository) {
+		repository = [repository];
+	}
+
+	let stashes: GitStashCommit[] = [];
+	for (const repo of repository) {
+		const stash = await repo.git.stash()?.getStash();
+		if (stash == null || stash.stashes.size === 0) {
+			continue;
+		}
+
+		stashes.push(...stash.stashes.values());
+	}
+
+	if (options?.filter != null) {
+		stashes = stashes.filter(options.filter);
+	}
+
+	if (stashes.length === 0) {
+		return undefined;
+	}
+
+	const items: CommitQuickPickItem<GitStashCommit>[] = stashes.map(stash =>
+		createStashQuickPickItem(stash, false, {
+			buttons: [ShowDetailsViewQuickInputButton, RevealInSideBarQuickInputButton],
+			compact: true,
+			icon: true,
+		}),
+	);
+
+	const quickpick = window.createQuickPick<CommitQuickPickItem<GitStashCommit>>();
+	quickpick.ignoreFocusOut = getQuickPickIgnoreFocusOut();
+	const disposables: Disposable[] = [];
+
+	try {
+		const pick = await new Promise<CommitQuickPickItem<GitStashCommit> | undefined>(resolve => {
+			disposables.push(
+				quickpick.onDidHide(() => resolve(undefined)),
+				quickpick.onDidAccept(() => {
+					if (quickpick.activeItems.length !== 0) {
+						resolve(quickpick.activeItems[0]);
+					}
+				}),
+				quickpick.onDidTriggerItemButton(e => {
+					if (e.button === ShowDetailsViewQuickInputButton) {
+						void StashActions.showDetailsView(e.item.item, { pin: false, preserveFocus: true });
+					} else if (e.button === RevealInSideBarQuickInputButton) {
+						void StashActions.reveal(e.item.item, {
+							select: true,
+							focus: false,
+							expand: true,
+						});
+					}
+				}),
+			);
+
+			quickpick.title = title;
+			quickpick.placeholder = placeholder;
+			quickpick.matchOnDescription = true;
+			quickpick.matchOnDetail = true;
+			quickpick.items = items;
+
+			quickpick.show();
+		});
+
+		return pick?.item;
+	} finally {
+		quickpick.dispose();
+		disposables.forEach(d => void d.dispose());
+	}
+}