refactor(api): improve Chat class organization and privacy

This commit restructures the CopilotChat API, particularly the Chat class
in ui/chat.lua. Changes include:
- Move method definitions to match class-like organization
- Add JSDoc comments for public methods
- Mark private/protected methods and properties
- Rename method 'active()' to 'focused()' for clarity
- Move class annotations from file start to declaration
- Rename 'overlay' to 'chat_overlay' to avoid property/method conflict
- Replace 'show_overlay()' method with simpler 'overlay()' name

Author: deathbeam

lua/CopilotChat/config/mappings.lua

@@ -1,4 +1,8 @@
----@class CopilotChat.ui.Diff.Diff
+local async = require('plenary.async')
+local copilot = require('CopilotChat')
+local utils = require('CopilotChat.utils')
+
+---@class CopilotChat.config.mappings.diff
 ---@field change string
 ---@field reference string
 ---@field filename string
@@ -7,12 +11,9 @@
 ---@field end_line number
 ---@field bufnr number?
 
-local async = require('plenary.async')
-local copilot = require('CopilotChat')
-local utils = require('CopilotChat.utils')
-
+--- Get diff data from a block
 ---@param block CopilotChat.ui.Chat.Section.Block?
----@return CopilotChat.ui.Diff.Diff?
+---@return CopilotChat.config.mappings.diff?
 local function get_diff(block)
   -- If no block found, return nil
   if not block then
@@ -71,9 +72,9 @@ local function get_diff(block)
 end
 
 --- Prepare a buffer for applying a diff
----@param diff CopilotChat.ui.Diff.Diff?
+---@param diff CopilotChat.config.mappings.diff?
 ---@param source CopilotChat.source?
----@return CopilotChat.ui.Diff.Diff?
+---@return CopilotChat.config.mappings.diff?
 local function prepare_diff_buffer(diff, source)
   if not diff then
     return diff
@@ -396,7 +397,7 @@ return {
         }))
       end
 
-      copilot.chat:show_overlay(opts)
+      copilot.chat:overlay(opts)
     end,
   },
 
@@ -442,7 +443,7 @@ return {
           table.insert(lines, '')
         end
 
-        copilot.chat:show_overlay({
+        copilot.chat:overlay({
           text = vim.trim(table.concat(lines, '\n')) .. '\n',
         })
       end)
@@ -491,7 +492,7 @@ return {
         end
 
         utils.schedule_main()
-        copilot.chat:show_overlay({
+        copilot.chat:overlay({
           text = vim.trim(table.concat(lines, '\n')) .. '\n',
         })
       end)
@@ -527,7 +528,7 @@ return {
         end
       end
 
-      copilot.chat:show_overlay({
+      copilot.chat:overlay({
         text = chat_help,
       })
     end,

lua/CopilotChat/config/prompts.lua

@@ -1,8 +1,3 @@
----@class CopilotChat.config.prompt : CopilotChat.config.shared
----@field prompt string?
----@field description string?
----@field mapping string?
-
 local base = string.format(
   [[
 When asked for your name, you must respond with "GitHub Copilot".
@@ -14,6 +9,7 @@ Keep your answers short and impersonal.
 The user works in an IDE called Neovim which has a concept for editors with open files, integrated unit test support, an output pane that shows the output of running the code as well as an integrated terminal.
 The user is working on a %s machine. Please respond with system specific commands if applicable.
 You will receive code snippets that include line number prefixes - use these to maintain correct position references but remove them when generating output.
+If you don't have sufficient context to answer accurately, ask for specific additional information rather than making assumptions.
 
 When presenting code changes:
 
@@ -81,6 +77,11 @@ End with: "**`To clear buffer highlights, please ask a different question.`**"
 If no issues found, confirm the code is well-written and explain why.
 ]]
 
+---@class CopilotChat.config.prompt : CopilotChat.config.shared
+---@field prompt string?
+---@field description string?
+---@field mapping string?
+
 ---@type table<string, CopilotChat.config.prompt>
 return {
   COPILOT_INSTRUCTIONS = {

lua/CopilotChat/config/providers.lua

@@ -1,50 +1,5 @@
 local utils = require('CopilotChat.utils')
 
----@class CopilotChat.Provider.model
----@field id string
----@field name string
----@field tokenizer string?
----@field max_input_tokens number?
----@field max_output_tokens number?
-
----@class CopilotChat.Provider.agent
----@field id string
----@field name string
----@field description string?
-
----@class CopilotChat.Provider.embed
----@field index number
----@field embedding table<number>
-
----@class CopilotChat.Provider.options
----@field model CopilotChat.Provider.model
----@field agent CopilotChat.Provider.agent?
----@field temperature number?
-
----@class CopilotChat.Provider.input
----@field role string
----@field content string
-
----@class CopilotChat.Provider.reference
----@field name string
----@field url string
-
----@class CopilotChat.Provider.output
----@field content string
----@field finish_reason string?
----@field total_tokens number?
----@field references table<CopilotChat.Provider.reference>?
-
----@class CopilotChat.Provider
----@field disabled nil|boolean
----@field get_headers nil|fun():table<string, string>,number?
----@field get_agents nil|fun(headers:table):table<CopilotChat.Provider.agent>
----@field get_models nil|fun(headers:table):table<CopilotChat.Provider.model>
----@field embed nil|string|fun(inputs:table<string>, headers:table):table<CopilotChat.Provider.embed>
----@field prepare_input nil|fun(inputs:table<CopilotChat.Provider.input>, opts:CopilotChat.Provider.options):table
----@field prepare_output nil|fun(output:table, opts:CopilotChat.Provider.options):CopilotChat.Provider.output
----@field get_url nil|fun(opts:CopilotChat.Provider.options):string
-
 local EDITOR_VERSION = 'Neovim/'
   .. vim.version().major
   .. '.'
@@ -117,6 +72,51 @@ local function get_github_token()
   error('Failed to find GitHub token')
 end
 
+---@class CopilotChat.Provider.model
+---@field id string
+---@field name string
+---@field tokenizer string?
+---@field max_input_tokens number?
+---@field max_output_tokens number?
+
+---@class CopilotChat.Provider.agent
+---@field id string
+---@field name string
+---@field description string?
+
+---@class CopilotChat.Provider.embed
+---@field index number
+---@field embedding table<number>
+
+---@class CopilotChat.Provider.options
+---@field model CopilotChat.Provider.model
+---@field agent CopilotChat.Provider.agent?
+---@field temperature number?
+
+---@class CopilotChat.Provider.input
+---@field role string
+---@field content string
+
+---@class CopilotChat.Provider.reference
+---@field name string
+---@field url string
+
+---@class CopilotChat.Provider.output
+---@field content string
+---@field finish_reason string?
+---@field total_tokens number?
+---@field references table<CopilotChat.Provider.reference>?
+
+---@class CopilotChat.Provider
+---@field disabled nil|boolean
+---@field get_headers nil|fun():table<string, string>,number?
+---@field get_agents nil|fun(headers:table):table<CopilotChat.Provider.agent>
+---@field get_models nil|fun(headers:table):table<CopilotChat.Provider.model>
+---@field embed nil|string|fun(inputs:table<string>, headers:table):table<CopilotChat.Provider.embed>
+---@field prepare_input nil|fun(inputs:table<CopilotChat.Provider.input>, opts:CopilotChat.Provider.options):table
+---@field prepare_output nil|fun(output:table, opts:CopilotChat.Provider.options):CopilotChat.Provider.output
+---@field get_url nil|fun(opts:CopilotChat.Provider.options):string
+
 ---@type table<string, CopilotChat.Provider>
 local M = {}
 

lua/CopilotChat/init.lua

@@ -4,11 +4,15 @@ local context = require('CopilotChat.context')
 local client = require('CopilotChat.client')
 local utils = require('CopilotChat.utils')
 
-local M = {}
 local PLUGIN_NAME = 'CopilotChat'
 local WORD = '([^%s]+)'
 local WORD_INPUT = '([^%s:]+:`[^`]+`)'
 
+---@class CopilotChat
+---@field config CopilotChat.config
+---@field chat CopilotChat.ui.Chat
+local M = {}
+
 --- @class CopilotChat.source
 --- @field bufnr number
 --- @field winnr number
@@ -104,7 +108,7 @@ local function update_highlights()
     vim.api.nvim_buf_clear_namespace(buf, selection_ns, 0, -1)
   end
 
-  if M.chat.config.highlight_selection and M.chat:active() then
+  if M.chat.config.highlight_selection and M.chat:focused() then
     local selection = M.get_selection()
     if
       not selection
@@ -141,6 +145,7 @@ local function update_highlights()
   end)
 end
 
+--- Finish writing to chat buffer.
 ---@param start_of_chat boolean?
 local function finish(start_of_chat)
   if not start_of_chat then
@@ -172,6 +177,7 @@ local function finish(start_of_chat)
   M.chat:finish()
 end
 
+--- Show an error in the chat window.
 ---@param err string|table|nil
 ---@param append_newline boolean?
 local function show_error(err, append_newline)
@@ -774,7 +780,7 @@ function M.ask(prompt, config)
       finish()
     end
 
-    if not M.chat:active() then
+    if not M.chat:focused() then
       M.open(config)
     end
 
@@ -972,7 +978,20 @@ function M.load(name, history_path)
 
   client:reset()
   M.chat:clear()
-  M.chat:load_history(history)
+
+  for i, message in ipairs(history) do
+    if message.role == 'user' then
+      if i > 1 then
+        M.chat:append('\n\n')
+      end
+      M.chat:append(M.config.question_header .. M.config.separator .. '\n\n')
+      M.chat:append(message.content)
+    elseif message.role == 'assistant' then
+      M.chat:append('\n\n' .. M.config.answer_header .. M.config.separator .. '\n\n')
+      M.chat:append(message.content)
+    end
+  end
+
   log.info('Loaded history from ' .. history_path)
 
   if #history > 0 then