https://github.com/mvllow/matcha.nvim

Match and toggle augroups and options
https://github.com/mvllow/matcha.nvim

lua neovim neovim-plugin nvim

Last synced: 21 days ago
JSON representation

Match and toggle augroups and options

• Host: GitHub
• URL: https://github.com/mvllow/matcha.nvim
• Owner: mvllow
• Created: 2023-03-04T03:29:54.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-10T15:10:36.000Z (about 1 month ago)
• Last Synced: 2024-10-19T08:16:28.955Z (about 1 month ago)
• Topics: lua, neovim, neovim-plugin, nvim
• Language: Lua
• Homepage:
• Size: 20.5 KB
• Stars: 12
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# matcha.nvim

> Match and toggle augroups and options

## Install

Use your favourite package manager. No setup required.

```lua

{

	"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](https://github.com/folke/which-key.nvim). Your prefix is added as a [mini.clue](https://github.com/echasnovski/mini.clue) trigger.

```lua

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:

```lua

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.

Example setup of format on save augroup




```lua

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](/lua/matcha/handlers/builtins.lua).

`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 💜