docs(plugin): add docs for installing comment.nvim with lazy.nvim #367
Conversation
| { "gcc", mode = "n", desc = "Toggles the current line using linewise comment" }, | ||
| { "gbc", mode = "n", desc = "Toggles the current line using blockwise comment" }, | ||
| { "gc", mode = "v", desc = "Toggles the region using linewise comment" }, | ||
| { "gb", mode = "v", desc = "Toggles the region using blockwise comment" }, |
There was a problem hiding this comment.
That is way too much noise for an install instruction.
There was a problem hiding this comment.
What is the recommended way to install via lazy.nvim?
There was a problem hiding this comment.
The intent of keys here is to register the key mapping, but not load the plugin until the keys are actually use (ie 'lazy' load it).
If you don't include keys, then the next best thing would be using an event to use.
There was a problem hiding this comment.
Why would you want to lazy load this https://github.com/numToStr/Comment.nvim/blob/master/plugin/Comment.lua at all?
There was a problem hiding this comment.
That file specifically, or comment.nvim in general?
I am looking at that file, and I'm kinda surprised to not see a setup method 🤔 Actually, it looks like https://github.com/numToStr/Comment.nvim/blob/master/lua/Comment/init.lua is what would actually be loaded via require('Comment').setup.
Lazy.nvim has a convention of, if you have opts = true or opts = { ... }, it essentially ends up doing:
require('Comment').setup(opts)There was a problem hiding this comment.
@technicalpickles setup() method in init.lua create keymaps. And Comment.lua file is for Plug mappings and is the base for most of the keymaps in init.lua. Also, in general <Plug> mappings should never require any setup() call in any plugin.
Assuming if a user doesn't want any keymaps, they don't need to call setup() they can directly use <Plug> mappings to create their own keymaps.
No description provided.