Fixes missing required type on Source

eamodio · eamodio · commit 18c8f01d4706 · 2025-05-13T01:13:13.000-04:00
diff --git a/src/commands/explainBranch.ts b/src/commands/explainBranch.ts
@@ -1,11 +1,11 @@
 import type { TextEditor, Uri } from 'vscode';
 import { ProgressLocation } from 'vscode';
-import type { Source } from '../constants.telemetry';
 import type { Container } from '../container';
 import { GitUri } from '../git/gitUri';
 import type { GitBranchReference } from '../git/models/reference';
 import { getBranchMergeTargetName } from '../git/utils/-webview/branch.utils';
 import { showGenericErrorMessage } from '../messages';
+import type { AIExplainSource } from '../plus/ai/aiProviderService';
 import { prepareCompareDataForAIRequest } from '../plus/ai/aiProviderService';
 import { ReferencesQuickPickIncludes, showReferencePicker } from '../quickpicks/referencePicker';
 import { getBestRepositoryOrShowPicker } from '../quickpicks/repositoryPicker';
@@ -21,7 +21,7 @@ import { isCommandContextViewNodeHasBranch } from './commandContext.utils';
 export interface ExplainBranchCommandArgs {
 	repoPath?: string | Uri;
 	ref?: string;
-	source?: Source;
+	source?: AIExplainSource;
 }
 
 @command()
@@ -35,7 +35,7 @@ export class ExplainBranchCommand extends GlCommandBase {
 			args = { ...args };
 			args.repoPath = args.repoPath ?? getNodeRepoPath(context.node);
 			args.ref = args.ref ?? context.node.branch.ref;
-			args.source = args.source ?? { source: 'view' };
+			args.source = args.source ?? { source: 'view', type: 'branch' };
 		}
 
 		return this.execute(context.editor, context.uri, args);
diff --git a/src/commands/explainCommit.ts b/src/commands/explainCommit.ts
@@ -1,10 +1,11 @@
 import type { TextEditor, Uri } from 'vscode';
 import { ProgressLocation } from 'vscode';
-import type { Source } from '../constants.telemetry';
 import type { Container } from '../container';
 import { GitUri } from '../git/gitUri';
 import type { GitCommit } from '../git/models/commit';
+import { isStash } from '../git/models/commit';
 import { showGenericErrorMessage } from '../messages';
+import type { AIExplainSource } from '../plus/ai/aiProviderService';
 import { showCommitPicker } from '../quickpicks/commitPicker';
 import { getBestRepositoryOrShowPicker } from '../quickpicks/repositoryPicker';
 import { command } from '../system/-webview/command';
@@ -18,8 +19,8 @@ import { isCommandContextViewNodeHasCommit } from './commandContext.utils';
 
 export interface ExplainCommitCommandArgs {
 	repoPath?: string | Uri;
-	ref?: string;
-	source?: Source;
+	rev?: string;
+	source?: AIExplainSource;
 }
 
 @command()
@@ -33,8 +34,11 @@ export class ExplainCommitCommand extends GlCommandBase {
 		if (isCommandContextViewNodeHasCommit(context)) {
 			args = { ...args };
 			args.repoPath = args.repoPath ?? getNodeRepoPath(context.node);
-			args.ref = args.ref ?? context.node.commit.sha;
-			args.source = args.source ?? { source: 'view' };
+			args.rev = args.rev ?? context.node.commit.sha;
+			args.source = args.source ?? {
+				source: 'view',
+				type: isStash(context.node.commit) ? 'stash' : 'commit',
+			};
 		}
 
 		return this.execute(context.editor, context.uri, args);
@@ -63,16 +67,16 @@ export class ExplainCommitCommand extends GlCommandBase {
 
 		try {
 			let commit: GitCommit | undefined;
-			if (args.ref == null) {
+			if (args.rev == null) {
 				const commitsProvider = repository.git.commits();
 				const log = await commitsProvider.getLog();
 				const pick = await showCommitPicker(log, 'Explain Commit', 'Choose a commit to explain');
 				if (pick?.sha == null) return;
-				args.ref = pick.sha;
+				args.rev = pick.sha;
 				commit = pick;
 			} else {
 				// Get the commit
-				commit = await repository.git.commits().getCommit(args.ref);
+				commit = await repository.git.commits().getCommit(args.rev);
 				if (commit == null) {
 					void showGenericErrorMessage('Unable to find the specified commit');
 					return;
diff --git a/src/commands/explainStash.ts b/src/commands/explainStash.ts
@@ -1,10 +1,10 @@
 import type { TextEditor, Uri } from 'vscode';
 import { ProgressLocation } from 'vscode';
-import type { Source } from '../constants.telemetry';
 import type { Container } from '../container';
 import { GitUri } from '../git/gitUri';
 import type { GitCommit, 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';
@@ -17,8 +17,8 @@ import { isCommandContextViewNodeHasCommit } from './commandContext.utils';
 
 export interface ExplainStashCommandArgs {
 	repoPath?: string | Uri;
-	ref?: string;
-	source?: Source;
+	rev?: string;
+	source?: AIExplainSource;
 }
 
 @command()
@@ -32,8 +32,8 @@ export class ExplainStashCommand extends GlCommandBase {
 		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' };
+			args.rev = args.rev ?? context.node.commit.sha;
+			args.source = args.source ?? { source: 'view', type: 'stash' };
 		}
 
 		return this.execute(context.editor, context.uri, args);
@@ -62,13 +62,13 @@ export class ExplainStashCommand extends GlCommandBase {
 
 		try {
 			let commit: GitCommit | undefined;
-			if (args.ref == null) {
+			if (args.rev == null) {
 				const pick = await showStashPicker('Explain Stash', 'Choose a stash to explain', repository);
 				if (pick?.ref == null) return;
-				args.ref = pick.ref;
+				args.rev = pick.ref;
 				commit = pick;
 			} else {
-				commit = await repository.git.commits().getCommit(args.ref);
+				commit = await repository.git.commits().getCommit(args.rev);
 				if (commit == null) {
 					void showGenericErrorMessage('Unable to find the specified stash commit');
 					return;
diff --git a/src/commands/explainWip.ts b/src/commands/explainWip.ts
@@ -1,10 +1,10 @@
 import type { TextEditor, Uri } from 'vscode';
 import { ProgressLocation } from 'vscode';
-import type { Source } from '../constants.telemetry';
 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';
@@ -21,7 +21,7 @@ import {
 export interface ExplainWipCommandArgs {
 	repoPath?: string | Uri;
 	staged?: boolean;
-	source?: Source;
+	source?: AIExplainSource;
 	worktreePath?: string;
 }
 
@@ -36,15 +36,15 @@ export class ExplainWipCommand extends GlCommandBase {
 			args = { ...args };
 			args.repoPath = context.node.worktree.repoPath;
 			args.worktreePath = context.node.worktree.path;
-			args.source = args.source ?? { source: 'view' };
+			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' };
+			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' };
+			args.source = args.source ?? { source: 'view', type: 'wip' };
 		}
 
 		return this.execute(context.editor, context.uri, args);
diff --git a/src/git/actions/commit.ts b/src/git/actions/commit.ts
@@ -755,12 +755,12 @@ export async function showInCommitGraph(
 
 export async function explainCommit(
 	commit: GitRevisionReference | GitCommit,
-	options?: { source?: Source },
+	options: { source: Source },
 ): Promise<void> {
 	void (await executeCommand<ExplainCommitCommandArgs>('gitlens.ai.explainCommit', {
 		repoPath: commit.repoPath,
-		ref: commit.ref,
-		source: options?.source,
+		rev: commit.ref,
+		source: { ...options?.source, type: 'commit' },
 	}));
 }
 
diff --git a/src/quickpicks/items/commits.ts b/src/quickpicks/items/commits.ts
@@ -296,11 +296,7 @@ export class CommitExplainCommandQuickPickItem extends CommandQuickPickItem {
 	}
 
 	override execute(_options: { preserveFocus?: boolean; preview?: boolean }): Promise<void> {
-		return CommitActions.explainCommit(this.commit, {
-			source: {
-				source: 'commandPalette',
-			},
-		});
+		return CommitActions.explainCommit(this.commit, { source: { source: 'commandPalette' } });
 	}
 }
 
diff --git a/src/webviews/commitDetails/commitDetailsWebview.ts b/src/webviews/commitDetails/commitDetailsWebview.ts
@@ -6,6 +6,8 @@ import { serializeAutolink } from '../../autolinks/utils/-webview/autolinks.util
 import { getAvatarUri } from '../../avatars';
 import type { CopyMessageToClipboardCommandArgs } from '../../commands/copyMessageToClipboard';
 import type { CopyShaToClipboardCommandArgs } from '../../commands/copyShaToClipboard';
+import type { ExplainCommitCommandArgs } from '../../commands/explainCommit';
+import type { ExplainStashCommandArgs } from '../../commands/explainStash';
 import type { OpenPullRequestOnRemoteCommandArgs } from '../../commands/openPullRequestOnRemote';
 import type { ContextKeys } from '../../constants.context';
 import type { InspectTelemetryContext, Sources } from '../../constants.telemetry';
@@ -1097,11 +1099,14 @@ export class CommitDetailsWebviewProvider
 		let params: DidExplainParams;
 		try {
 			const isStashCommit = isStash(this._context.commit);
-			await executeCommand(isStashCommit ? 'gitlens.ai.explainStash' : 'gitlens.ai.explainCommit', {
-				repoPath: this._context.commit!.repoPath,
-				ref: this._context.commit!.sha,
-				source: { source: 'inspect', type: isStashCommit ? 'stash' : 'commit' },
-			});
+			await executeCommand<ExplainCommitCommandArgs | ExplainStashCommandArgs>(
+				isStashCommit ? 'gitlens.ai.explainStash' : 'gitlens.ai.explainCommit',
+				{
+					repoPath: this._context.commit!.repoPath,
+					rev: this._context.commit!.sha,
+					source: { source: 'inspect', type: isStashCommit ? 'stash' : 'commit' },
+				},
+			);
 
 			params = { result: { summary: '', body: '' } };
 		} catch (ex) {
diff --git a/src/webviews/home/homeWebview.ts b/src/webviews/home/homeWebview.ts
@@ -559,7 +559,7 @@ export class HomeWebviewProvider implements WebviewProvider<State, State, HomeWe
 		void executeCommand<ExplainBranchCommandArgs>('gitlens.ai.explainBranch', {
 			repoPath: repo.path,
 			ref: branch?.ref,
-			source: { source: 'home', detail: 'branch' },
+			source: { source: 'home', type: 'branch' },
 		});
 	}
 
@@ -573,7 +573,7 @@ export class HomeWebviewProvider implements WebviewProvider<State, State, HomeWe
 		void executeCommand<ExplainWipCommandArgs>('gitlens.ai.explainWip', {
 			repoPath: repo.path,
 			worktreePath: worktree?.path,
-			source: { source: 'home', detail: 'wip' },
+			source: { source: 'home', type: 'wip' },
 		});
 	}
 
diff --git a/src/webviews/plus/graph/graphWebview.ts b/src/webviews/plus/graph/graphWebview.ts
@@ -6,6 +6,10 @@ import { parseCommandContext } from '../../../commands/commandContext.utils';
 import type { CopyDeepLinkCommandArgs } from '../../../commands/copyDeepLink';
 import type { CopyMessageToClipboardCommandArgs } from '../../../commands/copyMessageToClipboard';
 import type { CopyShaToClipboardCommandArgs } from '../../../commands/copyShaToClipboard';
+import type { ExplainBranchCommandArgs } from '../../../commands/explainBranch';
+import type { ExplainCommitCommandArgs } from '../../../commands/explainCommit';
+import type { ExplainStashCommandArgs } from '../../../commands/explainStash';
+import type { ExplainWipCommandArgs } from '../../../commands/explainWip';
 import type { GenerateChangelogCommandArgs } from '../../../commands/generateChangelog';
 import type { GenerateCommitMessageCommandArgs } from '../../../commands/generateCommitMessage';
 import type { InspectCommandArgs } from '../../../commands/inspect';
@@ -3870,7 +3874,7 @@ export class GraphWebviewProvider implements WebviewProvider<State, State, Graph
 		const ref = this.getGraphItemRef(item, 'branch');
 		if (ref == null) return Promise.resolve();
 
-		return executeCommand('gitlens.ai.explainBranch', {
+		return executeCommand<ExplainBranchCommandArgs>('gitlens.ai.explainBranch', {
 			repoPath: ref.repoPath,
 			ref: ref.ref,
 			source: { source: 'graph', type: 'branch' },
@@ -3881,9 +3885,9 @@ export class GraphWebviewProvider implements WebviewProvider<State, State, Graph
 		const ref = this.getGraphItemRef(item, 'revision');
 		if (ref == null) return Promise.resolve();
 
-		return executeCommand('gitlens.ai.explainCommit', {
+		return executeCommand<ExplainCommitCommandArgs>('gitlens.ai.explainCommit', {
 			repoPath: ref.repoPath,
-			ref: ref.ref,
+			rev: ref.ref,
 			source: { source: 'graph', type: 'commit' },
 		});
 	}
@@ -3893,9 +3897,9 @@ export class GraphWebviewProvider implements WebviewProvider<State, State, Graph
 		const ref = this.getGraphItemRef(item, 'stash');
 		if (ref == null) return Promise.resolve();
 
-		return executeCommand('gitlens.ai.explainStash', {
+		return executeCommand<ExplainStashCommandArgs>('gitlens.ai.explainStash', {
 			repoPath: ref.repoPath,
-			ref: ref.ref,
+			rev: ref.ref,
 			source: { source: 'graph', type: 'stash' },
 		});
 	}
@@ -3905,7 +3909,7 @@ export class GraphWebviewProvider implements WebviewProvider<State, State, Graph
 		const ref = this.getGraphItemRef(item, 'revision');
 		if (ref == null) return Promise.resolve();
 
-		return executeCommand('gitlens.ai.explainWip', {
+		return executeCommand<ExplainWipCommandArgs>('gitlens.ai.explainWip', {
 			repoPath: ref.repoPath,
 			source: { source: 'graph', type: 'wip' },
 		});

Original file line number	Diff line number	Diff line change
`@@ -296,11 +296,7 @@ export class CommitExplainCommandQuickPickItem extends CommandQuickPickItem {`
`296`	`296`	`}`
`297`	`297`
`298`	`298`	`override execute(_options: { preserveFocus?: boolean; preview?: boolean }): Promise<void> {`
`299`		`- return CommitActions.explainCommit(this.commit, {`
`300`		`- source: {`
`301`		`- source: 'commandPalette',`
`302`		`- },`
`303`		`- });`
	`299`	`+ return CommitActions.explainCommit(this.commit, { source: { source: 'commandPalette' } });`
`304`	`300`	`}`
`305`	`301`	`}`
`306`	`302`