refactor: unify info display into show_info and show_context

Consolidates multiple info display commands (show_system_prompt, show_user_selection, show_user_context) into two more comprehensive commands: - show_info (gi): displays model, agent and system prompt - show_context (gc): shows selection and embeddings This change improves UX by providing more organized and complete information when inspecting chat context and configuration. BREAKING CHANGE: Removed show_system_prompt (gp), show_user_selection (gs) and show_user_context mappings in favor of new unified commands. Signed-off-by: Tomas Slusny <[email protected]>
CopilotC-Nvim · Nov 29, 2024 · b054b9f · b054b9f
1 parent d261d51
commit b054b9f
Show file tree

Hide file tree

Showing 3 changed files with 122 additions and 62 deletions.
diff --git a/README.md b/README.md
@@ -148,9 +148,8 @@ See @deathbeam for [configuration](https://github.com/deathbeam/dotfiles/blob/ma
 - `gq` - Add all diffs from chat to quickfix list
 - `gy` - Yank nearest diff to register (defaults to `"`)
 - `gd` - Show diff between source and nearest diff
-- `gp` - Show system prompt for current chat
-- `gs` - Show current user selection
-- `gc` - Show current user context
+- `gi` - Show info about current chat (model, agent, system prompt)
+- `gc` - Show current chat context
 - `gh` - Show help message
 
 The mappings can be customized by setting the `mappings` table in your configuration. Each mapping can have:
@@ -562,13 +561,10 @@ Also see [here](/lua/CopilotChat/config.lua):
     show_diff = {
       normal = 'gd',
     },
-    show_system_prompt = {
-      normal = 'gp',
+    show_info = {
+      normal = 'gi',
     },
-    show_user_selection = {
-      normal = 'gs',
-    },
-    show_user_context = {
+    show_context = {
       normal = 'gc',
     },
     show_help = {

diff --git a/lua/CopilotChat/config.lua b/lua/CopilotChat/config.lua
@@ -48,9 +48,8 @@ local utils = require('CopilotChat.utils')
 ---@field quickfix_diffs CopilotChat.config.mapping?
 ---@field yank_diff CopilotChat.config.mapping.register?
 ---@field show_diff CopilotChat.config.mapping?
----@field show_system_prompt CopilotChat.config.mapping?
----@field show_user_selection CopilotChat.config.mapping?
----@field show_user_context CopilotChat.config.mapping?
+---@field show_info CopilotChat.config.mapping?
+---@field show_context CopilotChat.config.mapping?
 ---@field show_help CopilotChat.config.mapping?
 
 ---@class CopilotChat.config.shared
@@ -378,13 +377,10 @@ return {
     show_diff = {
       normal = 'gd',
     },
-    show_system_prompt = {
-      normal = 'gp',
+    show_info = {
+      normal = 'gi',
     },
-    show_user_selection = {
-      normal = 'gs',
-    },
-    show_user_context = {
+    show_context = {
       normal = 'gc',
     },
     show_help = {

diff --git a/lua/CopilotChat/init.lua b/lua/CopilotChat/init.lua
@@ -281,6 +281,34 @@ local function resolve_embeddings(prompt, config)
   return embeddings:values(), prompt
 end
 
+local function resolve_agent(prompt, config)
+  local agents = vim.tbl_keys(state.copilot:list_agents())
+  local selected_agent = config.agent
+  prompt = prompt:gsub('@' .. WORD, function(match)
+    if vim.tbl_contains(agents, match) then
+      selected_agent = match
+      return ''
+    end
+    return '@' .. match
+  end)
+
+  return selected_agent, prompt
+end
+
+local function resolve_model(prompt, config)
+  local models = vim.tbl_keys(state.copilot:list_models())
+  local selected_model = config.model
+  prompt = prompt:gsub('%$' .. WORD, function(match)
+    if vim.tbl_contains(models, match) then
+      selected_model = match
+      return ''
+    end
+    return '$' .. match
+  end)
+
+  return selected_model, prompt
+end
+
 ---@param start_of_chat boolean?
 local function finish(start_of_chat)
   if not start_of_chat then
@@ -684,28 +712,9 @@ function M.ask(prompt, config)
   local selection = get_selection(config)
 
   local ok, err = pcall(async.run, function()
-    local embeddings, embedded_prompt = resolve_embeddings(prompt, config)
-    prompt = embedded_prompt
-
-    local agents = vim.tbl_keys(state.copilot:list_agents())
-    local selected_agent = config.agent
-    prompt = prompt:gsub('@' .. WORD, function(match)
-      if vim.tbl_contains(agents, match) then
-        selected_agent = match
-        return ''
-      end
-      return '@' .. match
-    end)
-
-    local models = vim.tbl_keys(state.copilot:list_models())
-    local selected_model = config.model
-    prompt = prompt:gsub('%$' .. WORD, function(match)
-      if vim.tbl_contains(models, match) then
-        selected_model = match
-        return ''
-      end
-      return '$' .. match
-    end)
+    local embeddings, prompt = resolve_embeddings(prompt, config)
+    local selected_agent, prompt = resolve_agent(prompt, config)
+    local selected_model, prompt = resolve_model(prompt, config)
 
     local has_output = false
     local query_ok, filtered_embeddings =
@@ -875,6 +884,14 @@ function M.setup(config)
             normal = key,
           }
         end
+
+        if name == 'show_system_prompt' then
+          utils.deprecate('config.mappings.' .. name, 'config.mappings.show_info')
+        end
+
+        if name == 'show_user_context' or name == 'show_user_selection' then
+          utils.deprecate('config.mappings.' .. name, 'config.mappings.show_context')
+        end
       end
     end
 
@@ -1137,52 +1154,103 @@ function M.setup(config)
         state.diff:show(diff, state.chat.winnr)
       end)
 
-      map_key('show_system_prompt', bufnr, function()
+      map_key('show_info', bufnr, function()
         local section = state.chat:get_closest_section()
-        local system_prompt = state.chat.config.system_prompt
-        if section and not section.answer then
-          _, system_prompt = resolve_prompts(section.content, system_prompt)
-        end
-        if not system_prompt then
+        if not section or section.answer then
           return
         end
 
-        state.overlay:show(vim.trim(system_prompt) .. '\n', state.chat.winnr, 'markdown')
+        local lines = {}
+        local config = state.chat.config
+        local prompt, system_prompt = resolve_prompts(section.content, config.system_prompt)
+
+        async.run(function()
+          local selected_agent = resolve_agent(prompt, config)
+          local selected_model = resolve_model(prompt, config)
+
+          if selected_model then
+            table.insert(lines, '**Model**')
+            table.insert(lines, '```')
+            table.insert(lines, selected_model)
+            table.insert(lines, '```')
+            table.insert(lines, '')
+          end
+
+          if selected_agent then
+            table.insert(lines, '**Agent**')
+            table.insert(lines, '```')
+            table.insert(lines, selected_agent)
+            table.insert(lines, '```')
+            table.insert(lines, '')
+          end
+
+          if system_prompt then
+            table.insert(lines, '**System Prompt**')
+            table.insert(lines, '```')
+            for _, line in ipairs(vim.split(vim.trim(system_prompt), '\n')) do
+              table.insert(lines, line)
+            end
+            table.insert(lines, '```')
+            table.insert(lines, '')
+          end
+
+          async.util.scheduler()
+          state.overlay:show(
+            vim.trim(table.concat(lines, '\n')) .. '\n',
+            state.chat.winnr,
+            'markdown'
+          )
+        end)
       end)
 
-      map_key('show_user_selection', bufnr, function()
-        local selection = get_selection(state.chat.config)
-        if not selection then
+      map_key('show_context', bufnr, function()
+        local section = state.chat:get_closest_section()
+        if not section or section.answer then
           return
         end
 
-        state.overlay:show(selection.content, state.chat.winnr, selection.filetype)
-      end)
+        local lines = {}
 
-      map_key('show_user_context', bufnr, function()
-        local section = state.chat:get_closest_section()
+        local selection = get_selection(state.chat.config)
+        if selection then
+          table.insert(lines, '**Selection**')
+          table.insert(lines, '```' .. selection.filetype)
+          for _, line in ipairs(vim.split(selection.content, '\n')) do
+            table.insert(lines, line)
+          end
+          table.insert(lines, '```')
+          table.insert(lines, '')
+        end
 
         async.run(function()
           local embeddings = {}
           if section and not section.answer then
             embeddings = resolve_embeddings(section.content, state.chat.config)
           end
 
-          local text = ''
           for _, embedding in ipairs(embeddings) do
-            local lines = vim.split(embedding.content, '\n')
-            local preview = table.concat(vim.list_slice(lines, 1, math.min(10, #lines)), '\n')
-            local header = string.format('**`%s`** (%s lines)', embedding.filename, #lines)
-            if #lines > 10 then
+            local embed_lines = vim.split(embedding.content, '\n')
+            local preview = vim.list_slice(embed_lines, 1, math.min(10, #embed_lines))
+            local header = string.format('**%s** (%s lines)', embedding.filename, #embed_lines)
+            if #embed_lines > 10 then
               header = header .. ' (truncated)'
             end
 
-            text = text
-              .. string.format('%s\n```%s\n%s\n```\n\n', header, embedding.filetype, preview)
+            table.insert(lines, header)
+            table.insert(lines, '```' .. embedding.filetype)
+            for _, line in ipairs(preview) do
+              table.insert(lines, line)
+            end
+            table.insert(lines, '```')
+            table.insert(lines, '')
           end
 
           async.util.scheduler()
-          state.overlay:show(vim.trim(text) .. '\n', state.chat.winnr, 'markdown')
+          state.overlay:show(
+            vim.trim(table.concat(lines, '\n')) .. '\n',
+            state.chat.winnr,
+            'markdown'
+          )
         end)
       end)