Migrate the chatCodeCompletionInstructions setting to chatCodeCompletionsInstructions

Author: robertpiosik

packages/vscode/package.json

@@ -652,10 +652,10 @@
           "description": "Style instructions for chat responses when using diff format.",
           "default": "Whenever proposing a file use the markdown code block syntax. Each code block should be a diff patch."
         },
-        "codeWebChat.chatCodeCompletionInstructions": {
+        "codeWebChat.chatCodeCompletionsInstructions": {
           "type": "string",
           "scope": "resource",
-          "description": "Instruction for code completion in chat",
+          "description": "Instructions for code completions in chat.",
           "default": "Find correct replacement text for the <missing text> symbol. Correctly formatted response begins with a code block containing replacement text end then proceeds with explanation. Always refer to symbol \"<missing_text>\" as \"cursor position\" and \"replacement\" as \"completion\"."
         },
         "codeWebChat.presets": {

packages/vscode/src/commands/code-completion-in-chat-commands.ts

@@ -71,7 +71,7 @@ async function handle_code_completion_in_chat_command(
 
     const config = vscode.workspace.getConfiguration('codeWebChat')
     const chat_code_completion_instructions = config.get<string>(
-      'chatCodeCompletionInstructions'
+      'chatCodeCompletionsInstructions'
     )
 
     const instructions = `${chat_code_completion_instructions}${

packages/vscode/src/commands/code-completion-to-clipboard-commands.ts

@@ -59,7 +59,7 @@ async function perform_fim_completion_to_clipboard(
 
     const config = vscode.workspace.getConfiguration('codeWebChat')
     const chat_code_completion_instructions = config.get<string>(
-      'chatCodeCompletionInstructions'
+      'chatCodeCompletionsInstructions'
     )
 
     const instructions = `${chat_code_completion_instructions}${

packages/vscode/src/extension.ts

@@ -2,9 +2,18 @@ import * as vscode from 'vscode'
 import { context_initialization } from './context/context-initialization'
 import { ViewProvider } from './view/backend/view-provider'
 import { WebSocketManager } from './services/websocket-manager'
-import { migrate_remove_copilot_presets } from './migrations/migrate-remove-copilot-presets'
-import { migrate_api_tool_settings } from './migrations/migrate-api-tool-settings'
-import { migrate_file_refactoring_to_array } from './migrations/migrate-file-refactoring-to-array'
+import {
+  migrate_remove_copilot_presets,
+  migrate_api_tool_settings,
+  migrate_file_refactoring_to_array,
+  migrate_settings_prefix,
+  migrate_keybindings,
+  migrate_api_keys_to_providers,
+  migrate_api_tool_configs,
+  migrate_api_providers_to_secret_storage,
+  migrate_commit_message_prompt_to_instructions,
+  migrate_chat_code_completion_instructions
+} from './migrations'
 import {
   apply_chat_response_command,
   refactor_commands,
@@ -32,12 +41,6 @@ import {
   open_settings_command,
   open_url_command
 } from './commands'
-import { migrate_settings_prefix } from './migrations/migrate-settings-prefix'
-import { migrate_keybindings } from './migrations/migrate-keybindings'
-import { migrate_api_keys_to_providers } from './migrations/migrate-api-keys-to-providers'
-import { migrate_api_tool_configs } from './migrations/migrate-api-tool-configs'
-import { migrate_api_providers_to_secret_storage } from './migrations/migrate-api-providers-to-secret-storage'
-import { migrate_commit_message_prompt_to_instructions } from './migrations/migrate-commit-message-prompt-to-instructions'
 
 // Store WebSocketServer instance at module level
 let websocket_server_instance: WebSocketManager | null = null
@@ -70,6 +73,7 @@ export async function activate(context: vscode.ExtensionContext) {
     await migrate_file_refactoring_to_array(context)
     // Remove a few weeks after 25 May 2025
     await migrate_commit_message_prompt_to_instructions(context)
+    await migrate_chat_code_completion_instructions(context)
   }
 
   await migrations()

packages/vscode/src/migrations/index.ts

@@ -0,0 +1,10 @@
+export * from './migrate-remove-copilot-presets'
+export * from './migrate-api-tool-settings'
+export * from './migrate-file-refactoring-to-array'
+export * from './migrate-settings-prefix'
+export * from './migrate-keybindings'
+export * from './migrate-api-keys-to-providers'
+export * from './migrate-api-tool-configs'
+export * from './migrate-api-providers-to-secret-storage'
+export * from './migrate-commit-message-prompt-to-instructions'
+export * from './migrate-chat-code-completion-instructions'

packages/vscode/src/migrations/migrate-chat-code-completion-instructions.ts

@@ -0,0 +1,61 @@
+import * as vscode from 'vscode'
+import { Logger } from '../helpers/logger'
+
+const MIGRATION_ID = 'chat-code-completion-instructions-migration-20240625'
+const OLD_SETTING_KEY = 'codeWebChat.chatCodeCompletionInstructions'
+const NEW_SETTING_KEY = 'codeWebChat.chatCodeCompletionsInstructions'
+
+/**
+ * Migration to rename chatCodeCompletionInstructions setting to chatCodeCompletionsInstructions
+ * This migration runs only once per extension installation.
+ */
+export async function migrate_chat_code_completion_instructions(
+  context: vscode.ExtensionContext
+): Promise<void> {
+  try {
+    // Check if migration has already run
+    if (context.globalState.get(MIGRATION_ID)) {
+      Logger.log({
+        function_name: 'migrate_chat_code_completion_instructions',
+        message:
+          'Chat code completion instructions migration already completed. Skipping.'
+      })
+      return
+    }
+
+    const config = vscode.workspace.getConfiguration()
+    const existing_value = config.get<string>(OLD_SETTING_KEY)
+
+    if (existing_value !== undefined) {
+      // Set the new setting with the existing value
+      await config.update(
+        NEW_SETTING_KEY,
+        existing_value,
+        vscode.ConfigurationTarget.Global
+      )
+
+      Logger.log({
+        function_name: 'migrate_chat_code_completion_instructions',
+        message:
+          'Successfully migrated chatCodeCompletionInstructions to chatCodeCompletionsInstructions'
+      })
+    } else {
+      Logger.log({
+        function_name: 'migrate_chat_code_completion_instructions',
+        message:
+          'No existing chatCodeCompletionInstructions setting found to migrate.'
+      })
+    }
+
+    // Mark migration as completed
+    await context.globalState.update(MIGRATION_ID, true)
+  } catch (error) {
+    Logger.error({
+      function_name: 'migrate_chat_code_completion_instructions',
+      message:
+        'Error migrating chatCodeCompletionInstructions to chatCodeCompletionsInstructions',
+      data: error instanceof Error ? error.message : String(error)
+    })
+    // Do NOT mark as completed if an error occurred
+  }
+}

packages/vscode/src/view/backend/message-handlers/handle-copy-prompt.ts

@@ -38,11 +38,11 @@ export const handle_copy_prompt = async (
 
     // Use the configurable instruction for code completions copy
     const config = vscode.workspace.getConfiguration('codeWebChat')
-    const chatCodeCompletionInstructions = config.get<string>(
-      'chatCodeCompletionInstructions'
+    const chatCodeCompletionsInstructions = config.get<string>(
+      'chatCodeCompletionsInstructions'
     )
 
-    const instructions = `${chatCodeCompletionInstructions}${
+    const instructions = `${chatCodeCompletionsInstructions}${
       current_instruction ? ` Follow suggestions: ${current_instruction}` : ''
     }`
 

packages/vscode/src/view/backend/message-handlers/handle-preview-preset.ts

@@ -44,7 +44,7 @@ export const handle_preview_preset = async (
 
     const config = vscode.workspace.getConfiguration('codeWebChat')
     const chat_code_completion_instructions = config.get<string>(
-      'chatCodeCompletionInstructions'
+      'chatCodeCompletionsInstructions'
     )
 
     const instructions = `${chat_code_completion_instructions}${

packages/vscode/src/view/backend/message-handlers/handle-send-prompt.ts

@@ -48,7 +48,7 @@ export const handle_send_prompt = async (
 
     const config = vscode.workspace.getConfiguration('codeWebChat')
     const chat_code_completion_instructions = config.get<string>(
-      'chatCodeCompletionInstructions'
+      'chatCodeCompletionsInstructions'
     )
 
     const instructions = `${chat_code_completion_instructions}${