refactor(config): reorganize shared/static config fields

- Moved UI-related config fields to shared section
- Updated type definitions and documentation
- Fixed selection highlight to respect config
- Improved token count display formatting

Signed-off-by: Tomas Slusny <slusnucky@gmail.com>

Author: deathbeam

README.md

@@ -421,7 +421,7 @@ Also see [here](/lua/CopilotChat/config.lua):
 ```lua
 {
 
-  -- Shared config starts here (can be passed to functions at runtime)
+  -- Shared config starts here (can be passed to functions at runtime and configured via setup function)
 
   system_prompt = prompts.COPILOT_INSTRUCTIONS, -- System prompt to use (can be specified manually in prompt via /).
   model = 'gpt-4o', -- Default model to use, see ':CopilotChatModels' for available models (can be specified manually in prompt via $).
@@ -452,30 +452,30 @@ Also see [here](/lua/CopilotChat/config.lua):
     zindex = 1, -- determines if window is on top or below other floating windows
   },
 
+  show_help = true, -- Shows help message as virtual lines when waiting for user input
+  show_folds = true, -- Shows folds for sections in chat
+  highlight_selection = true, -- Highlight selection
+  highlight_headers = true, -- Highlight headers in chat, disable if using markdown renderers (like render-markdown.nvim)
+  auto_follow_cursor = true, -- Auto-follow cursor in chat
+  auto_insert_mode = false, -- Automatically enter insert mode when opening window and on new prompt
+  insert_at_end = false, -- Move cursor to end of buffer when inserting text
+  clear_chat_on_new_prompt = false, -- Clears chat on every new prompt
+
   -- Static config starts here (can be configured only via setup function)
 
   debug = false, -- Enable debug logging (same as 'log_level = 'debug')
   log_level = 'info', -- Log level to use, 'trace', 'debug', 'info', 'warn', 'error', 'fatal'
   proxy = nil, -- [protocol://]host[:port] Use this proxy
   allow_insecure = false, -- Allow insecure server connections
+
+  chat_autocomplete = true, -- Enable chat autocompletion (when disabled, requires manual `mappings.complete` trigger)
   history_path = vim.fn.stdpath('data') .. '/copilotchat_history', -- Default path to stored history
 
   question_header = '## User ', -- Header to use for user questions
   answer_header = '## Copilot ', -- Header to use for AI answers
   error_header = '## Error ', -- Header to use for errors
   separator = '───', -- Separator to use in chat
 
-  show_folds = true, -- Shows folds for sections in chat
-  show_help = true, -- Shows help message as virtual lines when waiting for user input
-  highlight_selection = true, -- Highlight selection
-  highlight_headers = true, -- Highlight headers in chat, disable if using markdown renderers (like render-markdown.nvim)
-
-  chat_autocomplete = true, -- Enable chat autocompletion (when disabled, requires manual `mappings.complete` trigger)
-  auto_follow_cursor = true, -- Auto-follow cursor in chat
-  auto_insert_mode = false, -- Automatically enter insert mode when opening window and on new prompt
-  insert_at_end = false, -- Move cursor to end of buffer when inserting text
-  clear_chat_on_new_prompt = false, -- Clears chat on every new prompt
-
   -- default contexts
   contexts = {
     buffer = {

lua/CopilotChat/config.lua

@@ -78,33 +78,33 @@ local utils = require('CopilotChat.utils')
 ---@field callback fun(response: string, source: CopilotChat.config.source)?
 ---@field selection nil|fun(source: CopilotChat.config.source):CopilotChat.config.selection?
 ---@field window CopilotChat.config.window?
+---@field show_help boolean?
+---@field show_folds boolean?
+---@field highlight_selection boolean?
+---@field highlight_headers boolean?
+---@field auto_follow_cursor boolean?
+---@field auto_insert_mode boolean?
+---@field insert_at_end boolean?
+---@field clear_chat_on_new_prompt boolean?
 
 --- CopilotChat default configuration
 ---@class CopilotChat.config : CopilotChat.config.shared
 ---@field debug boolean?
 ---@field log_level string?
 ---@field proxy string?
 ---@field allow_insecure boolean?
+---@field chat_autocomplete boolean?
 ---@field history_path string?
 ---@field question_header string?
 ---@field answer_header string?
 ---@field error_header string?
 ---@field separator string?
----@field show_folds boolean?
----@field show_help boolean?
----@field highlight_selection boolean?
----@field highlight_headers boolean?
----@field chat_autocomplete boolean?
----@field auto_follow_cursor boolean?
----@field auto_insert_mode boolean?
----@field insert_at_end boolean?
----@field clear_chat_on_new_prompt boolean?
 ---@field contexts table<string, CopilotChat.config.context>?
 ---@field prompts table<string, CopilotChat.config.prompt|string>?
 ---@field mappings CopilotChat.config.mappings?
 return {
 
-  -- Shared config starts here (can be passed to functions at runtime)
+  -- Shared config starts here (can be passed to functions at runtime and configured via setup function)
 
   system_prompt = prompts.COPILOT_INSTRUCTIONS, -- System prompt to use (can be specified manually in prompt via /).
   model = 'gpt-4o', -- Default model to use, see ':CopilotChatModels' for available models (can be specified manually in prompt via $).
@@ -135,30 +135,30 @@ return {
     zindex = 1, -- determines if window is on top or below other floating windows
   },
 
+  show_help = true, -- Shows help message as virtual lines when waiting for user input
+  show_folds = true, -- Shows folds for sections in chat
+  highlight_selection = true, -- Highlight selection
+  highlight_headers = true, -- Highlight headers in chat, disable if using markdown renderers (like render-markdown.nvim)
+  auto_follow_cursor = true, -- Auto-follow cursor in chat
+  auto_insert_mode = false, -- Automatically enter insert mode when opening window and on new prompt
+  insert_at_end = false, -- Move cursor to end of buffer when inserting text
+  clear_chat_on_new_prompt = false, -- Clears chat on every new prompt
+
   -- Static config starts here (can be configured only via setup function)
 
   debug = false, -- Enable debug logging (same as 'log_level = 'debug')
   log_level = 'info', -- Log level to use, 'trace', 'debug', 'info', 'warn', 'error', 'fatal'
   proxy = nil, -- [protocol://]host[:port] Use this proxy
   allow_insecure = false, -- Allow insecure server connections
+
+  chat_autocomplete = true, -- Enable chat autocompletion (when disabled, requires manual `mappings.complete` trigger)
   history_path = vim.fn.stdpath('data') .. '/copilotchat_history', -- Default path to stored history
 
   question_header = '## User ', -- Header to use for user questions
   answer_header = '## Copilot ', -- Header to use for AI answers
   error_header = '## Error ', -- Header to use for errors
   separator = '───', -- Separator to use in chat
 
-  show_folds = true, -- Shows folds for sections in chat
-  show_help = true, -- Shows help message as virtual lines when waiting for user input
-  highlight_selection = true, -- Highlight selection
-  highlight_headers = true, -- Highlight headers in chat, disable if using markdown renderers (like render-markdown.nvim)
-
-  chat_autocomplete = true, -- Enable chat autocompletion (when disabled, requires manual `mappings.complete` trigger)
-  auto_follow_cursor = true, -- Auto-follow cursor in chat
-  auto_insert_mode = false, -- Automatically enter insert mode when opening window and on new prompt
-  insert_at_end = false, -- Move cursor to end of buffer when inserting text
-  clear_chat_on_new_prompt = false, -- Clears chat on every new prompt
-
   -- default contexts
   contexts = {
     buffer = {

lua/CopilotChat/init.lua

@@ -69,7 +69,7 @@ local function highlight_selection(clear, config)
     vim.api.nvim_buf_clear_namespace(buf, selection_ns, 0, -1)
   end
 
-  if clear then
+  if clear or not config.highlight_selection then
     return
   end
 
@@ -948,7 +948,10 @@ function M.setup(config)
     state.chat:delete()
   end
   state.chat = Chat(
-    M.config.show_help and key_to_info('show_help', M.config.mappings.show_help),
+    M.config.question_header,
+    M.config.answer_header,
+    M.config.separator,
+    key_to_info('show_help', M.config.mappings.show_help),
     function(bufnr)
       map_key(M.config.mappings.show_help, bufnr, function()
         local chat_help = '**`Special tokens`**\n'

lua/CopilotChat/ui/chat.lua

@@ -57,17 +57,24 @@ end
 ---@field content string?
 
 ---@class CopilotChat.ui.Chat : CopilotChat.ui.Overlay
+---@field question_header string
+---@field answer_header string
+---@field separator string
 ---@field header_ns number
 ---@field winnr number?
 ---@field spinner CopilotChat.ui.Spinner
 ---@field sections table<CopilotChat.ui.Chat.Section>
----@field config CopilotChat.config
+---@field config CopilotChat.config.shared
 ---@field token_count number?
 ---@field token_max_count number?
-local Chat = class(function(self, help, on_buf_create)
+local Chat = class(function(self, question_header, answer_header, separator, help, on_buf_create)
   Overlay.init(self, 'copilot-chat', help, on_buf_create)
   vim.treesitter.language.register('markdown', self.name)
 
+  self.question_header = question_header
+  self.answer_header = answer_header
+  self.separator = separator
+
   self.header_ns = vim.api.nvim_create_namespace('copilot-chat-headers')
   self.winnr = nil
   self.spinner = nil
@@ -134,7 +141,7 @@ function Chat:render()
   for l, line in ipairs(lines) do
     local separator_found = false
 
-    if line == self.config.answer_header .. self.config.separator then
+    if line == self.answer_header .. self.separator then
       separator_found = true
       if current_section then
         current_section.end_line = l - 1
@@ -145,7 +152,7 @@ function Chat:render()
         start_line = l + 1,
         blocks = {},
       }
-    elseif line == self.config.question_header .. self.config.separator then
+    elseif line == self.question_header .. self.separator then
       separator_found = true
       if current_section then
         current_section.end_line = l - 1
@@ -165,12 +172,12 @@ function Chat:render()
 
     -- Highlight separators
     if self.config.highlight_headers and separator_found then
-      local sep = vim.fn.strwidth(line) - vim.fn.strwidth(self.config.separator)
+      local sep = vim.fn.strwidth(line) - vim.fn.strwidth(self.separator)
       -- separator line
       vim.api.nvim_buf_set_extmark(self.bufnr, self.header_ns, l - 1, sep, {
         virt_text_win_col = sep,
         virt_text = {
-          { string.rep(self.config.separator, vim.go.columns), 'CopilotChatSeparator' },
+          { string.rep(self.separator, vim.go.columns), 'CopilotChatSeparator' },
         },
         priority = 100,
         strict = false,
@@ -213,10 +220,14 @@ function Chat:render()
 
   local last_section = sections[#sections]
   if last_section and not last_section.answer then
-    local msg = self.help
+    local msg = self.config.show_help and self.help or ''
     if self.token_count and self.token_max_count then
-      msg = msg .. '\n' .. self.token_count .. '/' .. self.token_max_count .. ' tokens used'
+      if msg ~= '' then
+        msg = msg .. '\n'
+      end
+      msg = msg .. self.token_count .. '/' .. self.token_max_count .. ' tokens used'
     end
+
     self:show_help(msg, last_section.start_line - last_section.end_line - 1)
   else
     self:clear_help()
@@ -387,7 +398,7 @@ function Chat:clear()
   vim.bo[self.bufnr].modifiable = false
 end
 
----@param config CopilotChat.config
+---@param config CopilotChat.config.shared
 function Chat:open(config)
   self:validate()
   self.config = config
@@ -454,7 +465,7 @@ function Chat:open(config)
   if config.show_folds then
     vim.wo[self.winnr].foldcolumn = '1'
     vim.wo[self.winnr].foldmethod = 'expr'
-    vim.wo[self.winnr].foldexpr = "v:lua.CopilotChatFoldExpr(v:lnum, '" .. config.separator .. "')"
+    vim.wo[self.winnr].foldexpr = "v:lua.CopilotChatFoldExpr(v:lnum, '" .. self.separator .. "')"
   else
     vim.wo[self.winnr].foldcolumn = '0'
   end