opts vs config

[Susensio]

What's the execution order of opts and setup? I know there is some overlap between the two fields. Is there a prefered one when require is used?

Example:

return {
    "tanvirtin/monokai.nvim",
    lazy = false,
    priority = 1000,
    config = function(_, _)
      monokai = require("monokai")
      palette = monokai.pro
      opts = {
        palette = monokai.pro
      }
      monokai.setup(opts)
    end
}

vs

return {
    "tanvirtin/monokai.nvim",
    lazy = false,
    priority = 1000,
    opts = function(_, _)
      monokai = require("monokai")
      palette = monokai.pro
      opts = {
        palette = monokai.pro
      }
      return opts
    end
}

[kls1991]

I think if config exists, opts will be pass to config's first parameter

[abeldekat]

The best answer can be found in the docs: plugin spec

[Susensio]

The docs do not say when opts is evaluated.

[abeldekat]

They do:

opts should be a table (will be merged with parent specs), return a table (replaces parent specs) or should change a table. The table will be passed to the Plugin.config() function. Setting this value will imply Plugin.config()

So, opts will be invoked before config. The resulting opts(after merging all individual specs of a plugin) are passed into the config function. If you don't specify a config function, lazy.nvim uses its default, requiring the plugin and calling setup() with the supplied opts.

[Susensio]

Then, what's the prefered method of the two posted?

[abeldekat]

For your personal config, when there is only one spec for monokai-pro, they both are equivalent.
When there are multiple specs for the plugin, one overriding the other, I think that option two is preferred.
An example , the overriding spec:

return {
    "tanvirtin/monokai.nvim",
    opts = function(_, opts)
      local monokai = require("monokai")
      opts.palette = monokai.pro.someotherflavour
    end
}

Another argument in favor of option two: You don't have to provide monokai.setup(opts)

See also: importing specs ....

opts, dependencies, cmd, event, ft and keys are always merged with the parent spec. Any other property will override the property from the parent spec.

It's a crucial part of lazy.nvim, allowing for modularization and a setup like LazyVim

[xfzv]

Also wondering what's the difference between

config = true

and

opts = {}

[abeldekat]

True.
However, from the docs, plugin spec, property config:

...To use the default implementation without opts set config to true.

config = true is the preferred notation.

[xfzv]

config = true is the preferred notation.

Quoting folke in #831 (comment):

opts={} is the preferred way.

[abeldekat]

@xfzv, you're right.
Strange that the docs are not in accordance with that statement:

... Later I added opts. opts={} is the preferred way. For most plugins you can always use opts, only in very complex use-cases you would need to add a config() function.

[xfzv]

To my understanding,

To use the default implementation without opts set config to true.

doesn't necessarily imply that

config = true

is preferred over

opts = {}

It just means that it can be used as an alternative. Maybe I'm wrong though, once again it's just how I understand it.

[abeldekat]

I think you are right. Thanks!