Properly caching your config files

[musjj]

Say you have a file containing a setup for some basic options:

-- ~/.config/nvim/lua/config.lua
vim.opt.number = false
vim.g.mapleader = " "

When exactly should you load this file so that lazy.nvim caches it?

This is roughly what I'm doing right now:

-- ~/.config/nvim/init.lua
...
require("config")
require("lazy.nvim").setup("plugins")

So I'm guessing that it's probably not getting cached.
Considering that some options have to be loaded early before lazy sets itself up, what would be the ideal loading order?

[clason]

Put it in an init key. (Or make sure that lazy is required in your init.lua before this file is sourced.)

[musjj]

Right, I guess I can just tack it to a random plugin's init key, but that feels a bit hacky. Looking through the code again, it seems that I can just manually activate the caching with require("lazy.core.cache").enable(), so I guess that's good enough.
Maybe a LazyStart autocmd that happens around here:

lazy.nvim/lua/lazy/init.lua

Line 47 in 7339145

require("lazy.stats").track("LazyStart")

would be more user-friendly though.

[folke]

Caching is enabled in require("lazy").setup, so if you want things to be cached before that, you could indeed enable to cache earlier.

[folke]

But that would only make a very tiny neglible difference

[musjj]

But that would only make a very tiny neglible difference

I guess it depends on how your large/complex your non-plugin config is. I see that LazyVim inserts itself into the plugin list with config = true which makes lazyvim.config (and by extension the user's) properly cached. It would be nice to see a "blessed" workflow that achieves something similar for non-LazyVim configs, but this is good enough for me.