Centralize diff file context construction in PromptBuilder utility

- it seems like both files have similar logic in terms of constructing prompt with files
- should not use hack "as 'created' | 'deleted' | 'renamed' | 'updated'"
- when building prompt for commit message, place "---" divider between instructions and files

Author: robertpiosik

apps/editor/src/features/commit-messages/utils/build-commit-message-prompt.ts

@@ -2,6 +2,7 @@ import * as vscode from 'vscode'
 import { commit_message_instructions } 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,
@@ -52,7 +53,7 @@ export const build_commit_message_prompt = async (
     }
 
     if (file_path) {
-      let status = 'updated'
+      let status: 'created' | 'deleted' | 'renamed' | 'updated' = 'updated'
 
       if (is_deleted) {
         status = 'deleted'
@@ -91,20 +92,7 @@ export const build_commit_message_prompt = async (
         }
       }
 
-      if (status == 'created') {
-        changes_content += `### New file: \`${file_path}\`\n\n`
-      } else if (status == 'deleted') {
-        changes_content += `### Deleted file: \`${file_path}\`\n\n`
-      } else if (status == 'renamed') {
-        changes_content += `### Renamed file: \`${old_path_attr}\` (old) \`${file_path}\` (new)\n\n`
-      } else {
-        changes_content += `### Updated file: \`${file_path}\`\n\n`
-      }
-
-      if (final_diff_content.trimEnd()) {
-        changes_content += `\`\`\`diff\n${final_diff_content.trimEnd()}\n\`\`\`\n\n`
-      }
-
+      let file_content_to_pass = undefined
       if (!is_deleted && file_path && !is_binary) {
         try {
           let full_content = ''
@@ -120,13 +108,21 @@ export const build_commit_message_prompt = async (
           if (full_content && !full_content.includes('\0')) {
             const full_content_tokens = Math.ceil(full_content.length / 4)
             if (full_content_tokens <= MAX_FILE_TOKENS_FOR_COMMIT_MESSAGE) {
-              changes_content += `\`\`\`\n${full_content.trimEnd()}\n\`\`\`\n\n`
+              file_content_to_pass = full_content
             }
           }
         } catch (err) {}
       }
+
+      changes_content += PromptBuilder.build_diff_file_context({
+        status,
+        filepath: file_path,
+        old_filepath: old_path_attr,
+        diff_content: final_diff_content,
+        full_content: file_content_to_pass
+      })
     }
   }
 
-  return `${commit_message_prompt}\n\n${changes_content}${commit_message_prompt}`
+  return `${commit_message_prompt}\n\n---\n\n${changes_content}---\n\n${commit_message_prompt}`
 }

apps/editor/src/utils/git-repository-utils.ts

@@ -5,6 +5,7 @@ import * as path from 'path'
 import { t } from '@/i18n'
 import { display_token_count } from './display-token-count'
 import { MAX_FILE_TOKENS_FOR_COMMIT_MESSAGE } from '@/constants/values'
+import { PromptBuilder } from './prompt-builder'
 
 export type GitRepository = {
   rootUri: vscode.Uri
@@ -168,7 +169,7 @@ export const prepare_staged_changes = async (params: {
           )
           const dir_name = path.dirname(relative_path)
 
-          let status = 'updated'
+          let status: 'created' | 'deleted' | 'renamed' | 'updated' = 'updated'
           let is_deleted = false
           let final_diff_content = ''
           let full_content = ''
@@ -239,21 +240,15 @@ export const prepare_staged_changes = async (params: {
           )
           const is_too_large = file_tokens > MAX_FILE_TOKENS_FOR_COMMIT_MESSAGE
 
-          let file_md = ''
-          if (status == 'created') {
-            file_md = `### New file: \`${relative_path}\`\n\n`
-          } else if (status == 'deleted') {
-            file_md = `### Deleted file: \`${relative_path}\`\n\n`
-          } else {
-            file_md = `### Updated file: \`${relative_path}\`\n\n`
-          }
-
-          if (final_diff_content.trimEnd()) {
-            file_md += `\`\`\`diff\n${final_diff_content.trimEnd()}\n\`\`\`\n\n`
-          }
-          if (!is_deleted && full_content && !is_too_large) {
-            file_md += `\`\`\`\n${full_content.trimEnd()}\n\`\`\`\n\n`
-          }
+          const file_md = PromptBuilder.build_diff_file_context({
+            status,
+            filepath: relative_path,
+            diff_content: final_diff_content,
+            full_content:
+              !is_deleted && full_content && !is_too_large
+                ? full_content
+                : undefined
+          })
 
           const token_count = Math.ceil(file_md.length / 4)
           const description_parts = []

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

@@ -11,6 +11,38 @@ export namespace PromptBuilder {
     return `### File: \`${display_path}\`\n\n\`\`\`\n${params.content}\n\`\`\`\n\n`
   }
 
+  export const build_diff_file_context = (params: {
+    status: 'created' | 'deleted' | 'renamed' | 'updated'
+    filepath: string
+    old_filepath?: string
+    diff_content?: string
+    full_content?: string
+  }): string => {
+    let result = ''
+    const display_path = params.filepath.replace(/\\/g, '/')
+
+    if (params.status == 'created') {
+      result += `### New file: \`${display_path}\`\n\n`
+    } else if (params.status == 'deleted') {
+      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`
+    } else {
+      result += `### Updated file: \`${display_path}\`\n\n`
+    }
+
+    if (params.diff_content?.trimEnd()) {
+      result += `\`\`\`diff\n${params.diff_content.trimEnd()}\n\`\`\`\n\n`
+    }
+
+    if (params.full_content?.trimEnd()) {
+      result += `\`\`\`\n${params.full_content.trimEnd()}\n\`\`\`\n\n`
+    }
+
+    return result
+  }
+
   export const build_prompt = (params: {
     other_files?: string
     recent_files?: string