summaryrefslogtreecommitdiff
path: root/lua/core/comment.lua
blob: 79d711b6c03ec4ad2208ae7b11a5134e81611b1b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
local M = {}

function M.config()
  lvim.builtin.comment = {
    active = true,
    -- Linters prefer comment and line to have a space in between markers
    marker_padding = true,
    -- should comment out empty or whitespace only lines
    comment_empty = false,
    -- Should key mappings be created
    create_mappings = true,
    -- Normal mode mapping left hand side
    line_mapping = "gcc",
    -- Visual/Operator mapping left hand side
    operator_mapping = "gc",
    -- Hook function to call before commenting takes place
    hook = nil,
  }
end

function M.setup()
  require("nvim_comment").setup(lvim.builtin.comment)
end

return M