[](https://github.com/echasnovski/mini.nvim/blob/main/LICENSE)
### Highlight patterns in text
See more details in [Features](#features) and [help file](../doc/mini-hipatterns.txt).
---
⦿ This is a part of [mini.nvim](https://github.com/echasnovski/mini.nvim) library. Please use [this link](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-hipatterns.md) if you want to mention this module.
⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
⦿ See the repository page to learn about common design principles and configuration recipes.
---
If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://github.com/echasnovski/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
## Demo
https://github.com/echasnovski/mini.nvim/assets/24854248/130374e2-4e6c-43cf-af33-43d816b4fa32
## Features
- Highlight text with configurable patterns and highlight groups (can be string or callable).
- Highlighting is updated asynchronously with configurable debounce delay.
- Function to get matches in a buffer.
See `*MiniHipatterns-examples*` tag in help page for examples of common use cases.
Notes:
- It does not define any highlighters by default. Add to `config.highlighters` to have a visible effect.
## Example usage
```lua
local hipatterns = require('mini.hipatterns')
hipatterns.setup({
highlighters = {
-- Highlight standalone 'FIXME', 'HACK', 'TODO', 'NOTE'
fixme = { pattern = '%f[%w]()FIXME()%f[%W]', group = 'MiniHipatternsFixme' },
hack = { pattern = '%f[%w]()HACK()%f[%W]', group = 'MiniHipatternsHack' },
todo = { pattern = '%f[%w]()TODO()%f[%W]', group = 'MiniHipatternsTodo' },
note = { pattern = '%f[%w]()NOTE()%f[%W]', group = 'MiniHipatternsNote' },
-- Highlight hex color strings (`#rrggbb`) using that color
hex_color = hipatterns.gen_highlighter.hex_color(),
},
})
```
## Installation
This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
There are two branches to install from:
- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.
Here are code snippets for some common installation methods (use only one):
| Github repo | Branch | Code snippet |
|---|---|---|
| 'mini.nvim' library | Main | Follow recommended 'mini.deps' installation |
| Stable | ||
| Standalone plugin | Main | add('echasnovski/mini.hipatterns') |
| Stable | add({ source = 'echasnovski/mini.hipatterns', checkout = 'stable' }) |
| Github repo | Branch | Code snippet |
|---|---|---|
| 'mini.nvim' library | Main | { 'echasnovski/mini.nvim', version = false }, |
| Stable | { 'echasnovski/mini.nvim', version = '*' }, |
|
| Standalone plugin | Main | { 'echasnovski/mini.hipatterns', version = false }, |
| Stable | { 'echasnovski/mini.hipatterns', version = '*' }, |
| Github repo | Branch | Code snippet |
|---|---|---|
| 'mini.nvim' library | Main | Plug 'echasnovski/mini.nvim' |
| Stable | Plug 'echasnovski/mini.nvim', { 'branch': 'stable' } |
|
| Standalone plugin | Main | Plug 'echasnovski/mini.hipatterns' |
| Stable | Plug 'echasnovski/mini.hipatterns', { 'branch': 'stable' } |