Sublime Text Snippets

翻译自sublime官网doc


Sublime Snippets

Snippets(片段)

无论你在写代码还是下一本畅销书吸血鬼日记,一定会需要一些固定格式的文字。使用Snippets来保存乏味的文字。 Snippets是智能的模板,它会适应上下文并替你插入文本。

创建一个新的片段,选择Tools->Developer->New Snippet... Sublime Text会提供一个框架来创建新的片段

片段可以存储在任意包的文件夹下,但为简单起见,你可以将它们保存在你的Packages/User文件夹下。

Snippets File Format(片段文件格式)

片段通常在一个sublime text包中。它们是简化了的以sublime-snippet为后缀的xml文件。比如,你可以再Email的package中有一个名为greeting.sublime-snippet的片段文件。

典型的片段结构如下(包括Sublime Text为了方便插入的默认提示):

<snippet>
    <content><![CDATA[Type your snippet here]]></content>
    <!-- Optional: Tab trigger to activate the snippet -->
    <tabTrigger>xyzzy</tabTrigger>
    <!-- Optional: Scope the tab trigger will be active in -->
    <scope>source.python</scope>
    <!-- Optional: Description to show in the menu -->
    <description>My Fancy Snippet</description>
</snippet>

snippet元素包含了Sublime Text所需的插入什么,是否插入,何时插入的全部信息,下面依次解释各个元素。

content
content是实际插入的内容,片段可以是简单的模板,也可以是相当复杂的模板,后面我们会讲解这两种模板。

当新建自己的片段时,遵循以下:

  1. 如果片段中有字符 $,必须使用\转义:$
  2. 如果片段中包含缩排,使用tabs即可。如果选项translateTabsToSpaces被设置为true,当片段被插入时tabs会被转换为空格。

片段内容必须使用<![CDATA[...]]包含,否则片段将不会有效

tabTrigger
tabTrigger定义了触发插入片段的键序列。当输入完触发字符并且按Tab键时,片段会立即生效
tab 出发键是隐含的键绑定

scope
范围选择器决定了片段会被激活的上下文,查看Scopes了解更多信息。通常,可以查看当前文档的scope,使用Tools->Develper->Show Scope Name,以下是看看python文件的scope:

文件scope

description
当在Snippets菜单中展示时,会显示片段的描述。如果没有指定描述,Sublime Text会默认展示片段的名字

snippet描述

了解了以上信息,就可以开始编写自己的片段了

Note
为简单起见,我们在例子中只包含了content元素的文本,除非另有说明

Snippet Features (片段特色)

Environment Variables(环境变量)

片段可以通过环境变量的形式访问上下文信息。Sublime Text自动设置以下变量的值。可以添加自定义的变量来提供额外的信息,这些自定义的变量被定义在.sublime-options文件中。

$PARAM1, $PARAM2 传递给inset_snippet命令的参数(本文不介绍)
$SELECTION 当片段被触发时选中的文本
$TM_CURRENT_LINE 当片段被触发时光标所在行的内容
$TM_CURRENT_WORD 当片段被触发时光标所在单词的内容
$TM_FILENAME 当前被编辑文件的名字,包括扩展名
$TM_FILEPATH 当前被编辑文件路径
$TM_FULLNAME 用户的用户名
$TM_LINE_INDEX 片段被插入的列,列从0开始
$TM_LINE_NUMBER 片段被插入的行,行从1开始
$TM_SELECTED_TEXT $SELECTION的别名
$TM_SOFT_TABS translate_tabs_to_spacestrue时,值为YES,否则为NO
$TM_TAB_SIZE pre-tab的空格数(由tab_size选项控制)

以下是使用变量的片段的示例:


====================================
USER NAME:          $TM_FULLNAME
FILE NAME:          $TM_FILENAME
 TAB SIZE:          $TM_TAB_SIZE
SOFT TABS:          $TM_SOFT_TABS
====================================

# Output:
====================================
USER NAME:          guillermo
FILE NAME:          test.txt
 TAB SIZE:          4
SOFT TABS:          YES
====================================
Fields(区段)

使用区段标识,可以通过按tab键的方式在片段中循环选项。当片段被插入时,区段可以用来在片段的定制字段中间跳转。


First Name: $1
Second Name: $2
Address: $3

在上面的例子中,按tab键一次,光标会调到$1的位置,按tab第二次,光标会前进到$2的位置。也可以使用Shift+Tab键回到上一个位置。当高粱的tab停靠位置已经结束,再按tabSublime Text会将光标移动到片段结束的位置,以便于回复正常编辑

如果希望控制tab的退出出口,使用$0标识

可以随时使用Esc键退出循环模式

Mirrored Fields(镜像区段)

相同的区段标志彼此反射:当编辑其中一个的时候,其余相同的区段会实时地被相同的值填充。


First Name: $1
Second Name: $2
Address: $3
User name: $1

以上是例子,User name会被与First Name相同的值填充

Place Holders(占位符)

将区段语法做一点点扩展,可以定义区段的默认值。当片段的区段有一个一般情况的值时,使用占位符定义默认值的同时课可以保证区段值自定义的便利性。


First Name: ${1:Guillermo}
Second Name: ${2:López}
Address: ${3:Main Street 1234}
User name: $1

变量可以被使用作为占位符:


First Name: ${1:Guillermo}
Second Name: ${2:López}
Address: ${3:Main Street 1234}
User name: ${4:$TM_FULLNAME}

占位符可以嵌套:


Test: ${1:Nested ${2:Placeholder}}
PS

初次翻译,如有误请见谅 _

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容