Using plugin_spec.opts vs. manually calling plugin's setup()

[clarkwang]

I wrote a simple comment toggler plugin which defines a keymap with autocmd FileType lua lua vim.keymap.set('n', ...).

Usage 1

plugins = {
  ...

  "foo",
  ...
}
require'lazy'.setup(plugins)

require'foo'.setup{ foo opts here }

Usage 2

plugins = {
  ...

  { "foo", opts = { foo opts here } },
  ...
}
require'lazy'.setup(plugins)

With Usage 1, it works fine for most of time when I :e /some/file.lua from within nvim and the FileType autocmd is effective. But it does not work if I directly specify the file from shell command line, like nvim /some/file.lua. As a workaround I have to reload the file with :e. With nvim /some/file.lua it seems like the FileType autocmd is not triggered so the keymap is not defined.

With Usage 2 it always works. So what's the difference? Any way to make Usage 1 also work?

(Personally I don't like writing a giant plugins table (including plugin's opts) which will later be passed to require'lazy'.setup(). I prefer explicitly calling each plugin's setup() by myself so the plugins table will be much shorter.)

[SirWrexes]

Bit late to the party, maybe you know by now but just in case.

In your require('lazy').setup {} bootstrap phase, you can set an import key in the table you pass to the setup function.
If you chose something like /plugins (the leading slash is important), you can then make a directory named ~/.config/nvim/lua/plugins.
Lazy will then scan this directory and import ALL lua files it finds in there.
There, all you have to do is create one file per plugin (or namespace them with named dirs including an init.vim).
The plugin files should just return a table of specs just like the ones you've already been writing.
Lazy will take care of merging everything.

[SirWrexes]

Ignore the unconfigured lspconfig. 🤭
I've started rewriting my whole config from scratch, migrating from Plug. I gotta say I love this plugin manager.

[SirWrexes]

As you can see, I have a bunch of various plugins, each with their own spec file, stores in my `nvim/lua/plguins' directory.
You can have locals and all the logic you want in there BUT the only thing you can return from those plugin files is the spec table.

[clarkwang]

I've started rewriting my whole config from scratch

This is what I try to avoid. I use both Packer and Lazy (not at the same time of course). I share most of nvim conf between Packer and Lazy and it's very easy to switch between them. So I'm not using Lazy's { import = "plugins" } way to organize my plugins.

[SirWrexes]

Ah well I'm migrating from Plug and never used Packer so I'm not used to it. But are your Packer plugins in your lua/plugins directory ? If so, there is probably a way to make it so packer loads things from lua/plugins/packer and set Lazy's import to lua/plugins/lazy. 🤔

[SirWrexes]

As for your loading issue, you need to remember that the whole thing of this package manager is that it loads plugins lazily. I suspect that could be the cause. I see that in usage 1 you manually require the plugin, which triggers Lazy's loading mechanism. Depending on what you're looking for, that could be good (example: colorschemes).
However, I recommend you get a closer look at the cond, event, ft, keys... table elements. All of them are potential triggers that you can use to summon a plugin into existence in your runtime. Well, except cond which is just a way to disable them altogether, but it's a nice way to ensure a plugin is not loaded if some sort of requirement isn't met, like my spec for hex.vim which prevent activating the plugin altogether if xxd isn't installed on your machine.