add comment.nvim

nvim/init.lua

@@ -10,6 +10,7 @@ require('statusline')
 require('snippets')
 require('autocompletion')
 require('treesitterconfig')
+require('comments')
 require('troubleconfig')
 require('null-ls-config')
 require('gitsigns-config')

nvim/lua/comments.lua

@@ -0,0 +1,45 @@
+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,
+        ---Extended mapping; `g>` `g<` `g>[count]{motion}` `g<[count]{motion}`
+        extended = false,
+    },
+    ---Function to call before (un)comment
+    pre_hook = nil,
+    ---Function to call after (un)comment
+    post_hook = nil,
+})

nvim/lua/plugins.lua

@@ -10,6 +10,9 @@ Plug 'editorconfig/editorconfig-vim'
 -- brackets management
 Plug 'kylechui/nvim-surround'
 
+-- comments
+Plug 'numToStr/Comment.nvim'
+
 -- shift and tab setup
 Plug 'tpope/vim-sleuth'