Split commit message prompts into separate API and chatbot versions

- for chatbots, should use commit_message_format at both ends divided with '---' with 'commit message instructions' placed below it.

└── apps
    └── editor
        └── src
            ├── commands
            │   ├── code-at-cursor-command
            │   │   └── utils
            │   │       └── get-code-at-cursor-config.ts
            │   └── generate-commit-message-command
            │       ├── actions
            │       │   ├── get-prompt-data.ts
            │       │   └── run-generate-action.ts
            │       ├── generate-commit-message-command.ts
            │       ├── index.ts
            │       └── utils
            │           ├── build-commit-message-prompt.ts
            │           ├── generate-commit-message-with-api.ts
            │           ├── get-commit-message-config.ts
            │           └── strip-wrapping-quotes.ts
            ├── constants
            │   ├── instructions.ts
            │   └── state-keys.ts
            ├── features
            │   └── search-files
            │       └── utils
            │           └── search-files-by-intelligent.ts
            ├── i18n
            │   └── translations
            │       └── commands
            │           └── generate-commit-message.ts
            ├── utils
            │   └── show-configuration-quick-pick.ts
            └── views
                └── prompt
                    └── backend
                        └── message-handlers
                            ├── handle-autofill.ts
                            ├── handle-make-api-call.ts
                            ├── handle-voice-input.ts
                            └── utils
                                └── intelligent-update-utils.ts

Author: robertpiosik

apps/editor/src/commands/generate-commit-message-command/actions/get-prompt-data.ts

@@ -22,7 +22,7 @@ export const get_prompt_data = async (params: {
     selection_state: params.selection_state
   })
   if (!diff) return null
-  const message_prompt = await build_commit_message_prompt(
+  const { api_prompt, chatbot_prompt } = await build_commit_message_prompt(
     diff,
     params.repository
   )
@@ -61,7 +61,8 @@ export const get_prompt_data = async (params: {
   return {
     repository: params.repository,
     was_empty_stage,
-    message_prompt,
+    api_prompt,
+    chatbot_prompt,
     is_single_change,
     staged_files: diff_file_paths
   }

apps/editor/src/commands/generate-commit-message-command/actions/run-generate-action.ts

@@ -52,11 +52,11 @@ export const run_generate_action = async (params: {
       selection_state
     })
     if (!data) return
-    const { message_prompt, is_single_change, staged_files } = data
+    const { api_prompt, chatbot_prompt, is_single_change, staged_files } = data
     let { was_empty_stage } = data
 
     // token count for the prompt, used in the config UI
-    const token_count = Math.ceil(message_prompt.length / 4)
+    const token_count = Math.ceil(api_prompt.length / 4)
 
     if (was_empty_stage) {
       files_staged_by_action = true
@@ -192,7 +192,7 @@ export const run_generate_action = async (params: {
       )
 
       if (action === 'copy') {
-        await vscode.env.clipboard.writeText(message_prompt)
+        await vscode.env.clipboard.writeText(chatbot_prompt)
         vscode.window.showInformationMessage(
           t('command.generate-commit-message.copied', {
             tokens: display_token_count(token_count)
@@ -295,7 +295,7 @@ export const run_generate_action = async (params: {
 
         if (selected_web_configuration_name) {
           const sent = await params.websocket_manager.initialize_chat({
-            text: message_prompt,
+            text: chatbot_prompt,
             web_configuration_name: selected_web_configuration_name,
             invocation_count: 1,
             is_for_commit_message: true
@@ -342,7 +342,7 @@ export const run_generate_action = async (params: {
             base_url: api_configuration_data.base_url,
             model_provider: api_configuration_data.model_provider,
             api_configuration: api_configuration_data.api_configuration,
-            message: message_prompt
+            message: api_prompt
           })
         } catch (error) {
           if (axios.isCancel(error)) {

apps/editor/src/commands/generate-commit-message-command/utils/build-commit-message-prompt.ts

@@ -1,13 +1,16 @@
 import * as vscode from 'vscode'
-import { commit_message_instructions } from '@/constants/instructions'
+import {
+  commit_message_instructions,
+  commit_message_format
+} from '@/constants/instructions'
 import type { GitRepository } from '@/utils/git-repository-utils'
 import { MAX_FILE_TOKENS_FOR_COMMIT_MESSAGE } from '@/constants/values'
 import { PromptBuilder } from '@/utils/prompt-builder'
 
 export const build_commit_message_prompt = async (
   diff: string,
   repository: GitRepository
-): Promise<string> => {
+): Promise<{ api_prompt: string; chatbot_prompt: string }> => {
   const config = vscode.workspace.getConfiguration('codeWebChat')
   const instructions = config.get<string>('commitMessageInstructions')
   const commit_message_prompt = instructions || commit_message_instructions
@@ -124,5 +127,8 @@ export const build_commit_message_prompt = async (
     }
   }
 
-  return `${commit_message_prompt}\n\n---\n\n${changes_content}---\n\n${commit_message_prompt}`
+  const api_prompt = `# Task\n\n${commit_message_prompt}\n\n# Files\n\n${changes_content}\n\n# Task\n\n${commit_message_prompt}`
+  const chatbot_prompt = `# Task\n\n${commit_message_prompt}\n\n# Output formatting\n\n${commit_message_format}\n\n# Files\n\n${changes_content}\n\n# Output formatting\n\n${commit_message_format}\n\n# Task\n\n${commit_message_prompt}`
+
+  return { api_prompt, chatbot_prompt }
 }

apps/editor/src/constants/instructions.ts

@@ -50,9 +50,7 @@ export const intelligent_update_fallback_edit_format_instructions = `Print the u
 export const commit_message_instructions =
   "Write a brief and precise summary for the changes, limited to a single sentence. Because the summary will be used for a commit message, don't use any markdown formatting and don't include a trailing dot. Use an imperative tone to ensure clarity and focus on the primary change or purpose."
 
-export const commit_message_format = `# Output formatting
-
-Your response must begin with "**Commit message:**", then proceed with the message. Example:
+export const commit_message_format = `Your response must begin with "**Commit message:**", then proceed with the message. Example:
 
 **Commit message:** Bump version to 1.0.1`
 

apps/editor/src/utils/prompt-builder.ts

@@ -22,14 +22,14 @@ export namespace PromptBuilder {
     const display_path = params.filepath.replace(/\\/g, '/')
 
     if (params.status == 'created') {
-      result += `### New file: \`${display_path}\`\n\n`
+      result += `- New file: \`${display_path}\`\n\n`
     } else if (params.status == 'deleted') {
-      result += `### Deleted file: \`${display_path}\`\n\n`
+      result += `- Deleted file: \`${display_path}\`\n\n`
     } else if (params.status == 'renamed' && params.old_filepath) {
       const old_display_path = params.old_filepath.replace(/\\/g, '/')
-      result += `### Renamed file: \`${old_display_path}\` (old) \`${display_path}\` (new)\n\n`
+      result += `- Renamed file: \`${old_display_path}\` (old) \`${display_path}\` (new)\n\n`
     } else {
-      result += `### Updated file: \`${display_path}\`\n\n`
+      result += `- Updated file: \`${display_path}\`\n\n`
     }
 
     if (params.diff_content?.trimEnd()) {