feat: add commenting plugin to nvim

This commit is contained in:
David JULIEN 2021-10-12 19:10:20 +02:00
parent c2e341f23e
commit ddc0447818
3 changed files with 60 additions and 0 deletions

View File

@ -17,3 +17,6 @@ require("plugin.cmp") -- ./lua/plugin/cmp.lua
-- treesitter
require("plugin.treesitter") -- ./lua/plugin/treesitter.lua
-- commenting, done right
require("plugin.comment") -- ./lua/plugin/comment.lua

View File

@ -0,0 +1,54 @@
-- Author : swytch
-- Created : Tuesday Oct. 12, 2021 19:07:36 CET
-- License : GPLv3
-- Description : Comment plugin config file
require("Comment").setup {
---Add a space b/w comment and the line
---@type boolean
padding = true,
---Lines to be ignored while comment/uncomment.
---Could be a regex string or a function that returns a regex string.
---Example: Use '^$' to ignore empty lines
---@type string|function
ignore = nil,
---Whether to create basic (operator-pending) and extra mappings for NORMAL/VISUAL mode
---@type table
mappings = {
---operator-pending mapping
---Includes `gcc`, `gcb`, `gc[count]{motion}` and `gb[count]{motion}`
basic = true,
---extended mapping
---Includes `g>`, `g<`, `g>[count]{motion}` and `g<[count]{motion}`
extra = false,
},
---LHS of line and block comment toggle mapping in NORMAL/VISUAL mode
---@type table
toggler = {
---line-comment toggle
line = 'gcc',
---block-comment toggle
block = 'gbc',
},
---LHS of line and block comment operator-mode mapping in NORMAL/VISUAL mode
---@type table
opleader = {
---line-comment opfunc mapping
line = 'gc',
---block-comment opfunc mapping
block = 'gb',
},
---Pre-hook, called before commenting the line
---@type function|nil
pre_hook = nil,
---Post-hook, called after commenting is done
---@type function|nil
post_hook = nil,
}

View File

@ -69,6 +69,9 @@ return require("packer").startup(function()
}
}
-- commenting, simplified
use "numToStr/Comment.nvim"
-- display colors directly in editor
use {
"norcalli/nvim-colorizer.lua",