Adds explain commit/wip to hovers

eamodio · eamodio · commit 5940b8b1a71d · 2025-05-13T01:33:38.000-04:00
Adds Copy SHA to hover
diff --git a/docs/telemetry-events.md b/docs/telemetry-events.md
@@ -1593,7 +1593,7 @@ void
   'repoPrivacy': 'private' | 'public' | 'local',
   'repository.visibility': 'private' | 'public' | 'local',
   // Provided for compatibility with other GK surfaces
-  'source': 'account' | 'subscription' | 'graph' | 'patchDetails' | 'settings' | 'timeline' | 'home' | 'view' | 'code-suggest' | 'ai' | 'ai:picker' | 'associateIssueWithBranch' | 'cloud-patches' | 'commandPalette' | 'deeplink' | 'feature-badge' | 'feature-gate' | 'inspect' | 'inspect-overview' | 'integrations' | 'launchpad' | 'launchpad-indicator' | 'launchpad-view' | 'merge-target' | 'notification' | 'prompt' | 'quick-wizard' | 'remoteProvider' | 'startWork' | 'trial-indicator' | 'scm-input' | 'walkthrough' | 'whatsnew' | 'worktrees'
+  'source': 'account' | 'subscription' | 'graph' | 'patchDetails' | 'settings' | 'timeline' | 'home' | 'view' | 'code-suggest' | 'ai' | 'ai:picker' | 'associateIssueWithBranch' | 'cloud-patches' | 'commandPalette' | 'deeplink' | 'editor:hover' | 'feature-badge' | 'feature-gate' | 'inspect' | 'inspect-overview' | 'integrations' | 'launchpad' | 'launchpad-indicator' | 'launchpad-view' | 'merge-target' | 'notification' | 'prompt' | 'quick-wizard' | 'remoteProvider' | 'startWork' | 'trial-indicator' | 'scm-input' | 'walkthrough' | 'whatsnew' | 'worktrees'
 }
 ```
 
diff --git a/src/commands/copyShaToClipboard.ts b/src/commands/copyShaToClipboard.ts
@@ -6,6 +6,7 @@ import { shortenRevision } from '../git/utils/revision.utils';
 import { showGenericErrorMessage } from '../messages';
 import { command } from '../system/-webview/command';
 import { configuration } from '../system/-webview/configuration';
+import { createMarkdownCommandLink } from '../system/commands';
 import { first } from '../system/iterable';
 import { Logger } from '../system/logger';
 import { ActiveEditorCommand } from './commandBase';
@@ -23,6 +24,13 @@ export interface CopyShaToClipboardCommandArgs {
 
 @command()
 export class CopyShaToClipboardCommand extends ActiveEditorCommand {
+	static createMarkdownCommandLink(sha: string): string;
+	static createMarkdownCommandLink(args: CopyShaToClipboardCommandArgs): string;
+	static createMarkdownCommandLink(argsOrSha: CopyShaToClipboardCommandArgs | string): string {
+		const args = typeof argsOrSha === 'string' ? { sha: argsOrSha } : argsOrSha;
+		return createMarkdownCommandLink<CopyShaToClipboardCommandArgs>('gitlens.copyShaToClipboard', args);
+	}
+
 	constructor(private readonly container: Container) {
 		super('gitlens.copyShaToClipboard');
 	}
diff --git a/src/commands/explainCommit.ts b/src/commands/explainCommit.ts
@@ -10,6 +10,7 @@ import { showCommitPicker } from '../quickpicks/commitPicker';
 import { getBestRepositoryOrShowPicker } from '../quickpicks/repositoryPicker';
 import { command } from '../system/-webview/command';
 import { showMarkdownPreview } from '../system/-webview/markdown';
+import { createMarkdownCommandLink } from '../system/commands';
 import { Logger } from '../system/logger';
 import { getNodeRepoPath } from '../views/nodes/abstract/viewNode';
 import { GlCommandBase } from './commandBase';
@@ -25,8 +26,12 @@ export interface ExplainCommitCommandArgs {
 
 @command()
 export class ExplainCommitCommand extends GlCommandBase {
+	static createMarkdownCommandLink(args: ExplainCommitCommandArgs): string {
+		return createMarkdownCommandLink<ExplainCommitCommandArgs>('gitlens.ai.explainCommit:editor', args);
+	}
+
 	constructor(private readonly container: Container) {
-		super(['gitlens.ai.explainCommit', 'gitlens.ai.explainCommit:views']);
+		super(['gitlens.ai.explainCommit', 'gitlens.ai.explainCommit:editor', 'gitlens.ai.explainCommit:views']);
 	}
 
 	protected override preExecute(context: CommandContext, args?: ExplainCommitCommandArgs): Promise<void> {
diff --git a/src/commands/explainWip.ts b/src/commands/explainWip.ts
@@ -8,6 +8,7 @@ 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 { createMarkdownCommandLink } from '../system/commands';
 import { Logger } from '../system/logger';
 import { GlCommandBase } from './commandBase';
 import { getCommandUri } from './commandBase.utils';
@@ -27,8 +28,12 @@ export interface ExplainWipCommandArgs {
 
 @command()
 export class ExplainWipCommand extends GlCommandBase {
+	static createMarkdownCommandLink(args: ExplainWipCommandArgs): string {
+		return createMarkdownCommandLink<ExplainWipCommandArgs>('gitlens.ai.explainWip:editor', args);
+	}
+
 	constructor(private readonly container: Container) {
-		super(['gitlens.ai.explainWip', 'gitlens.ai.explainWip:views']);
+		super(['gitlens.ai.explainWip', 'gitlens.ai.explainWip:editor', 'gitlens.ai.explainWip:views']);
 	}
 
 	protected override preExecute(context: CommandContext, args?: ExplainWipCommandArgs): Promise<void> {
@@ -61,15 +66,18 @@ export class ExplainWipCommand extends GlCommandBase {
 		}
 
 		try {
-			// If args?.staged is undefined, should we get all changes (staged and unstaged)?
+			// If args?.staged is undefined, get all changes (staged and unstaged)?
 			let stagedLabel;
 			let to;
 			if (args?.staged === true) {
 				stagedLabel = 'Staged';
 				to = uncommittedStaged;
-			} else {
+			} else if (args?.staged === false) {
 				stagedLabel = 'Unstaged';
 				to = uncommitted;
+			} else {
+				stagedLabel = 'Uncommitted';
+				to = '';
 			}
 
 			const diff = await diffService.getDiff(to, undefined);
diff --git a/src/constants.commands.ts b/src/constants.commands.ts
@@ -119,6 +119,8 @@ type InternalGlCommands =
 	| `gitlens.action.${string}`
 	| 'gitlens.changeBranchMergeTarget'
 	| 'gitlens.diffWith'
+	| 'gitlens.ai.explainCommit:editor'
+	| 'gitlens.ai.explainWip:editor'
 	| 'gitlens.openOnRemote'
 	| 'gitlens.openWalkthrough'
 	| 'gitlens.refreshHover'
diff --git a/src/constants.telemetry.ts b/src/constants.telemetry.ts
@@ -980,6 +980,7 @@ export type Sources =
 	| 'cloud-patches'
 	| 'commandPalette'
 	| 'deeplink'
+	| 'editor:hover'
 	| 'feature-badge'
 	| 'feature-gate'
 	| 'graph'
diff --git a/src/git/formatters/commitFormatter.ts b/src/git/formatters/commitFormatter.ts
@@ -7,7 +7,10 @@ import type {
 } from '../../api/gitlens';
 import type { MaybeEnrichedAutolink } from '../../autolinks/models/autolinks';
 import { getPresenceDataUri } from '../../avatars';
+import { CopyShaToClipboardCommand } from '../../commands/copyShaToClipboard';
 import { DiffWithCommand } from '../../commands/diffWith';
+import { ExplainCommitCommand } from '../../commands/explainCommit';
+import { ExplainWipCommand } from '../../commands/explainWip';
 import { InspectCommand } from '../../commands/inspect';
 import { OpenCommitOnRemoteCommand } from '../../commands/openCommitOnRemote';
 import { OpenFileAtRevisionCommand } from '../../commands/openFileAtRevision';
@@ -46,6 +49,7 @@ import type { FormatOptions, RequiredTokenOptions } from './formatter';
 import { Formatter } from './formatter';
 
 export interface CommitFormatOptions extends FormatOptions {
+	aiEnabled?: boolean;
 	avatarSize?: number;
 	dateStyle?: DateStyle;
 	editor?: { line: number; uri: Uri };
@@ -410,6 +414,8 @@ export class CommitFormatter extends Formatter<GitCommit, CommitFormatOptions> {
 			return this._padOrTruncate('', this._options.tokenOptions.commands);
 		}
 
+		const separator = ' &nbsp;&nbsp;|&nbsp;&nbsp; ';
+
 		let commands;
 		if (this._item.isUncommitted) {
 			const { previousLineComparisonUris: diffUris } = this._options;
@@ -422,7 +428,7 @@ export class CommitFormatter extends Formatter<GitCommit, CommitFormatOptions> {
 					this._item.repoPath,
 				)} "Inspect Commit Details")`;
 
-				commands += ` &nbsp;[$(chevron-left)$(compare-changes)](${DiffWithCommand.createMarkdownCommandLink({
+				commands += ` &nbsp;[$(compare-changes)](${DiffWithCommand.createMarkdownCommandLink({
 					lhs: { sha: diffUris.previous.sha ?? '', uri: diffUris.previous.documentUri() },
 					rhs: { sha: diffUris.current.sha ?? '', uri: diffUris.current.documentUri() },
 					repoPath: this._item.repoPath,
@@ -444,17 +450,27 @@ export class CommitFormatter extends Formatter<GitCommit, CommitFormatOptions> {
 				)} "Inspect Commit Details")`;
 			}
 
+			if (this._options.aiEnabled) {
+				commands += `${separator}[$(sparkle) Explain](${ExplainWipCommand.createMarkdownCommandLink({
+					repoPath: this._item.repoPath,
+					staged: undefined,
+					source: { source: 'editor:hover', type: 'wip' },
+				})} "Explain Changes")`;
+			}
+
 			return commands;
 		}
 
-		const separator = ' &nbsp;&nbsp;|&nbsp;&nbsp; ';
-
 		commands = `---\n\n[\`$(git-commit) ${this.id}\`](${InspectCommand.createMarkdownCommandLink(
 			this._item.sha,
 			this._item.repoPath,
 		)} "Inspect Commit Details")`;
 
-		commands += ` &nbsp;[$(chevron-left)$(compare-changes)](${DiffWithCommand.createMarkdownCommandLink(
+		commands += ` &nbsp;[$(copy)](${CopyShaToClipboardCommand.createMarkdownCommandLink(
+			this._item.sha,
+		)} "Copy SHA")`;
+
+		commands += ` &nbsp;[$(compare-changes)](${DiffWithCommand.createMarkdownCommandLink(
 			this._item,
 			editorLineToDiffRange(this._options.editor?.line),
 		)} "Open Changes with Previous Revision")`;
@@ -472,7 +488,7 @@ export class CommitFormatter extends Formatter<GitCommit, CommitFormatOptions> {
 			)} "Open Blame Prior to this Change")`;
 		}
 
-		commands += ` &nbsp;[$(search)](${createMarkdownCommandLink<ShowQuickCommitCommandArgs>(
+		commands += `${separator}[$(search)](${createMarkdownCommandLink<ShowQuickCommitCommandArgs>(
 			'gitlens.revealCommitInView',
 			{ repoPath: this._item.repoPath, sha: this._item.sha, revealInView: true },
 		)} "Reveal in Side Bar")`;
@@ -495,6 +511,14 @@ export class CommitFormatter extends Formatter<GitCommit, CommitFormatOptions> {
 			)} "Open Commit on ${providers?.length ? providers[0].name : 'Remote'}")`;
 		}
 
+		if (this._options.aiEnabled) {
+			commands += `${separator}[$(sparkle) Explain](${ExplainCommitCommand.createMarkdownCommandLink({
+				repoPath: this._item.repoPath,
+				rev: this._item.sha,
+				source: { source: 'editor:hover', type: isStash(this._item) ? 'stash' : 'commit' },
+			})} "Explain Changes")`;
+		}
+
 		if (pr != null) {
 			if (isPullRequest(pr)) {
 				commands += `${separator}[$(git-pull-request) PR #${
@@ -532,19 +556,20 @@ export class CommitFormatter extends Formatter<GitCommit, CommitFormatOptions> {
 		if (Container.instance.actionRunners.count('hover.commands') > 0) {
 			const { name, email } = this._item.author;
 
-			commands += `${separator}[$(organization) Team${GlyphChars.SpaceThinnest}${
-				GlyphChars.Ellipsis
-			}](${createMarkdownActionCommandLink<HoverCommandsActionContext>('hover.commands', {
-				repoPath: this._item.repoPath,
-				commit: {
-					sha: this._item.sha,
-					author: { name: name, email: email, presence: this._options.presence },
+			commands += `${separator}[$(organization)](${createMarkdownActionCommandLink<HoverCommandsActionContext>(
+				'hover.commands',
+				{
+					repoPath: this._item.repoPath,
+					commit: {
+						sha: this._item.sha,
+						author: { name: name, email: email, presence: this._options.presence },
+					},
+					file:
+						this._options.editor != null
+							? { uri: this._options.editor?.uri.toString(), line: this._options.editor?.line }
+							: undefined,
 				},
-				file:
-					this._options.editor != null
-						? { uri: this._options.editor?.uri.toString(), line: this._options.editor?.line }
-						: undefined,
-			})} "Show Team Actions")`;
+			)} "Show Team Actions")`;
 		}
 
 		const gitUri = this._item.getGitUri();
diff --git a/src/hovers/hovers.ts b/src/hovers/hovers.ts
@@ -270,6 +270,7 @@ export async function detailsMessage(
 	const previousLineComparisonUris = getSettledValue(previousLineComparisonUrisResult);
 
 	const details = await CommitFormatter.fromTemplateAsync(options.format, commit, {
+		aiEnabled: configuration.get('ai.enabled'),
 		enrichedAutolinks: enrichedResult?.value != null && !enrichedResult.paused ? enrichedResult.value : undefined,
 		dateFormat: options.dateFormat === null ? 'MMMM Do, YYYY h:mma' : options.dateFormat,
 		editor: { line: editorLine, uri: uri },

Original file line number	Diff line number	Diff line change
`@@ -1593,7 +1593,7 @@ void`
`1593`	`1593`	`'repoPrivacy': 'private' \| 'public' \| 'local',`
`1594`	`1594`	`'repository.visibility': 'private' \| 'public' \| 'local',`
`1595`	`1595`	`// Provided for compatibility with other GK surfaces`
`1596`		- 'source': 'account' \| 'subscription' \| 'graph' \| 'patchDetails' \| 'settings' \| 'timeline' \| 'home' \| 'view' \| 'code-suggest' \| 'ai' \| 'ai:picker' \| 'associateIssueWithBranch' \| 'cloud-patches' \| 'commandPalette' \| 'deeplink' \| 'feature-badge' \| 'feature-gate' \| 'inspect' \| 'inspect-overview' \| 'integrations' \| 'launchpad' \| 'launchpad-indicator' \| 'launchpad-view' \| 'merge-target' \| 'notification' \| 'prompt' \| 'quick-wizard' \| 'remoteProvider' \| 'startWork' \| 'trial-indicator' \| 'scm-input' \| 'walkthrough' \| 'whatsnew' \| 'worktrees'
	`1596`	+ 'source': 'account' \| 'subscription' \| 'graph' \| 'patchDetails' \| 'settings' \| 'timeline' \| 'home' \| 'view' \| 'code-suggest' \| 'ai' \| 'ai:picker' \| 'associateIssueWithBranch' \| 'cloud-patches' \| 'commandPalette' \| 'deeplink' \| 'editor:hover' \| 'feature-badge' \| 'feature-gate' \| 'inspect' \| 'inspect-overview' \| 'integrations' \| 'launchpad' \| 'launchpad-indicator' \| 'launchpad-view' \| 'merge-target' \| 'notification' \| 'prompt' \| 'quick-wizard' \| 'remoteProvider' \| 'startWork' \| 'trial-indicator' \| 'scm-input' \| 'walkthrough' \| 'whatsnew' \| 'worktrees'
`1597`	`1597`	`}`
`1598`	`1598`	```
`1599`	`1599`