Vim Plugins You Should Know About, Part I: surround.vim

http://www.catonmat.net/blog/vim-plugins-surround-vim/

by pkrumins • 18 years ago

77 18 18 years ago

tumult• 18 years ago

oh my god, thank you. i love you.

thamer2• 18 years ago

I tried this plugin a few days ago, but it seemed to break the s (substitute) command, so I removed it. Does someone know how to make it work?

The problem is the following: Write a line of text, select part of it using v, then press s to remove the selection and enter insert mode to start replacing it. This doesn't work anymore when surround.vim is loaded. Too bad, it sure looks great…

pkrumins5• 18 years ago

Try 'R' instead of 's' that you were used to.

OR

Edit surround.vim and comment out the 's' mappings in visual mode. Like this:

    "    if !hasmapto("<Plug>Vsurround","v")
    "        if exists(":xmap")
    "            xmap  s    <Plug>Vsurround
    "        else
    "            vmap  s    <Plug>Vsurround
    "        endif
    "    endif
    "    if !hasmapto("<Plug>VSurround","v")
    "        if exists(":xmap")
    "            xmap  S    <Plug>VSurround
    "        else
    "            vmap  S    <Plug>VSurround
    "        endif
    "    endif

thamer2• 18 years ago

'R' replaces the whole line, so that won't do. I commented the script as you suggested and it works. Thank you!

sofal• 18 years ago

If I'm not mistaken, I believe that pressing c instead of s in that situation will do the exact same thing.

thomasmallen3• 18 years ago

  <!-- Ugh. Surround is OK, but sucks for wrapping in HTML tags. If I select the line: -->

  Hello!

  <!-- And use stp (surround selection with <p/>) I get: -->

  <p>
      Hello!
  </p>

  <!-- Instead of -->
  
  <p>Hello!</p>

  <!-- The workaround? ^v$ which is tedious. I recommend mapping this for those times when you want to wrap the current line quickly in XML tags. 

  function! TagWrapper()
      let a:tag = input("Tag: ")
      normal `>
      exe "normal a</" . a:tag . ">"
      normal `<
      exe "normal i<" . a:tag . ">"
  endfunction
  -->

pkrumins5• 18 years ago

This plugin does not define 'stp'. You must be using some other plugin that has this mapping.

The plugin I wrote about wraps HTML around perfectly. Try:

    ysiWt<p>

Or if you knew the tag you were going to wrap your "Hello!" in, then in insert mode you could have pressed:

    <CTRL+s>t<p>.

thomasmallen3• 18 years ago

No, the plugin does define stp.

  :help Surround

The pattern you have there ("ysiWtp", < is unnecessary, as is >) is actually not thoroughly tested (as mentioned in the docs) and is used when not in a visual selection. In a visual selection, you use "s" followed by what you want to surround with, e.g. s"

tdavis• 18 years ago

I've been looking for a plugin that does precisely this. Thank you Peteris, you've got another subscriber ;)

pkrumins5• 18 years ago

Thank you! :)

kilowatt• 18 years ago

I just made a plugin recently for on the fly Python checking with squiggly underlines, like a "real" IDE: pyflakes.vim http://www.vim.org/scripts/script.php?script_id=2441

(Make sure you grab a Python 2.5/gvim--required ATM--build from the link on that page as well.)

pmarin2• 18 years ago

My favorite vim plugin is to not use any plugin: use the filter command "!", the unix way.

newsycaccount• 18 years ago

Vim Plugins You Should Know About, Part I: surround.vim

Related Stories