mirror of
https://github.com/LunarVim/LunarVim.git
synced 2024-09-21 11:05:08 +02:00
48d1c38fa8
* ci: update workflows * chore(plugins): bump version * chore: update depdecated settings for comment.nvim * chore(lsp): update skiplist * fixup!: take 2 for comment.nvim
86 lines
2.2 KiB
Lua
86 lines
2.2 KiB
Lua
local M = {}
|
|
|
|
function M.config()
|
|
local pre_hook
|
|
local loaded, ts_comment = pcall(require, "ts_context_commentstring.integrations.comment_nvim")
|
|
if loaded and ts_comment then
|
|
pre_hook = ts_comment.create_pre_hook()
|
|
end
|
|
lvim.builtin.comment = {
|
|
active = true,
|
|
on_config_done = nil,
|
|
---Add a space b/w comment and the line
|
|
---@type boolean
|
|
padding = true,
|
|
|
|
---Whether cursor should stay at the
|
|
---same position. Only works in NORMAL
|
|
---mode mappings
|
|
sticky = 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 = "^$",
|
|
|
|
---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,
|
|
---Extra mapping
|
|
---Includes `gco`, `gcO`, `gcA`
|
|
extra = true,
|
|
},
|
|
|
|
---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",
|
|
},
|
|
|
|
---LHS of extra mappings
|
|
---@type table
|
|
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",
|
|
},
|
|
|
|
---Pre-hook, called before commenting the line
|
|
---@type function|nil
|
|
pre_hook = pre_hook,
|
|
|
|
---Post-hook, called after commenting is done
|
|
---@type function|nil
|
|
post_hook = nil,
|
|
}
|
|
end
|
|
|
|
function M.setup()
|
|
local nvim_comment = require "Comment"
|
|
|
|
nvim_comment.setup(lvim.builtin.comment)
|
|
if lvim.builtin.comment.on_config_done then
|
|
lvim.builtin.comment.on_config_done(nvim_comment)
|
|
end
|
|
end
|
|
|
|
return M
|