blackCauldron7/surround.nvim

github github
editing-supports plugin
star 196
stars
alert-circle 4
open issues
users 5
subscribers
git-branch 6
forks
CREATED

2020-09-24

UPDATED

1 hour ago

packer

require('packer').startup(function()
  use 'blackCauldron7/surround.nvim'
end)

paq

require "paq" { 
  'blackCauldron7/surround.nvim'
}

surround.nvim

Features

Key mappings

There are two keymap modes for normal mode mappings.

  • sandwich and surround and they can be set using the options mentioned below.

Normal Mode - Sandwich Mode

  1. Provides key mapping to add surrounding characters.( visually select then press s<char> or press sa{motion}{char})
  2. Provides key mapping to replace surrounding characters.( sr<from><to> )
  3. Provides key mapping to delete surrounding characters.( sd<char> )
  4. ss repeats last surround command.

Normal Mode - Surround Mode

  1. Provides key mapping to add surrounding characters.( visually select then press s<char> or press ys{motion}{char})
  2. Provides key mapping to replace surrounding characters.( cs<from><to> )
  3. Provides key mapping to delete surrounding characters.( ds<char> )

Insert Mode

  • <c-s><char> will insert both pairs in insert mode.
  • <c-s><char><space> will insert both pairs in insert mode with surrounding whitespace.
  • <c-s><char><c-s> will insert both pairs on newlines insert mode.

IDK I was bored

  1. Cycle surrounding quotes type. (stq)
  2. Cycle surrounding brackets type. (stb)
  3. Use <char> == f for adding, replacing, deleting functions.

Installation

  1. vim-plug: Plug 'blackcauldron7/surround.nvim' and Put this somewhere in your init.vim: lua require"surround".setup{}
  2. minPlug: MinPlug blackcauldron7/surround.nvim and Put this somewhere in your init.vim: lua require"surround".setup{}
  3. Packer.nvim
use {
  "blackCauldron7/surround.nvim",
  config = function()
    require"surround".setup {mappings_style = "sandwich"}
  end
}

OR

use {
  "blackCauldron7/surround.nvim",
  config = function()
    require"surround".setup {mappings_style = "surround"}
  end
}

Configuration

Format: for vimscript let g:surround_<option> and for lua vim.g.surround_<option>

  • prefix: prefix for sandwich mode. (default: s)
  • pairs: dictionary or lua table of form { nestable: {{},...}, linear: {{},....} } where linear is an array of arrays which contain non nestable pairs of surrounding characters first opening and second closing like ", ' and nestable is an array of arrays which contain nestable pairs of surrounding characters like (, {, [. Default:
    {
    nestable = {{"(", ")"}, {"[", "]"}, {"{", "}"}},
    linear = {{"'", "'"}, {'"', '"'}}
    }
    
  • context_offset: number of lines to look for above and below the current line while searching for nestable pairs. (default: 100)
  • load_autogroups: whether to load inbuilt autogroups or not. (default: false)
  • mappings_style: "surround" or "sandwich" (default: sandwich)
  • load_keymaps: whether to load inbuilt keymaps or not. (default: true)
  • quotes: an array of items to be considered as quotes while cycling through them. (default: ["'", '"'])
  • brackets: an array of items to be considered as brackets while cycling through them. (default: ["(", "{", "["])
  • map_insert_mode: whether to load insert mode mappings or not. (default: true)

Caveats

  1. Only supports neovim and always will because it's written in lua which is neovim exclusive.
  2. Doesn't support python docstrings and html tags yet.
  3. No vim docs(idk how to make them. Need help)
  4. No . repeat support(idk how to achieve this help would be appreciated.) (although there is a mapping ss only available in sandwich mode which repeats last surround command.)

Contributing

You are more than welcome to submit PR for a feature you would like to see or bug fixes.