|
| 1 | +import type { TextEditor, Uri } from 'vscode'; |
| 2 | +import { ProgressLocation } from 'vscode'; |
| 3 | +import type { Container } from '../container'; |
| 4 | +import { GitUri } from '../git/gitUri'; |
| 5 | +import { showGenericErrorMessage } from '../messages'; |
| 6 | +import type { AIExplainSource } from '../plus/ai/aiProviderService'; |
| 7 | +import { ReferencesQuickPickIncludes, showReferencePicker } from '../quickpicks/referencePicker'; |
| 8 | +import { getBestRepositoryOrShowPicker } from '../quickpicks/repositoryPicker'; |
| 9 | +import { command } from '../system/-webview/command'; |
| 10 | +import { showMarkdownPreview } from '../system/-webview/markdown'; |
| 11 | +import { Logger } from '../system/logger'; |
| 12 | +import { getNodeRepoPath } from '../views/nodes/abstract/viewNode'; |
| 13 | +import { GlCommandBase } from './commandBase'; |
| 14 | +import { getCommandUri } from './commandBase.utils'; |
| 15 | +import type { CommandContext } from './commandContext'; |
| 16 | +import { isCommandContextViewNodeHasCommit } from './commandContext.utils'; |
| 17 | + |
| 18 | +export interface ExplainCommitCommandArgs { |
| 19 | + repoPath?: string | Uri; |
| 20 | + ref?: string; |
| 21 | + source?: AIExplainSource; |
| 22 | +} |
| 23 | + |
| 24 | +@command() |
| 25 | +export class ExplainCommitCommand extends GlCommandBase { |
| 26 | + constructor(private readonly container: Container) { |
| 27 | + super('gitlens.ai.explainCommit'); |
| 28 | + } |
| 29 | + |
| 30 | + protected override preExecute(context: CommandContext, args?: ExplainCommitCommandArgs): Promise<void> { |
| 31 | + // Check if the command is being called from a CommitNode |
| 32 | + if (isCommandContextViewNodeHasCommit(context)) { |
| 33 | + args = { ...args }; |
| 34 | + args.repoPath = args.repoPath ?? getNodeRepoPath(context.node); |
| 35 | + args.ref = args.ref ?? context.node.commit.sha; |
| 36 | + args.source = args.source ?? { source: 'view', type: 'commit' }; |
| 37 | + } |
| 38 | + |
| 39 | + return this.execute(context.editor, context.uri, args); |
| 40 | + } |
| 41 | + |
| 42 | + async execute(editor?: TextEditor, uri?: Uri, args?: ExplainCommitCommandArgs): Promise<void> { |
| 43 | + args = { ...args }; |
| 44 | + |
| 45 | + let repository; |
| 46 | + if (args?.repoPath != null) { |
| 47 | + repository = this.container.git.getRepository(args.repoPath); |
| 48 | + } |
| 49 | + |
| 50 | + if (repository == null) { |
| 51 | + uri = getCommandUri(uri, editor); |
| 52 | + const gitUri = uri != null ? await GitUri.fromUri(uri) : undefined; |
| 53 | + repository = await getBestRepositoryOrShowPicker( |
| 54 | + gitUri, |
| 55 | + editor, |
| 56 | + 'Explain Commit', |
| 57 | + 'Choose which repository to explain a commit from', |
| 58 | + ); |
| 59 | + } |
| 60 | + |
| 61 | + if (repository == null) return; |
| 62 | + |
| 63 | + try { |
| 64 | + // If no ref is provided, show a picker to select a commit |
| 65 | + if (args.ref == null) { |
| 66 | + const pick = await showReferencePicker( |
| 67 | + repository.path, |
| 68 | + 'Explain Commit', |
| 69 | + 'Choose a commit to explain', |
| 70 | + { |
| 71 | + allowRevisions: true, |
| 72 | + include: ReferencesQuickPickIncludes.BranchesAndTags, |
| 73 | + sort: { branches: { current: true }, tags: {} }, |
| 74 | + }, |
| 75 | + ); |
| 76 | + if (pick?.ref == null) return; |
| 77 | + args.ref = pick.ref; |
| 78 | + } |
| 79 | + |
| 80 | + // Get the commit |
| 81 | + const commit = await repository.git.commits().getCommit(args.ref); |
| 82 | + if (commit == null) { |
| 83 | + void showGenericErrorMessage('Unable to find the specified commit'); |
| 84 | + return; |
| 85 | + } |
| 86 | + |
| 87 | + // Call the AI service to explain the commit |
| 88 | + const result = await this.container.ai.explainCommit( |
| 89 | + commit, |
| 90 | + args.source ?? { source: 'commandPalette', type: 'commit' }, |
| 91 | + { |
| 92 | + progress: { location: ProgressLocation.Notification, title: 'Explaining commit...' }, |
| 93 | + }, |
| 94 | + ); |
| 95 | + |
| 96 | + // Display the result |
| 97 | + let content = `# Commit Summary\n\n`; |
| 98 | + if (result != null) { |
| 99 | + content += `> Generated by ${result.model.name}\n\n## ${commit.summary} (${commit.shortSha})\n\n${result?.parsed.summary}\n\n${result?.parsed.body}`; |
| 100 | + } else { |
| 101 | + content += `> No changes found to explain.`; |
| 102 | + } |
| 103 | + void showMarkdownPreview(content); |
| 104 | + } catch (ex) { |
| 105 | + Logger.error(ex, 'ExplainCommitCommand', 'execute'); |
| 106 | + void showGenericErrorMessage('Unable to explain commit'); |
| 107 | + } |
| 108 | + } |
| 109 | +} |
0 commit comments