Packer migration questions: Individual plugin setup files, all need re-writing to use a local 'M'?

[benfrain]

Attempting to migrate a Packer based config. Have a few questions:

Q1. Where, with Packer, I had individual files like this (plugins/gitsigns.lua):

require("gitsigns").setup({
  numhl = true,
  signcolumn = false,
})

Do I need to now refactor those to be like:

local M = {
  "lewis6991/gitsigns.nvim",
  event = "BufReadPre",
}

function M.config()
 require("gitsigns").setup({
  numhl = true,
  signcolumn = false,
})
end

return M

? Or is there a easier way to re-use the style of setup files I already have?

Q2. I notice in https://github.com/folke/dot/blob/master/config/nvim/lua/config/plugins/gitsigns.lua there are also keymappings in there. Is that needed over having a separate mappings.lua, or just a personal preference?

Q3. With Packer, I have a number of inert files, which are the configs for plugins I might not have in use currently (the setups for other colorschemes for example). Are those inert files safe to live in the plugins folder? Or should they be moved elsewhere?

Thanks for any pionters.

[folke]

If you want to use a plugins module then yes, you need to make those files according to the spec. You can have enabled=false for plugins you don't need.

But if your current setup works, then you could use that too. Completely up to you

[craigmac]

You could also write that example like this if that helps any/you prefer (in something like ~/.config/nvim/lua/mystuff/plugins/gitsigns.lua):

return {
  "lewis6991/gitsigns.nvim",
  event = "BufReadPre",
  enabled = true, -- false if you want it 'inert'
  config = function()
    require("gitsigns").setup({
      numhl = true,
      signcolumn = false,
    })
  end
}

[benfrain]

Seems not! Does not like that it is effectively using a string. ??

Seems I'll need to 'rebuild the plane while in flight' after all. :D Not sure I really understand what's required to migrate (that's a shortcoming in my knowledge, not the plugin!) so I'll likely revisit this task when I have more time.

[craigmac]

config = function() require('plugins/gitsigns') end should work, no?

[folke]

yep, that definitely works. not sure what they're trying to achieve :)

[gennaro-tedesco]

I presume the rationale behind it is that people migrating from other plugin managers often have a file listing all plugins installation calls (say init.lua/vim) and they modularise away only the configurations, such configurations being then "imported" into the main init.lua via require(/path/to/config). In your examples the "modularisation" also contains the actual call to the plugin installation (the rationale being, if I understand correctly, that it is being merged automatically into the general table).

Myself migrating from VimPlug, I have unawarely used something along the lines of config = function() require('plugins/path/to/file) end too to make it work without having to fully rewrite.

[benfrain]

Yes, exactly that @gennaro-tedesco 👍

I’ll use that pattern and then try and migrate to the new spec one by one.

[ryuheechul]

using M and M.config is just a code style choice, I personally didn't have to do anything on structure wise - ryuheechul/dotfiles@nvim-packer...lazy-nvim
I was very impressed and pleased by that.

[benfrain]

Just to close the circle here, I ended up changing my get_setup function. With Packer it looked like this:

function get_setup(name)
  return string.format('require("setup/%s")', name)
end

Where with Lazy I have it like this (returning a function instead of a string):

function get_setup(name)
  return function()
    require("setup." .. name)
  end
end

And that way I didn't need to rewrite/move any of my individual config files at the outset.