feat(context): add system context for shell command output

Adds a new 'system' context that allows including the output of shell
commands in chat context. This feature is useful for incorporating
system information or command results directly into Copilot Chat.

The implementation:
- Updates documentation in README.md
- Adds new context entry in contexts.lua with input prompt
- Implements M.cmd() function with cross-platform support
- Adds status notifications for context operations

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

Author: deathbeam

README.md

@@ -180,7 +180,6 @@ The mappings can be customized by setting the `mappings` table in your configura
 
 - `normal`: Key for normal mode
 - `insert`: Key for insert mode
-- `detail`: Description of what the mapping does
 
 For example, to change the submit prompt mapping or show_diff full diff option:
 
@@ -323,6 +322,7 @@ Contexts provide additional information to the chat. Add context using `#context
 | `url`       | ✓ (url)       | Content from URL                    |
 | `register`  | ✓ (name)      | Content of vim register             |
 | `quickfix`  | -             | Quickfix list file contents         |
+| `system`    | ✓ (command)   | Output of shell command             |
 
 Examples:
 
@@ -333,6 +333,7 @@ Examples:
 > #filenames
 > #git:staged
 > #url:https://example.com
+> #system:`ls -la | grep lua`
 ```
 
 Define your own contexts in the configuration with input handling and resolution:
@@ -575,7 +576,6 @@ Below are all available configuration options with their default values:
       insert = '<C-s>',
     },
     toggle_sticky = {
-      detail = 'Makes line under cursor sticky or deletes sticky line.',
       normal = 'gr',
     },
     accept_diff = {

lua/CopilotChat/config/contexts.lua

@@ -172,4 +172,18 @@ return {
       return context.quickfix()
     end,
   },
+
+  system = {
+    description = 'Includes output of provided system shell command in chat context. Supports input.',
+    input = function(callback)
+      vim.ui.input({
+        prompt = 'Enter command> ',
+      }, callback)
+    end,
+    resolve = function(input)
+      return {
+        context.system(input),
+      }
+    end,
+  },
 }

lua/CopilotChat/config/mappings.lua

@@ -98,7 +98,6 @@ end
 ---@class CopilotChat.config.mapping
 ---@field normal string?
 ---@field insert string?
----@field detail string?
 ---@field callback fun(overlay: CopilotChat.ui.Overlay, diff: CopilotChat.ui.Diff, chat: CopilotChat.ui.Chat, source: CopilotChat.source)
 
 ---@class CopilotChat.config.mapping.yank_diff : CopilotChat.config.mapping
@@ -159,7 +158,6 @@ return {
   },
 
   toggle_sticky = {
-    detail = 'Makes line under cursor sticky or deletes sticky line.',
     normal = 'gr',
     callback = function(overlay, diff, chat)
       local section = chat:get_closest_section()

lua/CopilotChat/context.lua

@@ -458,6 +458,7 @@ end
 ---@param bufnr number
 ---@return CopilotChat.context.embed?
 function M.buffer(bufnr)
+  notify.publish(notify.STATUS, 'Reading buffer ' .. bufnr)
   utils.schedule_main()
 
   if not utils.buf_valid(bufnr) then
@@ -593,6 +594,7 @@ end
 ---@param register string
 ---@return CopilotChat.context.embed?
 function M.register(register)
+  notify.publish(notify.STATUS, 'Reading register ' .. register)
   utils.schedule_main()
 
   local lines = vim.fn.getreg(register)
@@ -610,6 +612,7 @@ end
 --- Get the content of the quickfix list
 ---@return table<CopilotChat.context.embed>
 function M.quickfix()
+  notify.publish(notify.STATUS, 'Reading quickfix list')
   utils.schedule_main()
 
   local items = vim.fn.getqflist()
@@ -647,6 +650,32 @@ function M.quickfix()
   return out
 end
 
+--- Get the output of a system shell command
+---@param command string The command to execute
+---@return CopilotChat.context.embed?
+function M.system(command)
+  notify.publish(notify.STATUS, 'Executing command: ' .. command)
+  utils.schedule_main()
+
+  local shell, shell_flag
+  if vim.fn.has('win32') == 1 then
+    shell, shell_flag = 'cmd.exe', '/c'
+  else
+    shell, shell_flag = 'sh', '-c'
+  end
+
+  local out = utils.system({ shell, shell_flag, command })
+  if not out or out.stdout == '' then
+    return nil
+  end
+
+  return {
+    content = out.stdout,
+    filename = 'command_output_' .. command:gsub('[^%w]', '_'):sub(1, 20),
+    filetype = 'text',
+  }
+end
+
 --- Filter embeddings based on the query
 ---@param prompt string
 ---@param model string

lua/CopilotChat/init.lua

@@ -7,6 +7,7 @@ local utils = require('CopilotChat.utils')
 local M = {}
 local PLUGIN_NAME = 'CopilotChat'
 local WORD = '([^%s]+)'
+local WORD_INPUT = '([^%s:]+:`[^`]+`)'
 
 --- @class CopilotChat.source
 --- @field bufnr number
@@ -260,6 +261,10 @@ function M.resolve_embeddings(prompt, config)
     local split = vim.split(prompt_context, ':')
     local context_name = table.remove(split, 1)
     local context_input = vim.trim(table.concat(split, ':'))
+    if vim.startswith(context_input, '`') and vim.endswith(context_input, '`') then
+      context_input = context_input:sub(2, -2)
+    end
+
     if M.config.contexts[context_name] then
       table.insert(contexts, {
         name = context_name,
@@ -272,11 +277,12 @@ function M.resolve_embeddings(prompt, config)
     return false
   end
 
+  prompt = prompt:gsub('#' .. WORD_INPUT, function(match)
+    return parse_context(match) and '' or '#' .. match
+  end)
+
   prompt = prompt:gsub('#' .. WORD, function(match)
-    if parse_context(match) then
-      return ''
-    end
-    return '#' .. match
+    return parse_context(match) and '' or '#' .. match
   end)
 
   if config.context then
@@ -392,7 +398,11 @@ function M.trigger_complete(with_context)
             return
           end
 
-          local value_str = tostring(value)
+          local value_str = vim.trim(tostring(value))
+          if value_str:find('%s') then
+            value_str = '`' .. value_str .. '`'
+          end
+
           vim.api.nvim_buf_set_text(bufnr, row - 1, col, row - 1, col, { value_str })
           vim.api.nvim_win_set_cursor(0, { row, col + #value_str })
         end, state.source or {})

lua/CopilotChat/utils.lua

@@ -480,6 +480,7 @@ end, 1)
 
 --- Get the info for a key.
 ---@param name string
+---@param key table
 ---@param surround string|nil
 ---@return string
 function M.key_to_info(name, key, surround)
@@ -502,13 +503,7 @@ function M.key_to_info(name, key, surround)
     return out
   end
 
-  out = out .. ' to ' .. name:gsub('_', ' ')
-
-  if key.detail and key.detail ~= '' then
-    out = out .. '. ' .. key.detail
-  end
-
-  return out
+  return out .. ' to ' .. name:gsub('_', ' ')
 end
 
 --- Check if a value is empty