feat: Add callback parameter to M.ask function to allow for custom handling of response data

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Tomas Slusny <slusnucky@gmail.com>

Author: 3 people

README.md

@@ -157,6 +157,13 @@ chat.ask("Explain how it works.", {
   selection = require("CopilotChat.select").buffer,
 })
 
+-- Ask a question and do something with the response
+chat.ask("Show me something interesting", {
+  callback = function(response)
+    print("Response:", response)
+  end,
+})
+
 -- Get all available prompts (can be used for integrations like fzf/telescope)
 local prompts = chat.prompts()
 
@@ -192,6 +199,7 @@ Also see [here](/lua/CopilotChat/config.lua):
   name = 'CopilotChat', -- Name to use in chat
   separator = '---', -- Separator to use in chat
   history_path = vim.fn.stdpath('data') .. '/copilotchat_history', -- Default path to stored history
+  callback = nil, -- Callback to use when ask response is received
   -- default prompts
   prompts = {
     Explain = {

lua/CopilotChat/config.lua

@@ -59,6 +59,7 @@ local select = require('CopilotChat.select')
 ---@field name string?
 ---@field separator string?
 ---@field history_path string?
+---@field callback fun(response: string)?
 ---@field prompts table<string, CopilotChat.config.prompt|string>?
 ---@field selection nil|fun(source: CopilotChat.config.source):CopilotChat.config.selection?
 ---@field window CopilotChat.config.window?
@@ -78,6 +79,7 @@ return {
   name = 'CopilotChat', -- Name to use in chat
   separator = '---', -- Separator to use in chat
   history_path = vim.fn.stdpath('data') .. '/copilotchat_history', -- Default path to stored history
+  callback = nil, -- Callback to use when ask response is received
   -- default prompts
   prompts = {
     Explain = {

lua/CopilotChat/init.lua

@@ -339,13 +339,16 @@ function M.ask(prompt, config, source)
         model = config.model,
         temperature = config.temperature,
         on_error = on_error,
-        on_done = function(_, token_count)
+        on_done = function(response, token_count)
           vim.schedule(function()
             if tiktoken.available() and token_count and token_count > 0 then
               append('\n\n' .. token_count .. ' tokens used')
             end
             append('\n\n' .. config.separator .. '\n\n')
             state.chat:finish()
+            if config.callback then
+              config.callback(response)
+            end
           end)
         end,
         on_progress = function(token)