vim插件surround介绍

插件作者

vim-surround是一个处理成对出现的“包围结构”的插件,比如处理括号、引号和html标签。对文本的外包的结构进行增加、修改和删除。 由于插件提供的命令接受vim文本对象和vim的移动命令,使用起来比较方便,额外的学习成本比较低。 插件的github地址为:tpope/vim-surround · GitHub
作者是tpope,tpope贡献了很多实用的vim插件,他的github:tpope (Tim Pope) · GitHub

普通模式命令

普通模式下,插件提供下列按键绑定:

替换:change surround

cs命令是change surround的缩写,可以对指定的文本的外部包围字符进行替换,命令接受两个参数: 第一个是被替换的外部包围字符,第二个是要替换为的字符。替换时光标需要移动到被包围的文本内。 比如需要将字符串'test'外部的包围字符'替换为",可以将光标移动到文本区域内,然后使用cs'"即可 下面是一些例子,部分来自帮助文件,其中的*号代表光标位置
注意 命令中使用形如()、{}、[]的字符的左半部分和右半部分是有区别的, 区别在于处理中的头部和尾部的空格的处理,考虑例子6、7、8、9的情况,处理字符串(   test   ), 字符串有3个头部空格,有2个尾部空格。
规则 规则可以总结如下:
1.第一个参数使用符号的左半部分,会自动删除所有的头部和尾部 的空格,使用右半部分则不对空格进行处理
2.第二个参数使用符号的左半部分,会自动在左半部分的后面和右半部分的前面插入一个空格
注意例子8中的空格个数,被自动插入了空格

样例序号 原始文本 执行命令 执行结果
1 "Hello*world!" cs"' 'Helloworld!'
2 "Hello*world!" cs"<q> <q>Helloworld!</q>
3 (( Hello*world! )) cs(* (*Hello*world!*)
4 (( Hello*world! )) cs( * (* Hello*world! *)
5 <div>Yo!*</div> cst<p> <p>Yo!</p>
6 (   test   ) cs([ [ test ]
7 (   test   ) cs(] [test]
8 (   test   ) cs)[ [    test    ]
9 (   test   ) cs)] [   test   ]

删除:delete surround

ds命令是delete surround的缩写,该命令只接受一个参数,即为需要删除的外部包围字符 如果需要删除文本外部的标签,可以使用字符t来指代标签,不需要输入标签全称 下面是一些例子:
注意 命令中使用形如()、{}、[]的字符的左半部分和右半部分是有区别的, 规则同cs命令的规则1,即同样遵守第一个参数的规则,不再举例示范

样例序号 原始文本 执行命令 执行结果
1 "Hello*world!" ds" Hello world!
2 ((Hello*world!)) ds{ (Hello*world!)
2 (123+4*56)/2 ds) 123+456/2
3 <div>Yo!*</div> dst Yo!

添加:you surround

ys命令是you surround(按作者的说法),可以对指定的文本进行包围,命令接受两个参数: 第一个是指示文本范围或者移动位置的文本对象,第二个是包围操作使用的字符。插入时光标需要移动到被包围的文本内。 比如需要将字符串test添加外部包围字符',可以将光标移动到文本区域内,然后使用ysaw"即可,其中aw会被当作vim文本对象, ys模式有一种变形,即yss和ySS,操作的对象是当前行,不过yss的包围符号添加在行首行尾,而ySS的符号会插入两个新行来包围。 下面是一些例子,部分来自帮助文件,其中的*号代表光标位置
指定范围的两种方法
1.文本对象,规则基本同vim的文本对象规则一样
2.移动位置,可以使用^、$、f等命令来指定位置,作用范围是当前光标到指定的位置
注意 命令中使用形如()、{}、[]的字符的左半部分和右半部分是有区别的, 规则同cs命令的规则2,即同样遵守第二个参数的规则,不再举例示范

样例序号 原始文本 执行命令 执行结果
1 test ysiw' 'test'
2 'test' ysi') '(test)'
3 'test' ysa') ('test')
4 foo*testbar ystb) foo(test)bar
5 test ysaw<p class="example"> <p class="example">test</p>

可视模式命令

可视模式下可以选择需要的文本块,然后使用命令S,就可以输入用来进行包围的字符,不再赘述。

插入模式命令

插件的插入模式还处于试验状态,可以在插入模式下插入字符对,不过我并没有测试成功。通过map命令查看文档中的按键绑定,发现并未绑定函数。

定制插件行为

插件提供对符号的行为进行定制的功能,如果需要定制'-'符号在php文件中的功能,则按下面步骤操作

" 1.使用vim函数获得ascii码
:echo char2nr("-")
" 2.在vim文件中添加绑定,并使用文件类型侦测
" 注意b:surround_45使用了'-'的ascii码值45
autocmd FileType php let b:surround_45 = "<?php \r ?>"

如果文件类型是php,则在字符串 print "Hello *world!"上执行yss-即可得到<?php print "Hello world!" ?>。使用如下方式还可以请求用户输入,jekyll的语法高亮使用highlight语法来完成,每次输入较麻烦,可以在vimrc中加入下面的设置

let g:surround_45 = "{% hightlight \1代码语言: \1 %}\r{% endhighlight %}"

这样就自定义了字符"-"的包围语法模板,比如在testtest上使用ySS-,会显示“代码语言:”并等待用户输入,输入bash,则得到下面的代码 其中的"\1代码语言: \1"被替换为用户输入的字符串,"\r"被替换为用户选择的需要被包围的文本,其余的均原样输出, 如果需要,可以在语法模板中使用换行等转义字符。语法模板也支持正则表达式的处理,但是语法过于古怪和丑陋,个人认为没有使用的价值。

{% highlight bash %}
testtest
{% endhighlight %}
  


—  原创作品许可 — 署名-非商业性使用-禁止演绎 3.0 未本地化版本 — CC BY-NC-ND 3.0   —