Updates prompts for AI generating messages

Author: d13

package.json

@@ -3536,9 +3536,16 @@
 						"scope": "window",
 						"order": 2
 					},
-					"gitlens.experimental.generateDraftMessagePrompt": {
+					"gitlens.experimental.generateCloudPatchMessagePrompt": {
 						"type": "string",
-						"default": "Now, please generate a commit message. Ensure that it includes a precise and informative subject line that succinctly summarizes the crux of the changes in under 50 characters. If necessary, follow with an explanatory body providing insight into the nature of the changes, the reasoning behind them, and any significant consequences or considerations arising from them. Conclude with any relevant issue references at the end of the message.",
+						"default": "Now, please generate a title and optional description. Ensure that it includes a precise and informative subject line that succinctly summarizes the crux of the changes in under 50 characters. If necessary, follow with an explanatory body providing insight into the nature of the changes, the reasoning behind them, and any significant consequences or considerations arising from them. Conclude with any relevant issue references at the end of the message.",
+						"markdownDescription": "Specifies the prompt to use to tell the AI provider how to structure or format the generated title and description",
+						"scope": "window",
+						"order": 3
+					},
+					"gitlens.experimental.generateCodeSuggestMessagePrompt": {
+						"type": "string",
+						"default": "Now, please generate a title and optional description. Ensure that it includes a precise and informative subject line that succinctly summarizes the crux of the changes in under 50 characters. If necessary, follow with an explanatory body providing insight into the nature of the changes, the reasoning behind them, and any significant consequences or considerations arising from them. Conclude with any relevant issue references at the end of the message.",
 						"markdownDescription": "Specifies the prompt to use to tell the AI provider how to structure or format the generated title and description",
 						"scope": "window",
 						"order": 3

src/ai/anthropicProvider.ts

@@ -7,7 +7,7 @@ import { configuration } from '../system/configuration';
 import type { Storage } from '../system/storage';
 import type { AIModel, AIProvider } from './aiProviderService';
 import { getApiKey as getApiKeyCore, getMaxCharacters } from './aiProviderService';
-import { commitMessageSystemPrompt, draftMessageSystemPrompt } from './prompts';
+import { cloudPatchMessageSystemPrompt, codeSuggestMessageSystemPrompt, commitMessageSystemPrompt } from './prompts';
 
 const provider = { id: 'anthropic', name: 'Anthropic' } as const;
 type LegacyModels = Extract<AnthropicModels, 'claude-instant-1' | 'claude-2'>;
@@ -173,7 +173,10 @@ export class AnthropicProvider implements AIProvider<typeof provider.id> {
 		diff: string,
 		options?: { cancellation?: CancellationToken; context?: string; codeSuggestion?: boolean },
 	): Promise<string | undefined> {
-		let customPrompt = configuration.get('experimental.generateDraftMessagePrompt');
+		let customPrompt =
+			options?.codeSuggestion === true
+				? configuration.get('experimental.generateCodeSuggestionMessagePrompt')
+				: configuration.get('experimental.generateCloudPatchMessagePrompt');
 		if (!customPrompt.endsWith('.')) {
 			customPrompt += '.';
 		}
@@ -182,7 +185,8 @@ export class AnthropicProvider implements AIProvider<typeof provider.id> {
 			model,
 			diff,
 			{
-				systemPrompt: draftMessageSystemPrompt,
+				systemPrompt:
+					options?.codeSuggestion === true ? codeSuggestMessageSystemPrompt : cloudPatchMessageSystemPrompt,
 				customPrompt: customPrompt,
 				contextName:
 					options?.codeSuggestion === true

src/ai/geminiProvider.ts

@@ -7,7 +7,7 @@ import { configuration } from '../system/configuration';
 import type { Storage } from '../system/storage';
 import type { AIModel, AIProvider } from './aiProviderService';
 import { getApiKey as getApiKeyCore, getMaxCharacters } from './aiProviderService';
-import { commitMessageSystemPrompt, draftMessageSystemPrompt } from './prompts';
+import { cloudPatchMessageSystemPrompt, codeSuggestMessageSystemPrompt, commitMessageSystemPrompt } from './prompts';
 
 const provider = { id: 'gemini', name: 'Google' } as const;
 
@@ -140,7 +140,10 @@ export class GeminiProvider implements AIProvider<typeof provider.id> {
 			codeSuggestion?: boolean | undefined;
 		},
 	): Promise<string | undefined> {
-		let customPrompt = configuration.get('experimental.generateDraftMessagePrompt');
+		let customPrompt =
+			options?.codeSuggestion === true
+				? configuration.get('experimental.generateCodeSuggestionMessagePrompt')
+				: configuration.get('experimental.generateCloudPatchMessagePrompt');
 		if (!customPrompt.endsWith('.')) {
 			customPrompt += '.';
 		}
@@ -149,7 +152,8 @@ export class GeminiProvider implements AIProvider<typeof provider.id> {
 			model,
 			diff,
 			{
-				systemPrompt: draftMessageSystemPrompt,
+				systemPrompt:
+					options?.codeSuggestion === true ? codeSuggestMessageSystemPrompt : cloudPatchMessageSystemPrompt,
 				customPrompt: customPrompt,
 				contextName:
 					options?.codeSuggestion === true

src/ai/openaiProvider.ts

@@ -7,7 +7,7 @@ import { configuration } from '../system/configuration';
 import type { Storage } from '../system/storage';
 import type { AIModel, AIProvider } from './aiProviderService';
 import { getApiKey as getApiKeyCore, getMaxCharacters } from './aiProviderService';
-import { commitMessageSystemPrompt, draftMessageSystemPrompt } from './prompts';
+import { cloudPatchMessageSystemPrompt, codeSuggestMessageSystemPrompt, commitMessageSystemPrompt } from './prompts';
 
 const provider = { id: 'openai', name: 'OpenAI' } as const;
 
@@ -237,7 +237,10 @@ export class OpenAIProvider implements AIProvider<typeof provider.id> {
 			codeSuggestion?: boolean | undefined;
 		},
 	): Promise<string | undefined> {
-		let customPrompt = configuration.get('experimental.generateDraftMessagePrompt');
+		let customPrompt =
+			options?.codeSuggestion === true
+				? configuration.get('experimental.generateCodeSuggestionMessagePrompt')
+				: configuration.get('experimental.generateCloudPatchMessagePrompt');
 		if (!customPrompt.endsWith('.')) {
 			customPrompt += '.';
 		}
@@ -246,7 +249,8 @@ export class OpenAIProvider implements AIProvider<typeof provider.id> {
 			model,
 			diff,
 			{
-				systemPrompt: draftMessageSystemPrompt,
+				systemPrompt:
+					options?.codeSuggestion === true ? codeSuggestMessageSystemPrompt : cloudPatchMessageSystemPrompt,
 				customPrompt: customPrompt,
 				contextName:
 					options?.codeSuggestion === true

src/ai/prompts.ts

@@ -8,7 +8,17 @@ export const commitMessageSystemPrompt = `You are an advanced AI programming ass
 
 Follow the user's instructions carefully, don't repeat yourself, don't include the code in the output, or make anything up!`;
 
-export const draftMessageSystemPrompt = `You are an advanced AI programming assistant tasked with summarizing code changes into a concise and meaningful commit message. Compose a commit message that:
+export const cloudPatchMessageSystemPrompt = `You are an advanced AI programming assistant tasked with summarizing code changes into a concise and meaningful title with an optional description. Compose a title with an optional description that:
+- Strictly synthesizes meaningful information from the provided code diff
+- Utilizes any additional user-provided context to comprehend the rationale behind the code changes
+- Is clear and brief, with an informal yet professional tone, and without superfluous descriptions
+- Avoids unnecessary phrases such as "this commit", "this change", and the like
+- Avoids direct mention of specific code identifiers, names, or file names, unless they are crucial for understanding the purpose of the changes
+- Most importantly emphasizes the 'why' of the change, its benefits, or the problem it addresses rather than only the 'what' that changed
+
+Follow the user's instructions carefully, don't repeat yourself, don't include the code in the output, or make anything up!`;
+
+export const codeSuggestMessageSystemPrompt = `You are an advanced AI programming assistant tasked with summarizing code changes into a concise and meaningful code review title with an optional description. Compose a code review title with an optional description that:
 - Strictly synthesizes meaningful information from the provided code diff
 - Utilizes any additional user-provided context to comprehend the rationale behind the code changes
 - Is clear and brief, with an informal yet professional tone, and without superfluous descriptions

src/ai/vscodeProvider.ts

@@ -5,7 +5,7 @@ import { configuration } from '../system/configuration';
 import { capitalize } from '../system/string';
 import type { AIModel, AIProvider } from './aiProviderService';
 import { getMaxCharacters } from './aiProviderService';
-import { commitMessageSystemPrompt, draftMessageSystemPrompt } from './prompts';
+import { cloudPatchMessageSystemPrompt, codeSuggestMessageSystemPrompt, commitMessageSystemPrompt } from './prompts';
 
 const provider = { id: 'vscode', name: 'VS Code Provided' } as const;
 
@@ -133,7 +133,10 @@ export class VSCodeAIProvider implements AIProvider<typeof provider.id> {
 			codeSuggestion?: boolean | undefined;
 		},
 	): Promise<string | undefined> {
-		let customPrompt = configuration.get('experimental.generateDraftMessagePrompt');
+		let customPrompt =
+			options?.codeSuggestion === true
+				? configuration.get('experimental.generateCodeSuggestionMessagePrompt')
+				: configuration.get('experimental.generateCloudPatchMessagePrompt');
 		if (!customPrompt.endsWith('.')) {
 			customPrompt += '.';
 		}
@@ -142,7 +145,8 @@ export class VSCodeAIProvider implements AIProvider<typeof provider.id> {
 			model,
 			diff,
 			{
-				systemPrompt: draftMessageSystemPrompt,
+				systemPrompt:
+					options?.codeSuggestion === true ? codeSuggestMessageSystemPrompt : cloudPatchMessageSystemPrompt,
 				customPrompt: customPrompt,
 				contextName:
 					options?.codeSuggestion === true

src/config.ts

@@ -80,7 +80,8 @@ export interface Config {
 	readonly detectNestedRepositories: boolean;
 	readonly experimental: {
 		readonly generateCommitMessagePrompt: string;
-		readonly generateDraftMessagePrompt: string;
+		readonly generateCloudPatchMessagePrompt: string;
+		readonly generateCodeSuggestionMessagePrompt: string;
 	};
 	readonly fileAnnotations: {
 		readonly preserveWhileEditing: boolean;