matcha.nvim

Match and toggle augroups and options

Install

Use your favourite package manager. No setup required.

{
	"mvllow/matcha.nvim"
}

Usage

Setting keys inside the setup function will configure keymaps with a shared prefix and relevant description if using something like which-key.nvim. Your prefix is added as a mini.clue trigger.

require("matcha").setup({
	prefix = [[\]],
	-- No keys are set by default
	keys = {
		f = "FormatOnSave",
		b = "background",
		n = "number",
		d = "matcha_diagnostics",
	}
})

Alternatively, we can use the toggle method directly:

require("matcha").toggle("FormatOnSave")

Augroups

Reference existing augroups in our matcha keys or directly via matcha.toggle. Group names are expected to start with an uppercase letter.

local formatting = vim.api.nvim_create_augroup("FormatOnSave", {})
vim.api.nvim_clear_autocmds({ group = formatting })
vim.api.nvim_create_autocmd("BufWritePre", {
	group = formatting,
	callback = function()
		vim.lsp.buf.format()
	end,
})

-- Assign a key in the matcha setup
require("matcha").setup({
	keys = {
		f = "FormatOnSave"
	},
})

-- Or toggle directly
require("matcha").toggle("FormatOnSave")

Vim options

Use matcha to toggle vim options. All boolean values should be supported, as well as a few special cases mentioned below.

background - Toggle between "light" and "dark"

cmdheight - Toggle between 0 and initial value or 1

laststatus - Toggle between 0 and initial value or 2

signcolumn - Toggle between "yes" and "no"

Matcha options

In addition to vim options, matcha includes builtins for toggling more complex types. See how they're implemented.

matcha_copilot - Enable/disable copilot.vim

matcha_diagnostics - Enable/disable vim.diagnostic

matcha_diff_overlay - Enable/disable mini.diff overlay (may be expanded to other diff plugins in the future)

matcha_inlay_hints - Enable/disable inlay hints

matcha_quickfix - Open/close quickfix menu

Contributing

Contributions are welcome and appreciated 💜