refactor: clean up config and lua types

olimorris · Oct 9, 2024 · 54b3107 · 54b3107
1 parent c5c741d
commit 54b3107
Show file tree

Hide file tree

Showing 39 changed files with 206 additions and 172 deletions.
diff --git a/.luarc.json b/.luarc.json
@@ -1,5 +1,10 @@
 {
-    "diagnostics.globals": [
-        "vim"
-    ]
-}
+  "runtime": {
+    "version": "LuaJIT",
+    "pathStrict": true
+  },
+  "diagnostics.globals": ["vim"],
+  "type": {
+    "checkTableShape": true
+  }
+}
diff --git a/README.md b/README.md
@@ -203,17 +203,20 @@ Run `:CodeCompanionActions` to open the action palette, which gives you access t
 
 **List of commands**
 
-Below is a list of the plugin's commands:
+The plugin has three core commands:
 
 - `CodeCompanion` - Open the inline assistant
+- `CodeCompanionChat` - Open a chat buffer
+- `CodeCompanionActions` - Open the _Action Palette_
+
+However there are multiple options available:
+
 - `CodeCompanion <your prompt>` - Prompt the inline assistant
 - `CodeCompanion /<prompt library>` - Use the [prompt library](#clipboard-prompt-library) with the inline assistant e.g. `/commit`
-- `CodeCompanionChat` - Open a chat buffer
 - `CodeCompanionChat <prompt>` - Send a prompt to the LLM via a chat buffer
 - `CodeCompanionChat <adapter>` - Open a chat buffer with a specific adapter
 - `CodeCompanionChat Toggle` - Toggle a chat buffer
 - `CodeCompanionChat Add` - Add visually selected chat to the current chat buffer
-- `CodeCompanionActions` - Open the _Action Palette_
 
 **Suggested workflow**
 

diff --git a/doc/codecompanion.txt b/doc/codecompanion.txt
@@ -1,4 +1,4 @@
-*codecompanion.txt*        For NVIM v0.10.0       Last change: 2024 October 08
+*codecompanion.txt*        For NVIM v0.10.0       Last change: 2024 October 09
 
 ==============================================================================
 Table of Contents                            *codecompanion-table-of-contents*
@@ -177,17 +177,20 @@ codecompanion`.
   mode_.
 **List of commands**
 
-Below is a list of the plugin’s commands:
+The plugin has three core commands:
 
 - `CodeCompanion` - Open the inline assistant
+- `CodeCompanionChat` - Open a chat buffer
+- `CodeCompanionActions` - Open the _Action Palette_
+
+However there are multiple options available:
+
 - `CodeCompanion <your prompt>` - Prompt the inline assistant
 - `CodeCompanion /<prompt library>` - Use the |codecompanion-prompt-library| with the inline assistant e.g. `/commit`
-- `CodeCompanionChat` - Open a chat buffer
 - `CodeCompanionChat <prompt>` - Send a prompt to the LLM via a chat buffer
 - `CodeCompanionChat <adapter>` - Open a chat buffer with a specific adapter
 - `CodeCompanionChat Toggle` - Toggle a chat buffer
 - `CodeCompanionChat Add` - Add visually selected chat to the current chat buffer
-- `CodeCompanionActions` - Open the _Action Palette_
 
 **Suggested workflow**
 

diff --git a/lua/cmp_codecompanion/slash_commands.lua b/lua/cmp_codecompanion/slash_commands.lua
@@ -1,5 +1,5 @@
-local config = require("codecompanion").config
 local SlashCommands = require("codecompanion.strategies.chat.slash_commands")
+local config = require("codecompanion.config")
 local strategy = require("codecompanion.strategies")
 
 local source = {}

diff --git a/lua/codecompanion/actions/init.lua b/lua/codecompanion/actions/init.lua
@@ -1,5 +1,5 @@
-local config = require("codecompanion").config
 local Strategy = require("codecompanion.strategies")
+local config = require("codecompanion.config")
 local prompt_library = require("codecompanion.actions.prompt_library")
 local static_actions = require("codecompanion.actions.static")
 

diff --git a/lua/codecompanion/actions/providers/default.lua b/lua/codecompanion/actions/providers/default.lua
@@ -1,4 +1,4 @@
-local config = require("codecompanion").config
+local config = require("codecompanion.config")
 
 local log = require("codecompanion.utils.log")
 local ui = require("codecompanion.utils.ui")

diff --git a/lua/codecompanion/actions/providers/mini_pick.lua b/lua/codecompanion/actions/providers/mini_pick.lua
@@ -1,5 +1,4 @@
 local MiniPick = require("mini.pick")
-local config = require("codecompanion").config
 local log = require("codecompanion.utils.log")
 
 ---@class CodeCompanion.Actions.Providers.MiniPick

diff --git a/lua/codecompanion/actions/providers/telescope.lua b/lua/codecompanion/actions/providers/telescope.lua
@@ -5,7 +5,7 @@ local action_state = require("telescope.actions.state")
 local telescope_actions = require("telescope.actions")
 
 local is_registered = false
-local config = require("codecompanion").config
+local config = require("codecompanion.config")
 
 local log = require("codecompanion.utils.log")
 

diff --git a/lua/codecompanion/adapters.lua b/lua/codecompanion/adapters.lua
@@ -1,6 +1,4 @@
-local config = require("codecompanion").config
-
-local dep = require("codecompanion.utils.deprecate")
+local config = require("codecompanion.config")
 local log = require("codecompanion.utils.log")
 
 ---Check if a variable starts with "cmd:"
@@ -270,7 +268,6 @@ end
 ---@param adapter? CodeCompanion.Adapter|string|function
 ---@return CodeCompanion.Adapter
 function Adapter.resolve(adapter)
-  config = require("codecompanion").config
   adapter = adapter or config.adapters[config.strategies.chat.adapter]
 
   if type(adapter) == "table" then

diff --git a/lua/codecompanion/adapters/anthropic.lua b/lua/codecompanion/adapters/anthropic.lua
@@ -5,7 +5,7 @@ local utils = require("codecompanion.utils.messages")
 local input_tokens = 0
 local output_tokens = 0
 
----@class CodeCompanion.AdapterArgs
+---@class Anthropic.Adapter: CodeCompanion.Adapter
 return {
   name = "anthropic",
   roles = {

diff --git a/lua/codecompanion/adapters/copilot.lua b/lua/codecompanion/adapters/copilot.lua
@@ -1,5 +1,6 @@
 local curl = require("plenary.curl")
 
+local config = require("codecompanion.config")
 local log = require("codecompanion.utils.log")
 local openai = require("codecompanion.adapters.openai")
 local util = require("codecompanion.utils.util")
@@ -87,6 +88,8 @@ local function authorize_token()
       Authorization = "Bearer " .. _oauth_token,
       ["Accept"] = "application/json",
     },
+    insecure = config.adapters.opts.allow_insecure,
+    proxy = config.adapters.opts.proxy,
     on_error = function(err)
       log:error("Copilot Adapter: Token request error %s", err)
     end,
@@ -96,7 +99,7 @@ local function authorize_token()
   return _github_token
 end
 
----@class CodeCompanion.AdapterArgs
+---@class Copilot.Adapter: CodeCompanion.Adapter
 return {
   name = "copilot",
   roles = {

diff --git a/lua/codecompanion/adapters/gemini.lua b/lua/codecompanion/adapters/gemini.lua
@@ -4,7 +4,7 @@
 local log = require("codecompanion.utils.log")
 local utils = require("codecompanion.utils.messages")
 
----@class CodeCompanion.AdapterArgs
+---@class Gemini.Adapter: CodeCompanion.Adapter
 return {
   name = "gemini",
   roles = {

diff --git a/lua/codecompanion/adapters/ollama.lua b/lua/codecompanion/adapters/ollama.lua
@@ -1,4 +1,4 @@
-local config = require("codecompanion").config
+local config = require("codecompanion.config")
 
 local log = require("codecompanion.utils.log")
 local utils = require("codecompanion.utils.messages")
@@ -56,7 +56,7 @@ local function get_models(self, opts)
   return models
 end
 
----@class CodeCompanion.AdapterArgs
+---@class Gemini.Adapter: CodeCompanion.Adapter
 return {
   name = "ollama",
   roles = {

diff --git a/lua/codecompanion/adapters/openai.lua b/lua/codecompanion/adapters/openai.lua
@@ -1,6 +1,6 @@
 local log = require("codecompanion.utils.log")
 
----@class CodeCompanion.AdapterArgs
+---@class OpenAI.Adapter: CodeCompanion.Adapter
 return {
   name = "openai",
   roles = {

diff --git a/lua/codecompanion/commands.lua b/lua/codecompanion/commands.lua
@@ -2,7 +2,7 @@ local context = require("codecompanion.utils.context")
 local log = require("codecompanion.utils.log")
 
 local codecompanion = require("codecompanion")
-local config = codecompanion.config
+local config = require("codecompanion.config")
 
 local prompt_library = vim
   .iter(config.prompt_library)

diff --git a/lua/codecompanion/config.lua b/lua/codecompanion/config.lua
@@ -1,6 +1,6 @@
 local fmt = string.format
 
-return {
+local defaults = {
   adapters = {
     -- LLMs -------------------------------------------------------------------
     anthropic = "anthropic",
@@ -768,3 +768,22 @@ When given a task:
 4. You can only give one reply for each conversation turn.]],
   },
 }
+
+local M = {
+  config = vim.deepcopy(defaults),
+}
+
+---@param args? table
+M.setup = function(args)
+  args = args or {}
+  M.config = vim.tbl_deep_extend("force", vim.deepcopy(defaults), args)
+end
+
+return setmetatable(M, {
+  __index = function(_, key)
+    if key == "setup" then
+      return M.setup
+    end
+    return rawget(M.config, key)
+  end,
+})
diff --git a/lua/codecompanion/helpers/diff/default.lua b/lua/codecompanion/helpers/diff/default.lua
@@ -1,7 +1,7 @@
 -- Taken from the awesome:
 -- https://github.com/S1M0N38/dante.nvim
 
-local config = require("codecompanion").config
+local config = require("codecompanion.config")
 
 local log = require("codecompanion.utils.log")
 local util = require("codecompanion.utils.util")

diff --git a/lua/codecompanion/helpers/diff/mini_diff.lua b/lua/codecompanion/helpers/diff/mini_diff.lua
@@ -1,8 +1,6 @@
 ---Utilising the awesome:
 ---https://github.com/echasnovski/mini.diff
 
-local config = require("codecompanion").config
-
 local log = require("codecompanion.utils.log")
 local util = require("codecompanion.utils.util")
 

diff --git a/lua/codecompanion/helpers/slash_commands/buffer.lua b/lua/codecompanion/helpers/slash_commands/buffer.lua
@@ -1,4 +1,4 @@
-local config = require("codecompanion").config
+local config = require("codecompanion.config")
 
 local buf = require("codecompanion.utils.buffers")
 local file_utils = require("codecompanion.utils.files")
@@ -13,7 +13,7 @@ CONSTANTS = {
 }
 
 ---Output from the slash command in the chat buffer
----@param SlashCommand CodeCompanion.SlashCommandBuffer
+---@param SlashCommand CodeCompanion.SlashCommand
 ---@param selected table The selected item from the provider { name = string, bufnr = number, path = string }
 ---@return nil
 local function output(SlashCommand, selected)
@@ -34,22 +34,35 @@ local function output(SlashCommand, selected)
   end
 
   local Chat = SlashCommand.Chat
-  Chat:append_to_buf({
-    content = "[!"
-      .. CONSTANTS.NAME
-      .. ": `"
-      .. selected[CONSTANTS.DISPLAY]
-      .. "` / Buf No.: "
-      .. selected.bufnr
-      .. "]\n",
-  })
-  Chat:append_to_buf({ content = content })
-  Chat:fold_code()
+  if config.opts.visible then
+    Chat:append_to_buf({
+      content = "[!"
+        .. CONSTANTS.NAME
+        .. ": `"
+        .. selected[CONSTANTS.DISPLAY]
+        .. "` / Buf No.: "
+        .. selected.bufnr
+        .. "]\n",
+    })
+    Chat:append_to_buf({ content = content })
+    Chat:fold_code()
+  else
+    Chat:add_message({
+      role = "user",
+      content = string.format(
+        [[Here is the data from buffer number %d:
+
+%s]],
+        selected.bufnr,
+        content
+      ),
+    }, { visible = false })
+  end
 end
 
 local Providers = {
   ---The default provider
-  ---@param SlashCommand CodeCompanion.SlashCommandBuffer
+  ---@param SlashCommand CodeCompanion.SlashCommand
   ---@param list table { filetype = string, bufnr = number, name = string, path = string, relative_path = string }
   ---@return nil
   default = function(SlashCommand, list)
@@ -68,7 +81,7 @@ local Providers = {
   end,
 
   ---The Telescope provider
-  ---@param SlashCommand CodeCompanion.SlashCommandBuffer
+  ---@param SlashCommand CodeCompanion.SlashCommand
   ---@return nil
   telescope = function(SlashCommand)
     local ok, telescope = pcall(require, "telescope.builtin")
@@ -125,7 +138,7 @@ local Providers = {
   end,
 
   ---The fzf-lua provider
-  ---@param SlashCommand CodeCompanion.SlashCommandBuffer
+  ---@param SlashCommand CodeCompanion.SlashCommand
   ---@return nil
   fzf_lua = function(SlashCommand)
     local ok, fzf_lua = pcall(require, "fzf-lua")
@@ -151,26 +164,28 @@ local Providers = {
   end,
 }
 
----@class CodeCompanion.SlashCommandBuffer
-local SlashCommandBuffer = {}
+---@class CodeCompanion.SlashCommand.Buffer: CodeCompanion.SlashCommand
+---@field new fun(args: CodeCompanion.SlashCommand): CodeCompanion.SlashCommand.Buffer
+---@field execute fun(self: CodeCompanion.SlashCommand.Buffer)
+local SlashCommand = {}
 
----@class CodeCompanion.SlashCommandBuffer
+---@class Buffer.SlashCommand
 ---@field Chat CodeCompanion.Chat The chat buffer
 ---@field config table The config of the slash command
 ---@field context table The context of the chat buffer from the completion menu
-function SlashCommandBuffer.new(args)
+function SlashCommand.new(args)
   local self = setmetatable({
     Chat = args.Chat,
     config = args.config,
     context = args.context,
-  }, { __index = SlashCommandBuffer })
+  }, { __index = SlashCommand })
 
   return self
 end
 
 ---Execute the slash command
 ---@return nil
-function SlashCommandBuffer:execute()
+function SlashCommand:execute()
   -- Use the `default` provider if no provider is set
   if not self.config.opts or (self.config.opts and self.config.opts.provider == "default") then
     local buffers = {}
@@ -208,4 +223,4 @@ function SlashCommandBuffer:execute()
   end
 end
 
-return SlashCommandBuffer
+return SlashCommand