add comment.nvim and fix lsp keymap

lua/config/comment.lua

@@ -0,0 +1,15 @@
+local opts = { noremap = true, silent = true }
+
+require("Comment").setup({
+    mappings = {
+        ---Operator-pending mapping; `gcc` `gbc` `gc[count]{motion}` `gb[count]{motion}`
+        basic = false,
+        ---Extra mapping; `gco`, `gcO`, `gcA`
+        extra = false,
+    },
+})
+
+vim.keymap.set("n", "<leader>/", require("Comment.api").toggle.linewise.current)
+
+vim.keymap.set("v", "<leader>/",
+    '<ESC><CMD>lua require("Comment.api").toggle.linewise(vim.fn.visualmode())<CR>', opts)

lua/config/init.lua

@@ -2,3 +2,4 @@ require("config.lazy")
 require("config.lsp")
 require("config.theme")
 require("config.nvim-tree")
+require("config.comment")

lua/config/lazy.lua

@@ -6,9 +6,9 @@ require("lazy").setup({
         "hrsh7th/nvim-cmp",
         dependencies = {
             "hrsh7th/cmp-nvim-lsp", -- lsp auto-completion
-            "hrsh7th/cmp-buffer", -- buffer auto-completion
-            "hrsh7th/cmp-path", -- path auto-completion
-            "hrsh7th/cmp-cmdline", -- cmdline auto-completion
+            "hrsh7th/cmp-buffer",   -- buffer auto-completion
+            "hrsh7th/cmp-path",     -- path auto-completion
+            "hrsh7th/cmp-cmdline",  -- cmdline auto-completion
         },
         config = function()
             require("config.nvim-cmp")
@@ -39,4 +39,6 @@ require("lazy").setup({
         },
     },
 
+    "numToStr/Comment.nvim",
+
 })

lua/config/lsp.lua

@@ -33,10 +33,10 @@ local lspconfig = require('lspconfig')
 -- Customized on_attach function
 -- See `:help vim.diagnostic.*` for documentation on any of the below functions
 local opts = { noremap = true, silent = true }
-vim.keymap.set('n', 'd', vim.diagnostic.open_float, opts)
-vim.keymap.set('n', 'dn', vim.diagnostic.goto_prev, opts)
-vim.keymap.set('n', 'dp', vim.diagnostic.goto_next, opts)
-vim.keymap.set('n', 'dl', vim.diagnostic.setloclist, opts)
+vim.keymap.set('n', '<leader>d', vim.diagnostic.open_float, opts)
+vim.keymap.set('n', '<leader>dp', vim.diagnostic.goto_prev, opts)
+vim.keymap.set('n', '<leader>dn', vim.diagnostic.goto_next, opts)
+vim.keymap.set('n', '<leader>dl', vim.diagnostic.setloclist, opts)
 
 -- Use an on_attach function to only map the following keys
 -- after the language server attaches to the current buffer
@@ -46,19 +46,19 @@ local on_attach = function(client, bufnr)
 
     -- See `:help vim.lsp.*` for documentation on any of the below functions
     local bufopts = { noremap = true, silent = true, buffer = bufnr }
-    vim.keymap.set('n', 'ld', vim.lsp.buf.declaration, bufopts)
-    --vim.keymap.set('n', 'gd', vim.lsp.buf.definition, bufopts)
-    --vim.keymap.set('n', 'K', vim.lsp.buf.hover, bufopts)
+    vim.keymap.set('n', '<leader>ld', vim.lsp.buf.declaration, bufopts)
+    vim.keymap.set('n', '<leader>lD', vim.lsp.buf.definition, bufopts)
+    vim.keymap.set('n', '<leader>lh', vim.lsp.buf.hover, bufopts)
     --vim.keymap.set('n', 'gi', vim.lsp.buf.implementation, bufopts)
-    --vim.keymap.set('n', '<C-k>', vim.lsp.buf.signature_help, bufopts)
+    vim.keymap.set('n', '<leader>ls', vim.lsp.buf.signature_help, bufopts)
     --vim.keymap.set('n', '<space>wa', vim.lsp.buf.add_workspace_folder, bufopts)
     --vim.keymap.set('n', '<space>wr', vim.lsp.buf.remove_workspace_folder, bufopts)
     --vim.keymap.set('n', '<space>wl', function()
     --    print(vim.inspect(vim.lsp.buf.list_workspace_folders()))
     --end, bufopts)
     --vim.keymap.set('n', '<space>D', vim.lsp.buf.type_definition, bufopts)
-    vim.keymap.set('n', 'lr', vim.lsp.buf.rename, bufopts)
-    vim.keymap.set('n', 'la', vim.lsp.buf.code_action, bufopts)
+    vim.keymap.set('n', '<leader>lr', vim.lsp.buf.rename, bufopts)
+    vim.keymap.set('n', '<leader>la', vim.lsp.buf.code_action, bufopts)
     --vim.keymap.set('n', 'gr', vim.lsp.buf.references, bufopts)
     --vim.keymap.set("n", "<space>f", function()
     --    vim.lsp.buf.format({ async = true })

lua/config/nvim-cmp.lua

@@ -72,8 +72,8 @@ cmp.setup({
     -- Set source precedence
     sources = cmp.config.sources({
         { name = 'nvim_lsp' }, -- For nvim-lsp
-        { name = 'luasnip' }, -- For luasnip user
-        { name = 'buffer' }, -- For buffer word completion
-        { name = 'path' },   -- For path completion
+        { name = 'luasnip' },  -- For luasnip user
+        { name = 'buffer' },   -- For buffer word completion
+        { name = 'path' },     -- For path completion
     })
 })

readme.md

@@ -1,4 +1,4 @@
 # TODO: 
-- [ ] commenting in normal / visual mode with '/'
+- [x] commenting in normal / visual mode with '/'
 - [ ] autoclosing of brackets
 - [ ] type information in complete function