aboutsummaryrefslogtreecommitdiff
path: root/nvim/lua/plugins/comment.lua
diff options
context:
space:
mode:
Diffstat (limited to 'nvim/lua/plugins/comment.lua')
-rw-r--r--nvim/lua/plugins/comment.lua50
1 files changed, 50 insertions, 0 deletions
diff --git a/nvim/lua/plugins/comment.lua b/nvim/lua/plugins/comment.lua
new file mode 100644
index 0000000..e485b9b
--- /dev/null
+++ b/nvim/lua/plugins/comment.lua
@@ -0,0 +1,50 @@
+return {
+ {
+ "numToStr/Comment.nvim",
+ config = function()
+ require('Comment').setup({
+ ---Add a space b/w comment and the line
+ padding = true,
+ ---Whether the cursor should stay at its position
+ sticky = true,
+ ---Lines to be ignored while (un)comment
+ ignore = nil,
+ ---LHS of toggle mappings in NORMAL mode
+ toggler = {
+ ---Line-comment toggle keymap
+ line = 'gcc',
+ ---Block-comment toggle keymap
+ block = 'gbc',
+ },
+ ---LHS of operator-pending mappings in NORMAL and VISUAL mode
+ opleader = {
+ ---Line-comment keymap
+ line = 'gc',
+ ---Block-comment keymap
+ block = 'gb',
+ },
+ ---LHS of extra mappings
+ extra = {
+ ---Add comment on the line above
+ above = 'gcO',
+ ---Add comment on the line below
+ below = 'gco',
+ ---Add comment at the end of line
+ eol = 'gcA',
+ },
+ ---Enable keybindings
+ ---NOTE: If given `false` then the plugin won't create any mappings
+ mappings = {
+ ---Operator-pending mapping; `gcc` `gbc` `gc[count]{motion}` `gb[count]{motion}`
+ basic = true,
+ ---Extra mapping; `gco`, `gcO`, `gcA`
+ extra = true,
+ },
+ ---Function to call before (un)comment
+ pre_hook = nil,
+ ---Function to call after (un)comment
+ post_hook = nil,
+ })
+ end,
+ },
+}