Cthru exposes a global :CthruToggle user command which can be used to toggle the background color property of certain highlight groups.

---

Installation and usage

Important

Neovim version 0.10.0 or higher required!

Install as any other normal plugin.

An optional configure method can be used for altering the default behavior. The available options are:

require("cthru").configure({
    excluded_groups = {}, -- highlight groups to be excluded from default list
    additional_groups = {}, -- additional highlight groups to be included
})

Additionaly the global variable g:cthru_groups can also be used to extend the default list without needing to call configure.

local custom_hl_groups = {} -- append extra groups
vim.g.cthru_groups = vim.list_extend(vim.g.cthru_groups, custom_hl_groups)

Caveats

• Sometimes other plugins or other parts of the configuration might also utilize the ColorScheme event to listen for colorscheme changes and modify the highlight groups of the default colorscheme set by the user. To prevent race conditions in such scenarios, cthru delays calling its main function until a specific timeout period passes. This timeout duration can be adjusted using the g:cthru_defer_count variable, which defaults to 300(ms). Consider reducing it (even to 0) if no such parallel events are to occur, or increasing it if some groups are being incorrectly interpreted.

Plans

• Persistent highlight state between restarts