refactor: extract config to separate module

Author: MunifTanjim

lua/copilot/client.lua

@@ -1,12 +1,13 @@
 local api = require("copilot.api")
+local config = require("copilot.config")
 local util = require("copilot.util")
 
-local M = { params = {} }
+local M = {}
 
 local copilot_node_version = nil
 function M.get_node_version()
   if not copilot_node_version then
-    copilot_node_version = string.match(table.concat(vim.fn.systemlist(M.params.copilot_node_command .. " --version", nil, false)), "v(%S+)")
+    copilot_node_version = string.match(table.concat(vim.fn.systemlist(config.get("copilot_node_command") .. " --version", nil, false)), "v(%S+)")
   end
   return copilot_node_version
 end
@@ -19,16 +20,13 @@ end
 
 ---@param force? boolean
 function M.buf_attach(client, force)
-  if not force and not util.should_attach(M.params.filetypes) then
+  if not force and not util.should_attach() then
     return
   end
 
   client = client or util.get_copilot_client()
   if client and not util.is_attached(client) then
     vim.lsp.buf_attach_client(0, client.id)
-
-    ---@todo unknown property, remove this
-    client.completion_function = M.params.extensions
   end
 end
 
@@ -74,19 +72,8 @@ M.merge_server_opts = function(params)
 end
 
 M.start = function(params)
-  M.params = params
-  --- for backward compatibility
-  if M.params.ft_disable then
-    for _, disabled_ft in ipairs(M.params.ft_disable) do
-      M.params.filetypes[disabled_ft] = false
-    end
-  end
-
-  if not M.params.copilot_node_command then
-    M.params.copilot_node_command = "node"
-  end
-
-  vim.lsp.start_client(M.merge_server_opts(params))
+  local client_config = M.merge_server_opts(params)
+  vim.lsp.start_client(client_config)
 end
 
 return M

lua/copilot/command.lua

@@ -75,7 +75,7 @@ function mod.status()
       return
     end
 
-    local should_attach, no_attach_reason = u.should_attach(c.params.filetypes)
+    local should_attach, no_attach_reason = u.should_attach()
     local is_attached = u.is_attached(client)
     if is_attached then
       if not should_attach then
@@ -114,7 +114,7 @@ function mod.toggle(opts)
   end
 
   if not opts.force then
-    local should_attach, no_attach_reason = u.should_attach(c.params.filetypes)
+    local should_attach, no_attach_reason = u.should_attach()
     if not should_attach then
       vim.api.nvim_echo({
         { "[Copilot] " .. no_attach_reason .. "\n" },

lua/copilot/config.lua

@@ -0,0 +1,72 @@
+---@class copilot_config
+local default_config = {
+  ---@class copilot_config_panel
+  panel = {
+    enabled = true,
+    auto_refresh = false,
+    ---@type table<'accept'|'next'|'prev'|'dismiss', false|string>
+    keymap = {
+      jump_prev = "[[",
+      jump_next = "]]",
+      accept = "<CR>",
+      refresh = "gr",
+      open = "<M-CR>",
+    },
+  },
+  ---@class copilot_config_suggestion
+  suggestion = {
+    enabled = true,
+    auto_trigger = false,
+    debounce = 75,
+    ---@type table<'accept'|'next'|'prev'|'dismiss', false|string>
+    keymap = {
+      accept = "<M-l>",
+      next = "<M-]>",
+      prev = "<M-[>",
+      dismiss = "<C-]>",
+    },
+  },
+  ---@deprecated
+  ft_disable = nil,
+  ---@type table<string, boolean>
+  filetypes = {},
+  copilot_node_command = "node",
+  server_opts_overrides = {},
+}
+
+local mod = {
+  config = nil,
+}
+
+function mod.setup(opts)
+  if mod.config then
+    vim.notify("[copilot] config is already set", vim.log.levels.WARN)
+    return
+  end
+
+  local config = vim.tbl_deep_extend("force", default_config, opts or {})
+
+  --- for backward compatibility
+  if config.ft_disable then
+    for _, disabled_ft in ipairs(config.ft_disable) do
+      config.filetypes[disabled_ft] = false
+    end
+
+    config.ft_disable = nil
+  end
+
+  mod.config = config
+
+  return mod.config
+end
+
+---@param key? string
+function mod.get(key)
+  if mod.config and key then
+    return mod.config[key]
+  end
+
+  return mod.config
+end
+
+return mod

lua/copilot/init.lua

@@ -1,36 +1,9 @@
 local M = { client_info = nil }
+local config = require("copilot.config")
 local client = require("copilot.client")
 local highlight = require("copilot.highlight")
 local panel = require("copilot.panel")
 local suggestion = require("copilot.suggestion")
-local defaults = {
-  panel = {
-    enabled = true,
-    auto_refresh = false,
-    keymap = {
-      jump_prev = "[[",
-      jump_next = "]]",
-      accept = "<CR>",
-      refresh = "gr",
-      open = "<M-CR>"
-    }
-  },
-  suggestion = {
-    enabled = true,
-    auto_trigger = false,
-    debounce = 75,
-    keymap = {
-      accept = "<M-l>",
-      next = "<M-]>",
-      prev = "<M-[>",
-      dismiss = "<C-]>",
-    }
-  },
-  ft_disable = nil,
-  filetypes = {},
-  copilot_node_command = "node",
-  server_opts_overrides = {},
-}
 
 local create_cmds = function (_)
   vim.api.nvim_create_user_command("CopilotDetach", function()
@@ -57,23 +30,19 @@ local create_cmds = function (_)
   end, {})
 end
 
-local config_handler = function(opts)
-  local user_config = opts and vim.tbl_deep_extend("force", defaults, opts) or defaults
-  return user_config
-end
-
 M.setup = function(opts)
-  local user_config = config_handler(opts)
+  local conf = config.setup(opts)
+
   vim.schedule(function ()
-    client.start(user_config)
+    client.start(conf)
 
-    if user_config.panel.enabled then
-      panel.setup(user_config.panel)
-      create_cmds(user_config)
+    if conf.panel.enabled then
+      panel.setup(conf.panel)
+      create_cmds(conf)
     end
 
-    if user_config.suggestion.enabled then
-      suggestion.setup(user_config.suggestion)
+    if conf.suggestion.enabled then
+      suggestion.setup(conf.suggestion)
     end
   end)
 

lua/copilot/util.lua

@@ -1,3 +1,5 @@
+local config = require("copilot.config")
+
 local M = {}
 
 local id = 0
@@ -95,11 +97,10 @@ local function is_ft_disabled(ft, filetypes)
   return false
 end
 
----@param filetypes table<string, boolean>
 ---@return boolean should_attach
 ---@return string? no_attach_reason
-function M.should_attach(filetypes)
-  local ft_disabled, ft_disabled_reason = is_ft_disabled(vim.bo.filetype, filetypes)
+function M.should_attach()
+  local ft_disabled, ft_disabled_reason = is_ft_disabled(vim.bo.filetype, config.get("filetypes"))
 
   if ft_disabled then
     return not ft_disabled, ft_disabled_reason
@@ -207,14 +208,14 @@ M.get_completion_params = function(opts)
   return M.get_doc_params(opts)
 end
 
-
 ---@return copilot_editor_configuration
 function M.get_editor_configuration()
-  local c = require("copilot.client")
+  local conf = config.get()
+
+  local filetypes = vim.deepcopy(conf.filetypes)
 
-  local filetypes = vim.deepcopy(c.params.filetypes)
-  if filetypes['*'] == nil then
-    filetypes = vim.tbl_deep_extend('keep', filetypes, internal_filetypes)
+  if filetypes["*"] == nil then
+    filetypes = vim.tbl_deep_extend("keep", filetypes, internal_filetypes)
   end
 
   ---@type string[]
@@ -224,7 +225,7 @@ function M.get_editor_configuration()
   table.sort(disabled_filetypes)
 
   return {
-    enableAutoCompletions = not not (c.params.panel.enabled or c.params.suggestion.enabled),
+    enableAutoCompletions = not not (conf.panel.enabled or conf.suggestion.enabled),
     disabledLanguages = disabled_filetypes,
   }
 end
@@ -234,7 +235,7 @@ M.get_copilot_path = function()
   if vim.fn.filereadable(copilot_path) ~= 0 then
     return copilot_path
   else
-    print("[Copilot] could not read" .. copilot_path)  
+    print("[Copilot] could not read" .. copilot_path)
   end
 end