Skip to content

Saghen/blink.pairs

Repository files navigation

Blink Pairs (blink.pairs)

Rainbow highlighting and auto-pairs for Neovim. Uses a custom parser internally which takes ~2ms to parse a 400k character file, and ~0.15ms for subsequent incremental updates. See the roadmap for the current status, contributions welcome!

Behavior

The behavior was inspired by lexima.vim and nvim-autopairs

Before Input After
| ( (|)
|) ( (|)
| " "|"
""| " """|"""
''| ' '''|'''
\| [ \[|
\| " \"|
\| ' \'|
A ' A'
(|) ) ()|
((|) ) (()|)
'|' ' ''|
'''|''' ' ''''''|
(|) <BS> |
'|' <BS> |
( | ) <BS> (|)
(|) <Space> ( | )

Installation

{
  'saghen/blink.pairs',
  version = '*', -- (recommended) only required with prebuilt binaries

  -- download prebuilt binaries from github releases
  dependencies = 'saghen/blink.download',
  -- OR build from source, requires nightly:
  -- https://rust-lang.github.io/rustup/concepts/channels.html#working-with-nightly-rust
  -- build = 'cargo build --release',
  -- If you use nix, you can build from source using latest nightly rust with:
  -- build = 'nix run .#build-plugin',

  --- @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 = {},
      -- see the defaults:
      -- https://github.com/Saghen/blink.pairs/blob/main/lua/blink/pairs/config/mappings.lua#L14
      pairs = {},
    },
    highlights = {
      enabled = true,
      -- requires require('vim._extui').enable({}), otherwise has no effect
      cmdline = true,
      groups = {
        'BlinkPairsOrange',
        'BlinkPairsPurple',
        'BlinkPairsBlue',
      },
      unmatched_group = 'BlinkPairsUnmatched',

      -- highlights matching pairs under the cursor
      matchparen = {
        enabled = true,
        -- known issue where typing won't update matchparen highlight, disabled by default
        cmdline = false,
        group = 'BlinkPairsMatchParen',
      },
    },
    debug = false,
  }
}

About

Rainbow highlighting and intelligent auto-pairs for Neovim

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published