[mini.deps] Custom rtp for plugin, eg. sonph/onehalf with vim/ subdirectory

[aswadsun]

Contributing guidelines

• I have read CODE_OF_CONDUCT.md

Module(s)

mini.deps

Question

Hi,

I want to install this color plugin sonph/onehalf mini.deps and end up doing this:

now(function()
  add({ source = 'sonph/onehalf' })
  vim.opt.rtp:append(path_package .. '/pack/deps/opt/onehalf/vim')
end)

If using vundle could be:

Bundle 'sonph/onehalf', {'rtp': 'vim/'}

or using vim-plug could be:

Plug 'sonph/onehalf', { 'rtp': 'vim' }

I believe sonph/onehalf is not the only one plugin which use subdirectory, so I just want to know whether there is better or simpler way of doing this in mini.deps as other plugin managers, so we don't have to look for the plugin directory manually, sort of like:

now(function()
  add({ source = 'sonph/onehalf', rtp = 'vim' })
end)

or using hook:

now(function()
  add({ source = 'sonph/onehalf',
    hooks = {
      post = function(plugin)
        vim.opt.rtp:append(plugin.path .. "/vim")
      end
    }
  })
end)

I have tried using post_install and post_checkout hooks, but it did not work.
Thanks in advance. Also thanks for the great plugins.

[echasnovski]

I think manually adding important directories to runtimepath is a reasonable solution here. It doesn't look that common nowadays to have Neovim plugins contain important stuff in not standardized directories (i.e. adding plugin's directory to runtimepath is usually enough).

It can be simplified a bit by storing local plugin_opt = path_package .. '/pack/deps/opt' and then using vim.opt.rtp:append(plugin_opt .. '/onehalf/vim').

In theory it can be simplified even further by having MiniDeps.add return a table with information about adding. If it contains path then it would be vim.opt.rtp:append(add_details.path .. '/vim'), but that doesn't look much better (especially considering much more code burden on 'mini.deps').

I have tried using post_install and post_checkout hooks, but it did not work.

Well, they would work, but only after plugin has been actually installed or updated. Not during regular addition (which is most of the time), so this is indeed not an intended way to solve this. Manually adding to runtimepath seems to be okay. Synchronous execution of add was designed specifically for the reason of being able to perform actions in code just after the call to add().

All in all, I think manual runtimepath tweaking is enough here. I'd consider making add() (and update(), and clean()) to return table with action info, but I'd like to wait for a more pressuring use case (which is really hard to do without those changes).

Also thanks for the great plugins.

Thanks for using them 🙏