when is it appropriate to use the init property for a plugin?

[freddiehaddad]

In the README for the plugin, it shows one of the options is init which can be a function. I'm not sure I understand when to use init as opposed to using configor when you would want to use both.

Does init get called before or after config?

[abeldekat]

Hello @freddiehaddad,

The init function of each plugin is executed during startup, before lazy.nvim starts loading any plugins.
See Startup Sequence and Plugin Spec.
I find it difficult to exactly specify when it is appropriate to use this function. Perhaps: Any code that does not fit in opts(the options for the plugin) or config( calling the setup function of the plugin when the plugin is actually loaded, using the supplied opts).

Example usage in LazyVim:

• neo-tree When neovim is invoked with a directory as argument, open neo-tree.
• vim.g Apply global vim.g settings related to the plugin.
• autocommand: Disable mini.indentscope for filetypes like help

For a better understanding you could look at the Profile section of the ui(:Lazy profile).

Best regards!