Customize snipmate

Customize SnipMate

By Richard Ma (richard_ma)
Sunday, July 3, 2011

Tianjin Linux User Group

IF 有问题 THEN 请示意我


Overview
● 简介与安装
● 基本使用方法
● Snippet 语法与自定义
● 高级 Snippet 特性
● 操作演示
● 改进方向
● 参考资料


简介
● SnipMate 可以将简短的触发短语 (trigger) 替换为
需要的文字片段。
● SnipMate 在 vim.org 的主页：
– http://www.vim.org/scripts/script.php?script_id=2540
● SnipMate 最新开发版仓库：
http://github.com/msanders/snipmate.vim
–
● 本例中使用 SnipMate 版本为 v0.83


安装
● 下载 SnipMate 安装压缩包
● 解压到 ~/.vim/ 目录下（如果是版本升级，请先
删除所有旧版本文件，包括默认的 snippets ）
● 打开 filetype 和 plugin 支持（可以添加到 vimrc
中）


基本使用方法
● SnipMate 默认就提供了很多缩写和文字段落的数
据，类似
trigger —— expand text （这样的一组叫做
snippet ）
● 在 insert 模式下使用：
trigger<tab>
● 在 tab 键按下后， trigger 会被替换为：
expand text


Snippet 运行机制
● SnipMate 在查询 Snippet 时，依据 filetype 分类，
每个 filetype 可以定义自己的 Snippet
● Snippet 以 trigger 作为 id ，但允许 id 重复
● 多个 Snippet 可以定义在一个文件中，也可分为
单独的文件
● Snippet 中可以使用变量（ tab stop ）和占位符
（ placeholder ）
● 所有 Snippet 定义文件保存在 ~/.vim/snippets/


在一个文件中定义多个 Snippet
● 文件扩展名为： <filetype>.snippets
– filetype 为文件类型，扩展名末尾有 s


基本语法
● 在一个文件中定义多个 snippet 语法：
– snippet <trigger>
<expand text>
● 带有注释的写法
– # This is a comment
snippet <trigger>
<expand text>
● 注释必须放在行开头，不可以放在 <expand text>
中； <expand text> 可以写多行，以 <tab> 开头。


Tab Stop
● <expand text> 中加入变量，可是使得 SnipMate
的替换功能更加强大
– ${#} 这里的 # 为一个数字，表示按 tab 跳转的序
号


Placeholder
● Placeholder 可以给 Tab Stop 赋予默认值
– ${1:placeholder}


引用 Tab Stop 的值
● 使用 $# 的方式引用 Tab Stop 的值（包括
placeholder ）


将 Tab Stop 作为 Placeholder

● ${1:placeholder} 可以作为 ${2:$1} 的 placeholder


多匹配 trigger


全局 Snippet
● snippet/_.snippets
● 语法与其他 snippets 文件相同
● 任何 filetype 都可以触发其中的 trigger


插入正在编辑的文件名

filename<tab>

test
(filename is test.st)


调用 vimrc 中的变量
● 在 ~/.vimrc 中定义变量，使用如下方式调用。


使用 system() 函数调用 bash 命令

grouplist<tab>


SnipMate 操作演示
● 使用 SnipMate 协助完成一个分割数字的程序
● 借助 SnipMate 自动生成注释文档
● 递归算法
● C 语言编写


改进方向
● Tab stop 必须从 1 开始编号
● 不支持 placeholder 的嵌套
– <div ${1: id=”${2:some_id)”}>${3}</div>
id=”${2:some_id)”}
● Tab stop 不支持正则表达式匹配
● 不支持多行 Placeholder
● 在同一文件中，不支持分段落使用不同的
snippets 定义文件
● Snippet 的 mashup


参考资料
● SnipMate 帮助文档
– 进入 vim
– :h snipmate


Customize snipmate

Recomendados

Recomendados

Mais conteúdo relacionado

Destaque

Destaque (8)

Semelhante a Customize snipmate

Semelhante a Customize snipmate (20)

Mais de Rhythm Sun

Mais de Rhythm Sun (15)

Customize snipmate