feat: basic checkhealth for configuration checking

lua/neorg/health.lua

@@ -0,0 +1,40 @@
+return {
+    check = function()
+        local config = require("neorg.core").config.user_config
+        local modules = require("neorg.core").modules.loaded_modules
+
+        vim.health.start("neorg")
+        vim.health.info("Checking configuration...")
+
+        if config.load == nil or vim.tbl_isempty(config.load) then
+            vim.health.ok("Empty configuration provided: Neorg will load `core.defaults` by default.")
+        elseif type(config.load) ~= "table" then
+            vim.health.error("Invalid data type provided. `load` table should be a dictionary of modules!")
+        else
+            vim.health.info("Checking `load` table...")
+
+            for key, value in pairs(config.load) do
+                if type(key) ~= "string" then
+                    vim.health.error(string.format("Invalid data type provided within `load` table! Expected a module name (e.g. `core.defaults`), got a %s instead.", type(key)))
+                elseif not modules[key] then
+                    vim.health.warn(string.format("You are attempting to load a module `%s` which is not recognized by Neorg at this time. You may receive an error upon launching Neorg."))
+                elseif type(value) ~= "table" then
+                    vim.health.error(string.format("Invalid data type provided within `load` table for module `%s`! Expected module data (e.g. `{ config = { ... } }`), got a %s instead.", key, type(key)))
+                elseif value.config and type(value.config) ~= "table" then
+                    vim.health.error(string.format("Invalid data type provided within data table for module `%s`! Expected configuration data (e.g. `config = { ... }`), but `config` was set to a %s instead.", key, type(key)))
+                elseif (#vim.tbl_keys(value) > 1 and value.config ~= nil) then
+                    vim.health.warn(string.format("Unexpected extra data provided to module `%s` - each module only expects a `config` table to be provided, nothing else.", key))
+                elseif (#vim.tbl_keys(value) > 0 and value.config == nil) or #vim.tbl_keys(value) > 1 then
+                    vim.health.warn(string.format("Misplaced configuration data for module `%s` - it seems like you forgot to put your module configuration inside a `config = {}` table?", key))
+                else
+                    vim.health.ok(string.format("Module declaration `%s` is well-formed", key))
+                end
+            end
+
+            -- TODO(vhyrro): Check the correctness of the logger table too
+            if config.logger == nil or vim.tbl_isempty(config.logger) then
+                vim.health.ok("Default configuration for logger provided, Neorg will not output debug info.")
+            end
+        end
+    end
+}