Add a configurable setting for find relevant files instructions and update the settings UI to support customizing them

- in 'General > context' add the ability to override 'find relevant files instructions'

Author: robertpiosik

apps/editor/package.json

@@ -924,6 +924,10 @@
           "type": "string",
           "scope": "resource"
         },
+        "codeWebChat.findRelevantFilesInstructions": {
+          "type": "string",
+          "scope": "resource"
+        },
         "codeWebChat.editFilesSystemInstructions": {
           "type": "string",
           "scope": "resource"

apps/editor/src/constants/instructions.ts

@@ -33,7 +33,7 @@ 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 find_relevant_files_instructions =
-  'Find a complete set of files relevant to the following query (include the primary files as well as any structural files):'
+  'Find a complete set of files relevant to the following query. Include the primary files as well as any structural files.'
 
 export const find_relevant_files_format = `# System
 

apps/editor/src/features/search-files/utils/fetch-relevant-files-from-api.ts

@@ -26,7 +26,12 @@ export const fetch_relevant_files_from_api = async (
   }
   xml_files += `</files>`
 
-  const part2 = `${find_relevant_files_format}\n\n${find_relevant_files_instructions}\n\n${instructions}`
+  const config = vscode.workspace.getConfiguration('codeWebChat')
+  const base_instructions =
+    config.get<string>('findRelevantFilesInstructions') ||
+    find_relevant_files_instructions
+
+  const part2 = `${find_relevant_files_format}\n\n${base_instructions}\n\n${instructions}`
   const user_content = build_user_content({
     model_provider,
     part1: xml_files,

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

@@ -152,7 +152,12 @@ export const handle_copy_prompt = async (params: {
       }
     } else if (is_in_find_relevant_files_prompt_type) {
       formatted_system_instructions = find_relevant_files_format_for_panel
-      user_instructions = `${find_relevant_files_instructions}\n\n${processed_instructions}`
+
+      const config = vscode.workspace.getConfiguration('codeWebChat')
+      const base_instructions =
+        config.get<string>('findRelevantFilesInstructions') ||
+        find_relevant_files_instructions
+      user_instructions = `${base_instructions}\n\n${processed_instructions}`
     }
 
     const { full_prompt: text } = PromptBuilder.build_prompt({

apps/editor/src/views/panel/backend/message-handlers/handle-find-relevant-files.ts

@@ -216,12 +216,17 @@ export const handle_find_relevant_files = async (
 
     const endpoint_url = model_provider.base_url
 
+    const config = vscode.workspace.getConfiguration('codeWebChat')
+    const base_instructions =
+      config.get<string>('findRelevantFilesInstructions') ||
+      find_relevant_files_instructions
+
     const { part1, part2 } = PromptBuilder.build_prompt({
       other_files: collected.other_files,
       recent_files: collected.recent_files,
       skill_definitions,
       system_instructions: find_relevant_files_format_for_panel,
-      user_instructions: `${find_relevant_files_instructions}\n\n${processed_instructions}`
+      user_instructions: `${base_instructions}\n\n${processed_instructions}`
     })
 
     const user_content = build_user_content({

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

@@ -183,7 +183,12 @@ export const handle_send_to_browser = async (params: {
       }
     } else if (params.panel_provider.web_prompt_type == 'find-relevant-files') {
       formatted_system_instructions = find_relevant_files_format_for_panel
-      user_instructions = `${find_relevant_files_instructions}\n\n${processed_instructions}`
+
+      const config = vscode.workspace.getConfiguration('codeWebChat')
+      const base_instructions =
+        config.get<string>('findRelevantFilesInstructions') ||
+        find_relevant_files_instructions
+      user_instructions = `${base_instructions}\n\n${processed_instructions}`
     }
 
     const { full_prompt: text } = PromptBuilder.build_prompt({

apps/editor/src/views/settings/backend/message-handlers/handle-get-find-relevant-files-instructions.ts

@@ -0,0 +1,16 @@
+import * as vscode from 'vscode'
+import { SettingsProvider } from '@/views/settings/backend/settings-provider'
+import { find_relevant_files_instructions } from '@/constants/instructions'
+
+export const handle_get_find_relevant_files_instructions = async (
+  provider: SettingsProvider
+): Promise<void> => {
+  const config = vscode.workspace.getConfiguration('codeWebChat')
+  const instructions =
+    config.get<string>('findRelevantFilesInstructions') ||
+    find_relevant_files_instructions
+  provider.postMessage({
+    command: 'FIND_RELEVANT_FILES_INSTRUCTIONS',
+    instructions
+  })
+}

apps/editor/src/views/settings/backend/message-handlers/handle-update-find-relevant-files-instructions.ts

@@ -0,0 +1,18 @@
+import * as vscode from 'vscode'
+import { find_relevant_files_instructions } from '@/constants/instructions'
+import { UpdateFindRelevantFilesInstructionsMessage } from '../../types/messages'
+
+export const handle_update_find_relevant_files_instructions = async (
+  message: UpdateFindRelevantFilesInstructionsMessage
+): Promise<void> => {
+  await vscode.workspace
+    .getConfiguration('codeWebChat')
+    .update(
+      'findRelevantFilesInstructions',
+      message.instructions == '' ||
+        message.instructions == find_relevant_files_instructions
+        ? undefined
+        : message.instructions,
+      vscode.ConfigurationTarget.Global
+    )
+}

apps/editor/src/views/settings/backend/message-handlers/index.ts

@@ -1,3 +1,5 @@
+export * from './handle-get-find-relevant-files-instructions'
+export * from './handle-update-find-relevant-files-instructions'
 export * from './handle-add-model-provider'
 export * from './handle-update-model-provider'
 export * from './handle-get-model-providers'

apps/editor/src/views/settings/backend/settings-provider.ts

@@ -57,7 +57,9 @@ import {
   handle_reorder_api_configurations,
   handle_pick_model_provider,
   handle_pick_api_model,
-  handle_pick_api_reasoning_effort
+  handle_pick_api_reasoning_effort,
+  handle_get_find_relevant_files_instructions,
+  handle_update_find_relevant_files_instructions
 } from './message-handlers'
 import { config_web_configuration_to_ui_format } from '@/utils/web-configuration-format-converters'
 import { webview_html } from '@/views/shared/utils/webview-html'
@@ -147,6 +149,12 @@ export class SettingsProvider {
           await handle_update_model_provider(this, message)
         } else if (message.command == 'GET_API_CONFIGURATIONS') {
           await handle_get_api_configurations(this)
+        } else if (message.command == 'GET_FIND_RELEVANT_FILES_INSTRUCTIONS') {
+          await handle_get_find_relevant_files_instructions(this)
+        } else if (
+          message.command == 'UPDATE_FIND_RELEVANT_FILES_INSTRUCTIONS'
+        ) {
+          await handle_update_find_relevant_files_instructions(message)
         } else if (message.command == 'SET_DEFAULT_API_CONFIGURATION') {
           await handle_set_default_api_configuration(
             this,
@@ -275,6 +283,7 @@ export class SettingsProvider {
           void handle_get_model_providers(this)
           void handle_get_api_configurations(this)
           void handle_get_edit_files_system_instructions(this)
+          void handle_get_find_relevant_files_instructions(this)
           void handle_get_edit_format_instructions(this)
           void handle_get_context_size_warning_threshold(this)
           void handle_get_commit_message_instructions(this)