Examples of using a function with event loading.

[madelaney]

I was looking over the ways to load a plugin, and I noticed that we can use a function as the event handler. The docs say the signature is: fun(self:LazyPlugin, event:string[]):string[]. When I tried to setup a function, the second parameter always seems to be an empty table. This makes me think that I'm doing something wrong.

Here is an example of how I've tried it before (with a different plugin; markdown.nvim is just a stand-in)

{
  'tadmccorkle/markdown.nvim',
  event = function(_plugin, event)
    -- special logic here.
  end,
  opts = {
    -- configuration here or empty for defaults
  },
}

Are there any examples of how to use the function as the event handler?

[folke]

That second event parameter are event specs that were defined earlier in another spec for the same plugin. This is mostly relevant for distros like LazyVim, where users may want to override options etc for plugins.

For your use case it would indeed always be empty

[madelaney]

Thanks.

What would be your suggestion if I wanted to load a plugin based on the file being opened in a specific directory?

Would it be to use something like:

{
  'tadmccorkle/markdown.nvim',
  event = {
    "BufReadPre path/to/super/secret/docs/*.md",
    "BufNewFile path/to/super/secret/docs/*.md",
  end,
  opts = {
    -- configuration here or empty for defaults
  },
}

[madelaney]

For now, this is the solution that I came up with:

{
  'tadmccorkle/markdown.nvim',
  event = function()
      local secret_dir = '.shhhhhhhhhhh'
      local in_args = false

      local idx = 0
      while idx < vim.fn.argc() do
        ---@diagnostic disable-next-line: param-type-mismatch
        local arg = vim.fn.escape(vim.fn.fnameescape(vim.fn.argv(idx)), '.')
        if string.match(arg, secret_dir) then
          in_args = true
          break
        end
        idx = idx + 1
      end

      local dir = vim.fn.getcwd()
      if not string.find(dir, secret_dir) and not in_args then
        return {}
      end

      return {
        'BufReadPre *.md',
        'BufNewFile *.md',
      }
  end,
  opts = {
    -- configuration here or empty for defaults
  },
}