lz.n/lua/lz/n/loader.lua

---@mod lz.n.loader

local M = {}

local DEFAULT_PRIORITY = 50

---@package
---@param plugin lz.n.Plugin
function M._load(plugin)
    if plugin.enabled == false or (type(plugin.enabled) == "function" and not plugin.enabled()) then
        return
    end
    require("lz.n.handler").disable(plugin.name)
    ---@type fun(name: string) | nil
    local load_impl = plugin.load or vim.tbl_get(vim.g, "lz_n", "load")
    if type(load_impl) == "function" then
        load_impl(plugin.name)
    else
        vim.cmd.packadd(plugin.name)
    end
end

---@param plugins table<string, lz.n.Plugin>
local function run_before_all(plugins)
    ---@param plugin lz.n.Plugin
    vim.iter(plugins):each(function(_, plugin)
        if plugin.beforeAll then
            xpcall(
                plugin.beforeAll,
                vim.schedule_wrap(function(err)
                    vim.notify(
                        "Failed to run 'beforeAll' for " .. plugin.name .. ": " .. tostring(err or ""),
                        vim.log.levels.ERROR
                    )
                end),
                plugin
            )
        end
    end)
end

---@param plugin lz.n.Plugin
local function get_priority(plugin)
    return plugin.priority or DEFAULT_PRIORITY
end

---@param plugins table<string, lz.n.Plugin>
---@return lz.n.Plugin[]
local function get_eager_plugins(plugins)
    ---@type lz.n.Plugin[]
    local result = vim
        .iter(plugins)
        ---@param plugin lz.n.Plugin
        :filter(function(_, plugin)
            return plugin.lazy ~= true
        end)
        :fold({}, function(acc, _, v)
            table.insert(acc, v)
            return acc
        end)
    table.sort(result, function(a, b)
        ---@cast a lz.n.Plugin
        ---@cast b lz.n.Plugin
        return get_priority(a) > get_priority(b)
    end)
    return result
end

--- Loads startup plugins, removing loaded plugins from the table
---@param plugins table<string, lz.n.Plugin>
function M.load_startup_plugins(plugins)
    run_before_all(plugins)
    ---@param plugin lz.n.Plugin
    vim.iter(get_eager_plugins(plugins)):each(function(plugin)
        M.load(plugin)
        plugins[plugin.name] = nil
    end)
end

---@alias hook_key "before" | "after"

---@param hook_key hook_key
---@param plugin lz.n.Plugin
local function hook(hook_key, plugin)
    if type(plugin[hook_key]) == "function" then
        xpcall(
            plugin[hook_key],
            vim.schedule_wrap(function(err)
                vim.notify(
                    "Failed to run '" .. hook_key .. "' hook for " .. plugin.name .. ": " .. tostring(err or ""),
                    vim.log.levels.ERROR
                )
            end),
            plugin
        )
    end
end

---@overload fun(plugin: lz.n.Plugin)
---@overload fun(plugins: string | string[], lookup: fun(name: string): lz.n.Plugin?): string[]
function M.load(plugins, lookup)
    local islist = vim.islist(plugins)
    local iterator = islist and ipairs or pairs
    plugins = (type(plugins) == "string" or plugins.name) and { plugins } or plugins
    ---@cast plugins (string|lz.n.Plugin)[] | table<unknown, lz.n.Plugin>
    ---@type string[]
    local skipped = {}
    local plugin_spec_count = 0 -- used to detect deprecated use
    for _, plugin in iterator(plugins) do
        local loadable = true
        -- NOTE: do not make this loop into vim.iter
        -- https://github.com/nvim-neorocks/lz.n/pull/21
        if type(plugin) == "string" then
            ---@diagnostic disable-next-line: cast-local-type
            plugin = lookup and lookup(plugin) or plugin
            if type(plugin) == "string" then
                loadable = false
                table.insert(skipped, plugin)
            end
        else
            plugin_spec_count = plugin_spec_count + 1
        end
        ---@cast plugin lz.n.Plugin
        if loadable then
            hook("before", plugin)
            M._load(plugin)
            hook("after", plugin)
        end
    end
    if plugin_spec_count > 1 then
        if islist then
            vim.deprecate(
                "'trigger_load(plugins: lz.n.PluginSpec[])'",
                "'trigger_load(plugin: lz.n.PluginSpec)'",
                "3.0.0",
                "lz.n"
            )
        else
            vim.deprecate(
                "'trigger_load(plugins: table<T, lz.n.PluginSpec[]>)'",
                "'trigger_load(plugin: lz.n.PluginSpec)'",
                "3.0.0",
                "lz.n"
            )
        end
    end
    return skipped
end

return M