Refactor prompt construction to move instructions after context and remove unused exclude_path parameter

Author: robertpiosik

apps/editor/src/commands/code-at-cursor-commands.ts

@@ -363,7 +363,6 @@ const perform_code_at_cursor = async (params: {
     const document = editor.document
     const position = editor.selection.active
 
-    const document_path = document.uri.fsPath
     const text_before_cursor = document.getText(
       new vscode.Range(new vscode.Position(0, 0), position)
     )
@@ -376,9 +375,7 @@ const perform_code_at_cursor = async (params: {
       params.open_editors_provider
     )
 
-    const context_text = await files_collector.collect_files({
-      exclude_path: document_path
-    })
+    const context_text = await files_collector.collect_files()
 
     const payload = {
       before: `<files>\n${context_text}<file path="${vscode.workspace.asRelativePath(
@@ -387,7 +384,7 @@ const perform_code_at_cursor = async (params: {
       after: `${text_after_cursor}\n]]>\n</file>\n</files>`
     }
 
-    const content = `${code_at_cursor_instructions}\n${payload.before}${
+    const content = `${payload.before}${
       completion_instructions
         ? `<missing_text>${completion_instructions}</missing_text>`
         : '<missing_text>'

apps/editor/src/constants/instructions.ts

@@ -1,20 +1,19 @@
 export const code_at_cursor_instructions =
   'Find correct replacement for the <missing_text> symbol. Respond with replacement text within "replacement" XML tags, without explanations or any other text.\nExample:\n<replacement>!== undefined</replacement>\n'
 
-export const code_at_cursor_instructions_for_panel = (
-  file_path: string,
-  row: number,
+export const code_at_cursor_instructions_for_panel = (params: {
+  file_path: string
+  row: number
   column: number
-) =>
-  `Find correct replacement text for the <missing_text> symbol.
+}) => `Find correct replacement text for the <missing_text> symbol.
 <system>
-Your response must begin with a markdown heading identifying the file and the cursor position, followed by a markdown code block containing the replacement text, followed by a brief explanation. The heading must be: "### Code at cursor: \`${file_path}\` (${
-    row + 1
-  }:${
-    column + 1
-  })". Always refer to the symbol "<missing_text>" as "cursor position" and "replacement" as "completion". Example:
+Your response must begin with a markdown heading identifying the file and the cursor position, followed by a markdown code block containing the replacement text, followed by a brief explanation. The heading must be: "### Code at cursor: \`${
+  params.file_path
+}\` (${params.row + 1}:${
+  params.column + 1
+})". Always refer to the symbol "<missing_text>" as "cursor position" and "replacement" as "completion". Example:
 
-### Code at cursor: \`${file_path}\` (${row + 1}:${column + 1})
+### Code at cursor: \`${params.file_path}\` (${params.row + 1}:${params.column + 1})
 
 \`\`\`typescript
 !== undefined

apps/editor/src/utils/files-collector.ts

@@ -21,7 +21,6 @@ export class FilesCollector {
   }
 
   async collect_files(params?: {
-    exclude_path?: string
     additional_paths?: string[]
     no_context?: boolean
     compact?: boolean
@@ -62,7 +61,6 @@ export class FilesCollector {
     let collected_text = ''
 
     for (const file_path of sorted_context_files) {
-      if (params?.exclude_path && params.exclude_path == file_path) continue
       try {
         if (!fs.existsSync(file_path)) continue
         const stats = fs.statSync(file_path)

apps/editor/src/views/panel/backend/message-handlers/handle-code-at-cursor.ts

@@ -317,7 +317,6 @@ export const handle_code_at_cursor = async (
     const document = editor.document
     const position = editor.selection.active
 
-    const document_path = document.uri.fsPath
     const text_before_cursor = document.getText(
       new vscode.Range(new vscode.Position(0, 0), position)
     )
@@ -326,11 +325,11 @@ export const handle_code_at_cursor = async (
     )
 
     const relative_path = vscode.workspace.asRelativePath(document.uri)
-    const main_instructions = code_at_cursor_instructions_for_panel(
-      relative_path,
-      position.line,
-      position.character
-    )
+    const main_instructions = code_at_cursor_instructions_for_panel({
+      file_path: relative_path,
+      row: position.line,
+      column: position.character
+    })
 
     let processed_completion_instructions = completion_instructions
     let skill_definitions = ''
@@ -406,20 +405,18 @@ export const handle_code_at_cursor = async (
       panel_provider.open_editors_provider
     )
 
-    const context_text = await files_collector.collect_files({
-      exclude_path: document_path
-    })
+    const context_text = await files_collector.collect_files()
 
     const payload = {
       before: `<files>\n${context_text}<file path="${relative_path}">\n<![CDATA[\n${text_before_cursor}`,
       after: `${text_after_cursor}\n]]>\n</file>\n</files>`
     }
 
-    const content = `${main_instructions}\n${skill_definitions}${payload.before}${
+    const content = `${payload.before}${
       processed_completion_instructions
         ? `<missing_text>${processed_completion_instructions}</missing_text>`
         : '<missing_text>'
-    }${payload.after}\n${main_instructions}`
+    }${payload.after}\n${skill_definitions}${main_instructions}`
 
     let user_content: any = content
 

apps/editor/src/views/panel/backend/message-handlers/handle-copy-prompt.ts

@@ -77,18 +77,16 @@ export const handle_copy_prompt = async (params: {
       new vscode.Range(position, document.positionAt(document.getText().length))
     )
 
-    const context_text = await files_collector.collect_files({
-      exclude_path: active_path
-    })
+    const context_text = await files_collector.collect_files()
 
     const workspace_folder = vscode.workspace.workspaceFolders?.[0].uri.fsPath
     const relative_path = active_path.replace(workspace_folder + '/', '')
 
-    const system_instructions = code_at_cursor_instructions_for_panel(
-      relative_path,
-      position.line,
-      position.character
-    )
+    const system_instructions = code_at_cursor_instructions_for_panel({
+      file_path: relative_path,
+      row: position.line,
+      column: position.character
+    })
 
     let processed_completion_instructions = final_instruction
     let skill_definitions = ''
@@ -158,7 +156,7 @@ export const handle_copy_prompt = async (params: {
       ? `<missing_text>${processed_completion_instructions}</missing_text>`
       : '<missing_text>'
 
-    const text = `${system_instructions}\n${skill_definitions}<files>\n${context_text}<file path="${relative_path}">\n<![CDATA[\n${text_before_cursor}${missing_text_tag}${text_after_cursor}\n]]>\n</file>\n</files>\n${system_instructions}`
+    const text = `<files>\n${context_text}<file path="${relative_path}">\n<![CDATA[\n${text_before_cursor}${missing_text_tag}${text_after_cursor}\n]]>\n</file>\n</files>\n${skill_definitions}${system_instructions}`
 
     vscode.env.clipboard.writeText(text.trim())
   } else if (!is_in_code_completions_prompt_type) {
@@ -268,9 +266,7 @@ export const handle_copy_prompt = async (params: {
     }
 
     const text = context_text
-      ? `${
-          system_instructions_xml ? system_instructions_xml + '\n' : ''
-        }${skill_definitions}<files>\n${context_text}</files>\n${
+      ? `<files>\n${context_text}</files>\n${skill_definitions}${
           system_instructions_xml ? system_instructions_xml + '\n' : ''
         }${processed_instructions}`
       : `${

apps/editor/src/views/panel/backend/message-handlers/handle-edit-context.ts

@@ -474,9 +474,7 @@ export const handle_edit_context = async (
       system_instructions_xml = `<system>\n${edit_format_instructions}\n</system>`
     }
 
-    const content = `${
-      system_instructions_xml ? system_instructions_xml + '\n' : ''
-    }${skill_definitions}${files}\n${
+    const content = `${files}\n${skill_definitions}${
       system_instructions_xml ? system_instructions_xml + '\n' : ''
     }${processed_instructions}`
 

apps/editor/src/views/panel/backend/message-handlers/handle-preview-preset.ts

@@ -59,9 +59,7 @@ export const handle_preview_preset = async (
       new vscode.Range(position, document.positionAt(document.getText().length))
     )
 
-    const context_text = await files_collector.collect_files({
-      exclude_path: active_path
-    })
+    const context_text = await files_collector.collect_files()
 
     const workspace_folder = vscode.workspace.workspaceFolders?.[0].uri.fsPath
     const relative_path = active_path!.replace(workspace_folder + '/', '')
@@ -138,7 +136,7 @@ export const handle_preview_preset = async (
       ? `<missing_text>${processed_completion_instructions}</missing_text>`
       : '<missing_text>'
 
-    text_to_send = `${system_instructions}\n${skill_definitions}<files>\n${context_text}<file path="${relative_path}">\n<![CDATA[\n${text_before_cursor}${missing_text_tag}${text_after_cursor}\n]]>\n</file>\n</files>\n${system_instructions}`
+    text_to_send = `<files>\n${context_text}<file path="${relative_path}">\n<![CDATA[\n${text_before_cursor}${missing_text_tag}${text_after_cursor}\n]]>\n</file>\n</files>\n${skill_definitions}${system_instructions}`
   } else if (panel_provider.web_prompt_type != 'code-at-cursor') {
     let instructions = apply_preset_affixes_to_instruction({
       instruction: current_instructions,
@@ -244,9 +242,7 @@ export const handle_preview_preset = async (
     }
 
     text_to_send = context_text
-      ? `${
-          system_instructions_xml ? system_instructions_xml + '\n' : ''
-        }${skill_definitions}<files>\n${context_text}</files>\n${
+      ? `<files>\n${context_text}</files>\n${skill_definitions}${
           system_instructions_xml ? system_instructions_xml + '\n' : ''
         }${processed_instructions}`
       : `${

apps/editor/src/views/panel/backend/message-handlers/handle-prune-context.ts

@@ -426,7 +426,7 @@ export const handle_prune_context = async (
       config_prune_instructions_prefix || prune_context_instructions_prefix
     const system_instructions_xml = `${instructions_to_use}\n${prune_context_format}`
 
-    const content = `${system_instructions_xml}\n${skill_definitions}${files}\n${system_instructions_xml}\n${processed_instructions}`
+    const content = `${files}\n${skill_definitions}${system_instructions_xml}\n${processed_instructions}`
 
     let user_content: any = content
 

apps/editor/src/views/panel/backend/message-handlers/handle-send-to-browser.ts

@@ -68,7 +68,6 @@ export const handle_send_to_browser = async (params: {
   }
 
   const active_editor = vscode.window.activeTextEditor
-  const active_path = active_editor?.document.uri.fsPath
 
   if (is_in_code_completions_mode && !active_editor) {
     vscode.window.showWarningMessage(dictionary.warning_message.NO_EDITOR_OPEN)
@@ -183,28 +182,26 @@ export const handle_send_to_browser = async (params: {
       })
     }
 
-    const context_text = await files_collector.collect_files({
-      exclude_path: active_path
-    })
+    const context_text = await files_collector.collect_files()
 
     const relative_path = vscode.workspace.asRelativePath(document.uri)
 
-    const main_instructions = code_at_cursor_instructions_for_panel(
-      relative_path,
-      position.line,
-      position.character
-    )
+    const main_instructions = code_at_cursor_instructions_for_panel({
+      file_path: relative_path,
+      row: position.line,
+      column: position.character
+    })
 
     const payload = {
       before: `<files>\n${context_text}<file path="${relative_path}">\n<![CDATA[\n${text_before_cursor}`,
       after: `${text_after_cursor}\n]]>\n</file>\n</files>`
     }
 
-    const text = `${main_instructions}\n${skill_definitions}${payload.before}${
+    const text = `${payload.before}${
       processed_completion_instructions
         ? `<missing_text>${processed_completion_instructions}</missing_text>`
         : '<missing_text>'
-    }${payload.after}\n${main_instructions}`
+    }${payload.after}\n${skill_definitions}${main_instructions}`
 
     const chats = resolved_preset_names.flatMap((preset_name) => {
       return Array.from({ length: params.invocation_count }).map(() => ({
@@ -332,9 +329,7 @@ export const handle_send_to_browser = async (params: {
 
         return {
           text: context_text
-            ? `${
-                system_instructions_xml ? system_instructions_xml + '\n' : ''
-              }${skill_definitions}<files>\n${context_text}</files>\n${
+            ? `<files>\n${context_text}</files>\n${skill_definitions}${
                 system_instructions_xml ? system_instructions_xml + '\n' : ''
               }${processed_instructions}`
             : `${