chunk.md

how to configure chunk mod

what can chunk do

it is used to highlight the code block where the cursor is located.

Configurable items

chunk have four configurable items

1. enable
2. notify
3. use_treesitter
4. exclude_filetypes
5. support_filetypes
6. chars
7. style
8. max_file_size

enable is used to control whether the mod is started, the default is true.

If set to false, the usercmd and autocmd it carries will not be generated, and the mod will be closed at this time

notify is used to control whether to pop up a prompt in some cases (such as using the disableHLChunk command twice in a row), the default is true

use_treesitter is used to control whether to use treesitter to highlight the code block, the default is true

If set to false, vim's match will be used to highlight the code block, otherwise treesitter will be used to determine the current code block

exclude_filetypes is a lua table type, example as follows, the default exclude_filetypes can be found in the default config

exclude_filetypes = {
    aerial = true,
    dashboard = true,
}

support_filetypes is a lua table type, example as follows

support_filetypes = {
    "*.lua",
    "*.js",
}

chars is also a lua table, the characters in it are used to indicate how to render the chunk line, which contains five parts

• horizontal_line
• vertical_line
• left_top
• left_bottom
• right_arrow

style is an RGB string or an RGB string table, the default is "#806d9c".

max_file_size is a number, the default is 1024*1024(1MB), which is used to control the maximum file size that can be highlighted

example

below is the default style of chunk line

its configuration is

chunk = {
    chars = {
        horizontal_line = "─",
        vertical_line = "│",
        left_top = "╭",
        left_bottom = "╰",
        right_arrow = ">",
    },
    style = "#806d9c",
},

you can also set like this gif

chunk = {
    chars = {
        horizontal_line = "─",
        vertical_line = "│",
        left_top = "┌",
        left_bottom = "└",
        right_arrow = "─",
    },
    style = "#00ffff",
},