I made a plugin, is my lazy config wrong or the plugin itself?

[JulianNymark]

So I made this plugin: https://github.com/JulianNymark/telescope_grouped_keymaps.nvim,

and the way I (try to) load it is like this:

        -- Lazy
	{
		"JulianNymark/telescope_grouped_keymaps.nvim",
		dependencies = {
			"nvim-telescope/telescope.nvim",
			"folke/which-key.nvim",
		},
		opts = {},
		config = function()
			local module = require("telescope_grouped_keymaps")
			module.setup()

			vim.keymap.set("n", "<leader>sK", function()
				module.picker_grouped_keymaps({})
			end, { desc = "grouped keymaps" })

			print("loaded telescope_grouped_keymaps")
		end,
	},

However it seems like it doesn't actually run after the two plugins in the dependencies list have "finished" loading (I'm not sure what the right terminology is here). But however if i run the setup manually at a later time, the plugin seems to work fine, so I'm thinking that the plugin itself is fine, and that this is a config issue?

when I run:

:lua require("telescope_grouped_keymaps").setup()

Everything works as inteded 😅 .

After some research I tried to debug this loading issue with Lazy profile as well, but it "looks fine" to me 🤔 (granted I don't quite know what i'm looking at as a complete newbie, I'm guessing they load from top to bottom, and that if something is nested, it comes "after" the nested deps have run their respective .setup()s? (this is merely speculation from my side though).

I would have liked to see my plugin at a line under telescope, similarly to how in the screenshot below telescope-file-browser comes under it in the list, it also the identical plugin "nvim-telescope/telescope.nvim" in its dependencies list.

[iton0]

remove opts = {}, see if that works

[JulianNymark]

No, sadly that's not it.

It seems that having opts = {} is the same as having no opts defined. I think the default is then probably the empty table {}. and the default for config is to run require(<package_name>).setup(<opts>).

The config() function is definitely being run, but it seems to be run too early. There must be some ordering issue here beyond dependencies. 🤔

[iton0]

Settings opts = {} implies the config(), so you're technically calling config twice in the code you provided. Check out the docs https://lazy.folke.io/spec#spec-setup.

[JulianNymark]

I don't think that's entirely right (I think it's right that config is called implicitly by setting opts, but it seems to be that opts is passed to config if you set both, so I don't think you could get setup to be called twice by defining both. Here's a few tests I did (just to verify, since I'm also figuring this stuff out 😅 ):

First I changed my plugin so that its setup function prints the options that are passed in to it.

function M.setup(opts)
	print("inside plugin setup")
	vim.print(opts)
        ... more plugin code...

---

test 1

When my config looks like this:

	{
		"JulianNymark/telescope_grouped_keymaps.nvim",
		dev = true,
		dependencies = {
			"nvim-telescope/telescope.nvim",
			"folke/which-key.nvim",
		},
	},

It prints nothing telling me my plugin wasn't loaded / run at all 🤔 (this seems to imply you need at least one of either opts or config)

test 2

when my config looks like this:

	{
		"JulianNymark/telescope_grouped_keymaps.nvim",
		dev = true,
		dependencies = {
			"nvim-telescope/telescope.nvim",
			"folke/which-key.nvim",
		},
		opts = {},
	},

it prints:

inside plugin setup
{}

So this tells me that the modules setup is called (and it was called with the opts defined).

test 3

when my config looks like this:

	{
		"JulianNymark/telescope_grouped_keymaps.nvim",
		dev = true,
		dependencies = {
			"nvim-telescope/telescope.nvim",
			"folke/which-key.nvim",
		},
		config = function(_, opts)
			print("inside config")
                         vim.print(opts)j
		end,
	},

it prints:

inside config
{}

This tells me that the modules setup was not called. So when using config you're now responsible for calling setup yourself, adding extra boilerplate and potential for error (which is most likely why it's strongly recommended to use opts whenever possible).

test 4

Finally, when my config looks like this:

	{
		"JulianNymark/telescope_grouped_keymaps.nvim",
		dev = true,
		dependencies = {
			"nvim-telescope/telescope.nvim",
			"folke/which-key.nvim",
		},
		opts = {
			foo = "bar",
		},
		config = function(_, opts)
			print("inside config")
			vim.print(opts)
			require("telescope_grouped_keymaps").setup(opts)
		end,
	},

it prints:

inside config
{
  foo = "bar"
}
inside plugin setup
{
  foo = "bar"
}

[JulianNymark]

I think i've learned a bit more how this works, but I'm still stumped about the ordering of plugins (plugin lifecycle stuff?). I know there's some special configs you can set that impact when it's loaded / run. Such as event = "VimEnter" I've set for both telescope.nvim and which-key 😵 , I can't help but think this is relevant 🤔. Maybe this means it doesn't trigger respect other configs dependencies the same way anymore? Maybe it needs to be set for my plugin as well, maybe there's an implied rule where "if you depend on something that has event set, you too need to have the same event set"?.

[folke]

I'm not sure how you're hooking into which-key, but which-key is internally also lazy loaded.
So after calling which-key setup, your actual keymaps might not have been processed yet.

[JulianNymark]

how you're hooking into which-key

Currently, the only way I integrate with which-key is to require which-key.config like shown below in the modules setup(), and from there i look into the mappings that are set. So if I understand correctly then which-key will maybe not be "ready" (loaded its keymaps) by the time its setup() has run? (and when I specify dependencies it only guarantees the ordering of the setup()s execution)? My follow up question is then if there is a simple way to hook onto an event when which-key has loaded? (maybe a callback or other where I can call my own modules setup() from)

local wk_conf = require("which-key.config")