what are the functions i can call in a plugin file and when do the execute?

[divramod]

hey hey,

i am just starting with lazy nvim, coming from packer.

i wanted to ask, which functions like config, init, etc i am allowed to define in the plugin file and when they will be called.
my specific example is, that i want to install avante and then change some colors for the render-markdown highlight groups.

what i was able to find out, is, that when i create a function config, that the plugin will not load automatically.
then i tried the function init, which seems to run, but the settings for the highlight groups i called in this function will be overwritten.

so i suspect, that init runs before loading the actual plugin.

what i need is the function i can call, which runs, after the plugin loaded, so that i can call my color settings for this plugin there.
the reason is, that i like to keep all the configuration for one plugin in one place.
i was able to chage the colors after the plugin loaded in a file, i import later from the init.lua.

is the function call tree somewhere documented?

here is an example, to show what i mean. the init function at the bottom runs before the plugin loaded.

-- https://github.com/yetone/avante.nvim?tab=readme-ov-file#installation
return {
    "yetone/avante.nvim",
    event = "VeryLazy",
    lazy = true,
    version = false, -- set this if you want to always pull the latest change
    build = "make", -- if you want to build from source then do `make BUILD_FROM_SOURCE=true`
    opts = {
        -- https://github.com/yetone/avante.nvim?tab=readme-ov-file#default-setup-configuration
        ---@alias Provider "claude" | "openai" | "azure" | "gemini" | "cohere" | "copilot" | string
        provider = "openai", -- Recommend using Claude
        auto_suggestions_provider = "copilot", -- Since auto-suggestions are a high-frequency operation and therefore expensive, it is recommended to specify an inexpensive provider or even a free provider: copilot
        claude = {
            endpoint = "https://api.anthropic.com",
            model = "claude-3-5-sonnet-20240620",
            temperature = 0,
            max_tokens = 4096
        },
        behaviour = {
            auto_suggestions = false, -- Experimental stage
            auto_set_highlight_group = true,
            auto_set_keymaps = true,
            auto_apply_diff_after_generation = false,
            support_paste_from_clipboard = false
        },
        hints = {enabled = false},
        windows = {
            ---@type "right" | "left" | "top" | "bottom"
            position = "top", -- the position of the sidebar
            wrap = true, -- similar to vim.o.wrap
            width = 30, -- default % based on available width
            sidebar_header = {
                align = "center", -- left, center, right for title
                rounded = true
            }
        },
        highlights = {
            ---@type AvanteConflictHighlights
            diff = {current = "DiffText", incoming = "DiffAdd"}
        },
        --- @class AvanteConflictUserConfig
        diff = {
            autojump = true,
            ---@type string | fun(): any
            list_opener = "copen"
        },
        mappings = {
            -- https://github.com/yetone/avante.nvim/wiki#keymaps-and-api-i-guess
            ask = "<leader>a", -- ask
            edit = "<leader>ue", -- edit
            refresh = "<leader>ur", -- refresh
            --- @class AvanteConflictMappings
            diff = {
                ours = ",co",
                theirs = ",ct",
                all_theirs = ",ca",
                both = ",cb",
                cursor = ",cc",
                next = "]x",
                prev = "[x"
            },
            suggestion = {
                accept = "<M-l>",
                next = "<M-]>",
                prev = "<M-[>",
                dismiss = "<C-]>"
            },
            jump = {next = "]]", prev = "[["},
            submit = {normal = "<C-g><C-g>", insert = "<C-g><C-g>"},
            sidebar = {
                switch_windows = "<Tab>Q",
                reverse_switch_windows = "<S-Tab>Q"
            }
        }
    },
    dependencies = {
        "nvim-treesitter/nvim-treesitter", "stevearc/dressing.nvim",
        "nvim-lua/plenary.nvim", "MunifTanjim/nui.nvim",
        --- The below dependencies are optional,
        "nvim-tree/nvim-web-devicons", -- or echasnovski/mini.icons
        "zbirenbaum/copilot.lua", -- for providers='copilot'
        {
            -- support for image pasting
            "HakonHarnes/img-clip.nvim",
            event = "VeryLazy",
            opts = {
                -- recommended settings
                default = {
                    embed_image_as_base64 = false,
                    prompt_for_file_name = false,
                    drag_and_drop = {insert_mode = true},
                    -- required for Windows users
                    use_absolute_path = true
                }
            }
        }, {
            -- Make sure to set this up properly if you have lazy=true
            'MeanderingProgrammer/render-markdown.nvim',
            ft = {"markdown", "Avante"},
            opts = {
                heading = {
                    -- Turn on / off heading icon & background rendering
                    enabled = false,
                    position = 'inline',
                    backgrounds = {
                        'RenderMarkdownH1Bg', 'RenderMarkdownH2Bg'
                        -- 'RenderMarkdownH3Bg', 'RenderMarkdownH4Bg',
                        -- 'RenderMarkdownH5Bg', 'RenderMarkdownH6Bg'
                    }
                },
                -- https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/Checkboxes
                checkbox = {
                    unchecked = {
                        icon = '󰄱',
                        highlight = 'RenderMarkdownUnchecked'
                    },
                    checked = {
                        icon = '✔',
                        highlight = 'RenderMarkdownChecked'
                    },
                    todo = {
                        raw = '[-]',
                        rendered = '󰥔',
                        highlight = 'RenderMarkdownTodo'
                    }
                },

                -- https://github.com/MeanderingProgrammer/render-markdown.nvim/wiki/CodeBlocks
                code = {
                    enabled = true,
                    above = '',
                    below = '',
                    width = 'block',
                    position = 'left',
                    min_width = 80,
                    left_pad = 2,
                    sign = 'language'
                }
            }
        }
    },
    init = function()
        -- heading lime https://tailwindcss.com/docs/customizing-colors
        vim.api.nvim_set_hl(0, 'RenderMarkdownH1Bg',
                            {fg = '#000000', bg = '#f7fee7'})
        vim.api.nvim_set_hl(0, 'RenderMarkdownH2Bg',
                            {fg = '#000000', bg = '#f7fee7'})
        vim.api.nvim_set_hl(0, 'RenderMarkdownH3Bg',
                            {fg = '#000000', bg = '#f7fee7'})
        vim.api.nvim_set_hl(0, 'RenderMarkdownH4Bg',
                            {fg = '#000000', bg = '#f7fee7'})
        vim.api.nvim_set_hl(0, 'RenderMarkdownH5Bg',
                            {fg = '#000000', bg = '#f7fee7'})
        vim.api.nvim_set_hl(0, 'RenderMarkdownH6Bg',
                            {fg = '#000000', bg = '#f7fee7'})

        -- checkbox 
        vim.api.nvim_set_hl(0, 'RenderMarkdownUnchecked', {fg = '#fb923c'})
        vim.api.nvim_set_hl(0, 'RenderMarkdownChecked', {fg = '#4d7c0f'})
        vim.api.nvim_set_hl(0, 'RenderMarkdownTodo', {fg = '#000000'})

        -- code
        vim.api.nvim_set_hl(0, 'RenderMarkdownCode',
                            {fg = '#000000', bg = '#fefce8'})
        vim.api.nvim_set_hl(0, 'RenderMarkdownCodeInline',
                            {fg = '#000000', bg = '#fefce8'})
    end
}

[iton0]

init will always load on startup. if you type Lazy profile in the command line it will show you a chronological order of your startup. check this out as well