Intelligent auto-pairs with rainbow highlighting for Neovim
blink.pairs combines auto-pairs with rainbow highlighting, via a custom internal parser. The parser takes ~1ms to parse a 400k character file, and ~0.005ms for incremental updates. It uses indent-aware matching of delimiters and highlights mismatched pairs. See the roadmap for the current status, contributions welcome!
- Works out of the box with no additional configuration
- Rainbow highlighting of pairs
- Indent-aware matching of delimiters to highlight mismatched pairs
- Wrapping via motions (dot-repeatable) or treesitter
- Updates on every keystroke (<0.2ms)
code from frizbee, font iosevka, theme one-dark with catppuccin bg
The behavior was inspired by lexima.vim and nvim-autopairs
| Before | Input | After |
|---|---|---|
| |
( |
(|) |
|) |
( |
(|) |
| |
" |
"|" |
""| |
" |
"""|""" |
"foo| |
" |
"foo"| |
|foo" |
" |
"|foo" |
''| |
' |
'''|''' |
\| |
[ |
\[| |
\| |
" |
\"| |
\| |
' |
\'| |
A |
' |
A' |
(|) |
) |
()| |
((|) |
) |
(()|) |
'|' |
' |
''| |
'''|''' |
' |
''''''| |
(|) |
<BS> |
| |
'|' |
<BS> |
| |
( | ) |
<BS> |
(|) |
(|) |
<Space> |
( | ) |
Vec| |
< |
Vec<|> |
a | |
< |
a <| |
foo(|)'bar' |
<C-b>a' |
foo('bar'|) |
{
'saghen/blink.pairs',
dependencies = 'saghen/blink.lib',
version = '*',
-- download prebuilt binaries from github releases, must be on a versioned release
build = function() require('blink.pairs').download():pwait(60000) end,
-- OR build from source
-- build = function() require('blink.pairs').build():pwait(60000) end,
--- @module 'blink.pairs'
--- @type blink.pairs.Config
opts = {
mappings = {
-- you can call require("blink.pairs.mappings").enable()
-- and require("blink.pairs.mappings").disable()
-- to enable/disable mappings at runtime
enabled = true,
cmdline = true,
-- or disable with `vim.g.pairs = false` (global) and `vim.b.pairs = false` (per-buffer)
-- and/or with `vim.g.blink_pairs = false` and `vim.b.blink_pairs = false`
disabled_filetypes = {},
wrap = {
-- move closing pair via motion
['<C-b>'] = 'motion',
-- move opening pair via motion
['<C-S-b>'] = 'motion_reverse',
-- set to 'treesitter' or 'treesitter_reverse' to use treesitter instead of motions
-- set to nil, '' or false to disable the mapping
-- for normal mode mappings, only supports 'motion' and 'motion_reverse'
-- normal_mode = {}
},
-- see the defaults:
-- https://github.com/Saghen/blink.pairs/blob/main/lua/blink/pairs/config/mappings.lua#L52
pairs = {},
},
highlights = {
enabled = true,
-- requires require('vim._core.ui2').enable({}), otherwise has no effect
cmdline = true,
-- set to { 'BlinkPairs' } to disable rainbow highlighting
groups = { 'BlinkPairsOrange', 'BlinkPairsPurple', 'BlinkPairsBlue' },
-- pairs whose nesting is counted separately from the rest, or `true` for every pair
separate = { '<' },
unmatched_group = 'BlinkPairsUnmatched',
-- highlights matching pairs under the cursor
matchparen = {
-- optionally only for the given token types, e.g. 'delimiter'
enabled = true,
-- known issue where typing won't update matchparen highlight, disabled by default
cmdline = false,
-- also include pairs not on top of the cursor, but surrounding the cursor
-- optionally only for the given token types, which must be a subset of `enabled`,
-- if defined
include_surrounding = false,
group = 'BlinkPairsMatchParen',
priority = 250,
},
},
debug = false,
}
}vim.pack.add({
'https://github.com/saghen/blink.lib',
{ src = 'https://github.com/saghen/blink.pairs', version = vim.version.range('*') },
})
-- download prebuilt binaries from github releases, must be on a versioned release
require('blink.pairs').download():pwait(60000)
-- OR build from source
-- require('blink.pairs').build():pwait(60000)
-- see above for the config
require('blink.pairs').setup()