Order of plugin loading

[lervag]

Given the following plugin spec:

  {
    "some/plugin",
    config = function()
      vim.cmd("echom 'config'")
    end,
  },

where some/plugin has the following plugin/startup.lua:

vim.cmd("echom 'load'")

I would expect the print order to be:

config
load

But instead I'm seeing

load
config

Is this a bug, or is there a good reason for this behaviour? The only good reference I found for this is in the README.md. I also found a slightly related issue: #888.

Perhaps a good suggestion would be to indicate in the startup sequence section at which point one should expect the config function to run?

PS! I know I can use init = function() ... end, but that function runs even if the plugin is not loaded.

[atusy]

init receives an argument of LazyPlugin type. You can use LazyPlugin.cond field to decide whether or not to skip init.

init = function(p)
  if p.cond == false then
    return
  end
end

[lervag]

Thanks, that's useful to know. I don't think it answers my main question, though.

[atusy]

I don't think it answers my main question

That's right.
I think the current behavior is intentional.

According to document, config is the place to call require(MAIN).setup(opts).
This implies package is loaded before calling config.
Otherwise, require(MAIN) fails.

config is executed when the plugin loads. The        
default implementation will automatically run        
require(MAIN).setup(opts). Lazy uses several         
heuristics to determine the plugin’s MAIN module     
automatically based on the plugin’s name. See also   
opts. To use the default implementation without opts 
set config to true.                                  

[lervag]

Ok, first: I've inspected the source. Here's what is currently happening:

lazy.nvim/lua/lazy/core/loader.lua

Lines 346 to 349 in 31ddbea

	M.packadd(plugin.dir)
	if plugin.config or plugin.opts then
	M.config(plugin)
	end

The M.packadd() runs just before .config. .packadd does this:

lazy.nvim/lua/lazy/core/loader.lua

Line 411 in 31ddbea

M.source_runtime(path, "plugin")

If I understand correctly, these lines explain the behaviour I'm asking about.

According to document, config is the place to call require(MAIN).setup(opts).
This implies package is loaded before calling config.
Otherwise, require(MAIN) fails.

I'm not 100% convinced. That is, why is it necessary to actually source plugin/* before doing require().setup()? I'm not saying you're wrong, I am just curious and want to properly understand it.