English | 简体中文
This is the lua implementation of nvim-hlchunk, and add some new features like highlighting indentline, specially thanks indent-blankline.nvim, during the process of writing this plugin, this repo provided a lot of help and inspiration for me
this plugin have three parts,
- hl_chunk
- hl_indent
- hl_line_num
the first one is to highlight the current chunk, a chunk is defined as the closest pair of curly braces and the code in between, so it might not work very well in lua or python source code. In the future, I might define a chunk by using indentation (so, this plugin may become another indent_blankline in the future, laugh)
the second one is to highlight indentline like indent_blankline
the third one is similar to hl_chunk, the difference is that it will highlight line number, you can set front color or background color for it
neovim version >= 0.7.0 (maybe, just test at this version)
use { "shell-Raining/hlchunk.nvim" }
Plug "shell-Raining/hlchunk.nvim"The script comes with the following defaults:
{
-- settings for this plugin
enabled = true,
hlchunk_supported_files = { "*.ts", "*.js", "*.json", "*.go", "*.c", "*.cpp", "*.rs", "*.h", "*.hpp", "*.lua" },
-- setttings for hl_chunk
hl_chunk = {
enable = true,
chars = {
horizontal_line = "─",
vertical_line = "│",
left_top = "╭",
left_bottom = "╰",
right_arrow = ">",
},
style = {
hibiscus = "#806d9c",
primrose = "#c06f98",
},
},
-- settings for hl_indent
hl_indent = {
enable = true,
use_treesitter = true,
chars = {
vertical_line = "│",
},
style = {
vim.fn.synIDattr(vim.fn.synIDtrans(vim.fn.hlID("Whitespace")), "fg", "gui"),
},
exclude_filetype = {
dashboard = true,
help = true,
lspinfo = true,
packer = true,
checkhealth = true,
man = true,
mason = true,
NvimTree = true,
},
},
-- settings for hl_line_num
hl_line_num = {
enable = true,
style = {
hibiscus = "#806d9c",
},
},}To override the custom configuration, call:
require('hlchunk').setup({
-- your override config
})example:
require('hlchunk').setup({
-- when overide the config, enable option must be contained
enabled = true,
hl_indent = {
enable = true,
-- if you want to use multiple indent line, just place them here, the key is like vertical_line + x, which x is a number
chars = {
vertical_line1 = "│",
vertical_line2 = "¦",
vertical_line3 = "┆",
vertical_line4 = "┊",
},
style = {
"#FF0000",
"#FF7F00",
"#FFFF00",
"#00FF00",
"#00FFFF",
"#0000FF",
"#8B00FF",
},
},
})this plugin provides some commands to switch plugin status, which are listed below
- EnableHL
- DisableHL
the two commands are used to switch the whole plugin status, when use DisableHL, include hl_chunk and hl_indent will be disable
- DisableHLChunk
- EnableHLChunk
the two will control hl_chunk
- DisableHLIndent
- EnableHLIndent
the two will control hl_indent
