rhysd / vim-operator-surround

Vim operator mapping to enclose text objects with surrounds like paren, quote and so on.

Operator to Surround a Text Object

This plugin provides Vim operator mappings to deal with surrounds like (), "" and so on. In addition, both end of the text object are the same character, vim-operator-surround recognizes them as a surround (this behavior is customizable with some variables).

It can

• surround a text object with a specified block.
• replace a surround in a text object with a specified block.
• delete a surround in a text object.

This plugin would be more useful with vim-textobj-between or vim-textobj-anyblock. And you can customize and add surround definitions in global and filetype specific scope.

Policy of This Plugin (or The Reason Why I Don't Use vim-surround)

• Simplicity : All should be done with operator mappings.
• Extensibility : The behavior should be highly customizable with g:operator#surround#blocks and text objects like vim-textobj-multiblock, vim-textobj-between or vim-textobj-anyblock.
• Well-tested

Requirements

This plugin uses vim-operator-user. Please install it in advance.

Customize

Set your favorite blocks to g:operator#surround#blocks. And control the behavior with some variables. Please read doc for more details.

Example of vimrc

" operator mappings
map <silent>sa <Plug>(operator-surround-append)
map <silent>sd <Plug>(operator-surround-delete)
map <silent>sr <Plug>(operator-surround-replace)


" delete or replace most inner surround

" if you use vim-textobj-multiblock
nmap <silent>sdd <Plug>(operator-surround-delete)<Plug>(textobj-multiblock-a)
nmap <silent>srr <Plug>(operator-surround-replace)<Plug>(textobj-multiblock-a)

" if you use vim-textobj-anyblock
nmap <silent>sdd <Plug>(operator-surround-delete)<Plug>(textobj-anyblock-a)
nmap <silent>srr <Plug>(operator-surround-replace)<Plug>(textobj-anyblock-a)

" if you use vim-textobj-between
nmap <silent>sdb <Plug>(operator-surround-delete)<Plug>(textobj-between-a)
nmap <silent>srb <Plug>(operator-surround-replace)<Plug>(textobj-between-a)

License

vim-operator-surround is distributed under MIT license.

Copyright (c) 2013-2017 rhysd

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.