feat: basic config validation

Author: igorlfs

.stylua.toml

@@ -1,4 +1,4 @@
-column_width = 100
+column_width = 110
 line_endings = "Unix"
 indent_type = "Spaces"
 indent_width = 4

README.md

@@ -245,6 +245,7 @@ request](https://github.com/igorlfs/nvim-dap-view/issues/new?assignees=&labels=e
 for the inspiration for handling breakpoint exceptions;
 - [Kulala](https://github.com/mistweaverco/kulala.nvim) for the creative usage
 of neovim's `'winbar'` to handle multiple views.
+- [blink.cmp](https://github.com/Saghen/blink.cmp/blob/main/lua/blink/cmp/config/utils.lua) for the config validation (which is partialy taken from a PR to [indent-blankline](https://github.com/lukas-reineke/indent-blankline.nvim/pull/934/files#diff-09ebcaa8c75cd1e92d25640e377ab261cfecaf8351c9689173fd36c2d0c23d94R16))
 
 [^1]: Filters depend on the debug adapter's capabilities
 [^2]: From treesitter and extmarks (e.g., semantic highlighting from LSP)

lua/dap-view/setup.lua

@@ -0,0 +1,12 @@
+local M = {}
+
+M.config = require("dap-view.config").config
+
+---@param config Config?
+M.setup = function(config)
+    M.config = vim.tbl_deep_extend("force", M.config, config or {})
+
+    require("dap-view.setup.validate").validate(M.config)
+end
+
+return M

lua/dap-view/setup/init.lua

@@ -0,0 +1,14 @@
+local M = {}
+
+---@param config Config
+function M.validate(config)
+    require("dap-view.setup.validate.util").validate("config", {
+        windows = { config.windows, "table" },
+        winbar = { config.winbar, "table" },
+    }, config)
+
+    require("dap-view.setup.validate.winbar").validate(config.winbar)
+    require("dap-view.setup.validate.windows").validate(config.windows)
+end
+
+return M

lua/dap-view/setup/validate/init.lua

@@ -0,0 +1,37 @@
+local M = {}
+
+-- Code taken from @MariaSolOs in a indent-blankline.nvim PR:
+-- https://github.com/lukas-reineke/indent-blankline.nvim/pull/934/files#diff-09ebcaa8c75cd1e92d25640e377ab261cfecaf8351c9689173fd36c2d0c23d94R16
+
+--- @param spec table<string, {[1]:any, [2]:function|string, [3]:string|true|nil}>
+--- NOTE: We disable some Lua diagnostics here since lua_ls isn't smart enough to
+--- realize that we're using an overloaded function.
+local _validate = function(spec)
+    for key, key_spec in pairs(spec) do
+        local message = type(key_spec[3]) == "string" and key_spec[3] or nil --[[@as string?]]
+        local optional = type(key_spec[3]) == "boolean" and key_spec[3] or nil --[[@as boolean?]]
+        ---@diagnostic disable-next-line:param-type-mismatch, redundant-parameter
+        vim.validate(key, key_spec[1], key_spec[2], optional, message)
+    end
+end
+
+--- @param path string The path to the field being validated
+--- @param tbl table The table to validate
+--- @param source table The original table that we're validating against
+--- @see vim.validate
+function M.validate(path, tbl, source)
+    -- Validate
+    local _, err = pcall(_validate, tbl)
+    if err then
+        error(path .. "." .. err)
+    end
+
+    -- Check for erroneous fields
+    for k, _ in pairs(source) do
+        if tbl[k] == nil then
+            error(path .. "." .. k .. ": unexpected field found in configuration")
+        end
+    end
+end
+
+return M

lua/dap-view/setup/validate/util.lua

@@ -0,0 +1,24 @@
+local M = {}
+
+---@param config WinbarConfig
+function M.validate(config)
+    require("dap-view.setup.validate.util").validate("winbar", {
+        show = { config.show, "boolean" },
+        sections = { config.sections, "table" },
+        default_section = { config.default_section, "string" },
+    }, config)
+
+    local sections = config.sections
+    local default = config.default_section
+
+    -- Also check the "semantics"
+    if #sections == 0 then
+        error("There must be at least one section")
+    end
+    if not vim.tbl_contains(sections, default) then
+        local pretty_sections = vim.inspect(sections)
+        error("Default section (" .. default .. ") not listed as one of the sections " .. pretty_sections)
+    end
+end
+
+return M

lua/dap-view/setup/validate/winbar.lua

@@ -0,0 +1,10 @@
+local M = {}
+
+---@param config WindowsConfig
+function M.validate(config)
+    require("dap-view.setup.validate.util").validate("windows", {
+        height = { config.height, "number" },
+    }, config)
+end
+
+return M