feat: add validation of configuration

Author: AntoineGS

lua/copilot/config/init.lua

@@ -8,7 +8,7 @@ local logger = require("copilot.logger")
 ---@field filetypes table<string, boolean> Filetypes to enable Copilot for
 ---@field auth_provider_url string|nil URL for the authentication provider
 ---@field workspace_folders string[] Workspace folders to enable Copilot for
----@field server_opts_overrides table<string, any> Options to override for the server
+---@field server_opts_overrides? table<string, any> Options to override for the server
 ---@field copilot_model string|nil Model to use for Copilot, LSP server dictates the default
 ---@field root_dir RootDirFuncOrString Root directory for the project, defaults to the nearest .git directory
 ---@field should_attach ShouldAttachFunc Function to determine if Copilot should attach to the buffer
@@ -32,6 +32,7 @@ local M = {
   copilot_node_command = "node",
 }
 
+---@param user_configs CopilotConfig
 function M.merge_with_user_configs(user_configs)
   logger.trace("setting up configuration, opts", user_configs)
 
@@ -45,11 +46,32 @@ function M.merge_with_user_configs(user_configs)
     M[k] = v
   end
 
-  if M.server.custom_server_filepath then
-    M.server.custom_server_filepath = vim.fs.normalize(M.server.custom_server_filepath)
-  end
+  M.validate(M)
 
   initialized = true
 end
 
+---@param config CopilotConfig
+function M.validate(config)
+  vim.validate("panel", config.panel, "table")
+  vim.validate("suggestion", config.suggestion, "table")
+  vim.validate("logger", config.logger, "table")
+  vim.validate("server", config.server, "table")
+  vim.validate("filetypes", config.filetypes, "table")
+  vim.validate("auth_provider_url", config.auth_provider_url, { "string", "nil" })
+  vim.validate("workspace_folders", config.workspace_folders, "table")
+  vim.validate("server_opts_overrides", config.server_opts_overrides, "table", true)
+  vim.validate("copilot_model", config.copilot_model, { "string", "nil" })
+  vim.validate("root_dir", config.root_dir, { "string", "function" })
+  vim.validate("should_attach", config.should_attach, "function")
+  vim.validate("copilot_node_command", config.copilot_node_command, "string")
+
+  require("copilot.config.panel").validate(config.panel)
+  require("copilot.config.suggestion").validate(config.suggestion)
+  require("copilot.config.logger").validate(config.logger)
+  require("copilot.config.server").validate(config.server)
+  require("copilot.config.root_dir").validate(config.root_dir)
+  require("copilot.config.should_attach").validate(config.should_attach)
+end
+
 return M

lua/copilot/config/logger.lua

@@ -1,4 +1,4 @@
----@class LoggerConfig
+---@class (exact) LoggerConfig
 ---@field file string Path to the log file
 ---@field file_log_level integer Log level for the log file, matches vim.log.levels
 ---@field print_log_level integer Log level for printing to the console, matches vim.log.levels
@@ -18,4 +18,30 @@ local logger = {
   },
 }
 
+local function validate_log_level(level)
+  return type(level) == "number"
+    and (
+      level == vim.log.levels.OFF
+      or level == vim.log.levels.ERROR
+      or level == vim.log.levels.WARN
+      or level == vim.log.levels.INFO
+      or level == vim.log.levels.DEBUG
+      or level == vim.log.levels.TRACE
+    )
+end
+
+---@param config LoggerConfig
+function logger.validate(config)
+  vim.validate("file", config.file, "string")
+  config.file = vim.fs.normalize(config.file)
+
+  vim.validate("file_log_level", config.file_log_level, validate_log_level, false, "any of the vim.log.levels")
+  vim.validate("print_log_level", config.print_log_level, validate_log_level, false, "any of the vim.log.levels")
+  vim.validate("trace_lsp", config.trace_lsp, function(level)
+    return level == "off" or level == "verbose" or level == "debug"
+  end, false, "off, verbose or debug")
+  vim.validate("trace_lsp_progress", config.trace_lsp_progress, "boolean")
+  vim.validate("log_lsp_messages", config.log_lsp_messages, "boolean")
+end
+
 return logger

lua/copilot/config/panel.lua

@@ -1,17 +1,17 @@
----@class PanelConfig
+---@class (exact) PanelConfig
 ---@field enabled boolean Whether to enable the panel
 ---@field auto_refresh boolean Whether to automatically refresh the panel
 ---@field keymap PanelKeymapConfig Keymap for the panel
----@field layout config_panel_layout Layout of the panel
+---@field layout PanelLayoutConfig Layout of the panel
 
----@class PanelKeymapConfig
+---@class (exact) PanelKeymapConfig
 ---@field jump_prev string|false Keymap for jumping to the previous suggestion
 ---@field jump_next string|false Keymap for jumping to the next suggestion
 ---@field accept string|false Keymap for accepting the suggestion
 ---@field refresh string|false Keymap for refreshing the suggestion
 ---@field open string|false Keymap for opening the suggestion
 
----@class config_panel_layout
+---@class (exact) PanelLayoutConfig
 ---@field position string<'left'|'right'|'top'|'bottom'> Position of the panel
 ---@field ratio number Ratio of the panel size, between 0 and 1
 
@@ -34,4 +34,23 @@ local panel = {
   },
 }
 
+---@param config PanelConfig
+function panel.validate(config)
+  vim.validate("enabled", config.enabled, "boolean")
+  vim.validate("auto_refresh", config.auto_refresh, "boolean")
+  vim.validate("keymap", config.keymap, "table")
+  vim.validate("layout", config.layout, "table")
+  vim.validate("keymap.jump_prev", config.keymap.jump_prev, { "string", "boolean" })
+  vim.validate("keymap.jump_next", config.keymap.jump_next, { "string", "boolean" })
+  vim.validate("keymap.accept", config.keymap.accept, { "string", "boolean" })
+  vim.validate("keymap.refresh", config.keymap.refresh, { "string", "boolean" })
+  vim.validate("keymap.open", config.keymap.open, { "string", "boolean" })
+  vim.validate("layout.position", config.layout.position, function(value)
+    return value == "left" or value == "right" or value == "top" or value == "bottom"
+  end, false, "left, right, top or bottom")
+  vim.validate("layout.ratio", config.layout.ratio, function(value)
+    return type(value) == "number" and value >= 0 and value <= 1
+  end, false, "number between 0 and 1")
+end
+
 return panel

lua/copilot/config/root_dir.lua

@@ -7,4 +7,9 @@ local root_dir = {
   end,
 }
 
+---@param config RootDirFuncOrString
+function root_dir.validate(config)
+  vim.validate("root_dir", config, { "string", "function" })
+end
+
 return root_dir

lua/copilot/config/server.lua

@@ -1,6 +1,6 @@
----@class ServerConfig
+---@class (exact) ServerConfig
 ---@field type string<'nodejs', 'binary'> Type of the server
----@field custom_server_filepath string|nil Path to the custom server file
+---@field custom_server_filepath? string|nil Path to the custom server file
 
 local server = {
   ---@type ServerConfig
@@ -10,4 +10,16 @@ local server = {
   },
 }
 
+---@param config ServerConfig
+function server.validate(config)
+  vim.validate("type", config.type, function(server_type)
+    return type(server_type) == "string" and (server_type == "nodejs" or server_type == "binary")
+  end, false, "nodejs or binary")
+  vim.validate("custom_server_filepath", config.custom_server_filepath, { "string", "nil" })
+
+  if config.custom_server_filepath then
+    config.custom_server_filepath = vim.fs.normalize(config.custom_server_filepath)
+  end
+end
+
 return server

lua/copilot/config/should_attach.lua

@@ -19,4 +19,9 @@ local should_attach = {
   end,
 }
 
+---@param config ShouldAttachFunc
+function should_attach.validate(config)
+  vim.validate("should_attach", config, "function")
+end
+
 return should_attach

lua/copilot/config/suggestion.lua

@@ -1,11 +1,11 @@
----@class SuggestionConfig
+---@class (exact) SuggestionConfig
 ---@field enabled boolean Whether to enable the suggestion
 ---@field auto_trigger boolean Whether to trigger the suggestion automatically
 ---@field hide_during_completion boolean Whether to hide the suggestion during completion
 ---@field debounce integer Debounce time in milliseconds
 ---@field keymap SuggestionKeymapConfig Keymap for the suggestion
 
----@class SuggestionKeymapConfig
+---@class (exact) SuggestionKeymapConfig
 ---@field accept string|false Keymap for accepting the suggestion
 ---@field accept_word string|false Keymap for accepting the word
 ---@field accept_line string|false Keymap for accepting the line
@@ -31,4 +31,18 @@ local suggestion = {
   },
 }
 
+function suggestion.validate(config)
+  vim.validate("enabled", config.enabled, "boolean")
+  vim.validate("auto_trigger", config.auto_trigger, "boolean")
+  vim.validate("hide_during_completion", config.hide_during_completion, "boolean")
+  vim.validate("debounce", config.debounce, { "number", "nil" })
+  vim.validate("keymap", config.keymap, "table")
+  vim.validate("keymap.accept", config.keymap.accept, { "string", "boolean" })
+  vim.validate("keymap.accept_word", config.keymap.accept_word, { "string", "boolean" })
+  vim.validate("keymap.accept_line", config.keymap.accept_line, { "string", "boolean" })
+  vim.validate("keymap.next", config.keymap.next, { "string", "boolean" })
+  vim.validate("keymap.prev", config.keymap.prev, { "string", "boolean" })
+  vim.validate("keymap.dismiss", config.keymap.dismiss, { "string", "boolean" })
+end
+
 return suggestion

lua/copilot/workspace/utils.lua

@@ -15,7 +15,6 @@ function M.add_workspace_folder(folder_path)
     return false
   end
 
-  -- Normalize path
   folder_path = vim.fn.fnamemodify(folder_path, ":p")
 
   --- @type workspace_folder