专注于WEB前端开发, 追求更好的用户体验, 更好的开发体验 [长沙前端QQ群:234746733]

Sublime Text 新建文件的模版插件: SublimeTmpl

写了个sublime的模版插件, 项目主页: https://github.com/kairyou/SublimeTmpl
这样就可以新建文件时使用模版的内容了, 目前添加了html/js/css/php/python/ruby的模版. 不需新建空白文件, 再从其他文件复制内容过来了.
已增加对Sublime Text3的支持.

使用:

1. ST菜单, File-New File (SublimeTmpl), 选择列表里的相应菜单, 可直接使用模版新建文件.
2. 命令, cmd+shift+p, 输入: "tmpl:", 可以找到创建文件的菜单列表.
3.快捷键, 默认快捷键见下面. 可以自己修改, 方法见"设置"部分.

默认快捷键:

ctrl+alt+h html
ctrl+alt+j javascript
ctrl+alt+c css
ctrl+alt+p php
ctrl+alt+r ruby
ctrl+alt++shift+p python
关闭默认快捷键:

Package Settings > SublimeTmpl > Settings - User, 增加disabled_keymap_actions配置:
"disabled_keymap_actions": "html, css" // 关闭html/css语法的快捷键(多个逗号分隔) "disabled_keymap_actions: "all" //关闭所有语法快捷键

安装:

方法1. 通过 Package Control
Package Control / Install Package, 搜索"SublimeTmpl" 或 "tmpl", 安装.
* [2012/08/01]已经通过Package Control审核

方法2. Github
打开项目主页, git clone到ST的Packages文件夹(\Data\Packages), 或直接把ZIP格式的下载下来解压到Packages文件夹(文件夹名称必须为:SublimeTmpl).

设置:

菜单: Preferences / Packages Settings / SublimeTmpl, 可以编辑菜单/快捷键/新语法等等.

如果你想贡献自己的package, 可以参考我这篇文章的介绍:
https://xhl.me/archives/how-to-submit-a-sublime-package/

新增特性:

1. 用户自定义模板 (Thanks @Xu Cheng)
自定义模板路径: "Data\Packages\User\SublimeTmpl\templates" 目录, 会优先使用(可以参考:默认的模板).
默认模版路径: "Data\Packages\SublimeTmpl\templates" 目录.
用自己自定义的模板: 推荐把默认模版目录的*.tmpl文件 复制到 自定义模板路径, 再去修改.

2. 模板支持 ${date} 变量
settings - user里面可以修改${date}默认的输出格式("%Y-%m-%d %H:%M:%S"), 比如改成: "date_format" : "%Y-%m-%d"

3. 模板支持自定义 attr
settings - user里添加:

"attr": {
    "author": "your name" ,
    "email": "mail@yours.com",
    "link": "http://yours.com",
    "hello": "word"
}

就能在模板中使用 ${author} ${email} ${link} ${hello} 变量
Thanks @vfasky (Blog)

4. 保存文件时支持: ${saved_filename}, ${saved_filepath} 变量, settings - user里添加:
"enable_file_variables_on_save": true, // 开启
文件保存时, 上面的2个变量会替换为: 保存的文件名, 和文件路径.

5. 支持: ${project_base_name}, ${project_path} and ${platform} 变量, settings - user里添加:
"enable_project_variables": true, // 开启
Note: 仅ST3支持, 上面的3个变量会替换为: 项目名, 项目路径, 当前系统环境.

另外, 关于新增语言的附加说明

1. 新增SublimeTmpl里面没有的语言

1.1 新增.tmpl文件:
自定义模板目录 (`Preferences - Browse Packages`, `User/SublimeTmpl/templates`), 新增比如 `html5.tmpl`.

1.2 配置语言:
首先参考: `Packages Settings / SublimeTmpl / Settings - Default` 的默认设置.
新增语法, 选择: `SublimeTmpl / Settings - User`, 比如:

{
    "html5": { // new
        "syntax": "Packages/HTML/HTML.tmLanguage",
        "extension": "html" // default_extension
    },
    "vue": { // new
        "syntax": "Packages/Vue Syntax Highlight/vue.tmLanguage",
        "extension": "vue"
    },
    // "disable_keymap_actions": "html, js, python", // "all"
    "enable_project_variables": true, // ${project_base_name}, ${project_path} and ${platform}
    "enable_file_variables_on_save": true, // ${saved_filename}, ${saved_filepath} on save file
    "attr": {
        "author": "Your Name",
        "email": "you@example.org",
        "link": "http://example.org"
    }
}

`html5`:对应`html5.tmpl`, `syntax`是Packages目录内的syntax路径, `extension`是默认保存时使用的扩展名.

新增开始菜单: `SublimeTmpl / Settings - Menu`, 参照 `Menu - Default`.
新增快捷键: `SublimeTmpl / Key Bindings User`, 参照 `Key Bindings Default`.

2. 新增Sublime的语言

这个我也没新建过, 可以去Package Control或者github上面找个其他人添加的新语言, 参考参考.
如果没找到别人写好的, 可以参考如下网址, 自己做:
http://docs.sublimetext.info/en/latest/extensibility/syntaxdefs.html (官方文档, 利用AAAPackageDev这个插件制作)
http://manual.macromates.com/en/language_grammars (textmate的doc, 和sublime大部分是相同的)
https://github.com/LearnBoost/stylus/blob/master/editors/Stylus.tmbundle/Syntaxes/Stylus.tmLanguage (别人写好的语法, 可以和自己新建的对比)

/ 分类: 工具,实践 / TrackBackhttps://xhl.me/archives/sublime-template-engine-sublimetmpl/trackback标签: sublime, 插件

已有 80 条评论 »

  1. kunl kunl

    File-NewFile(Sublime Tmpl)除了menu ,其他全部是灰色,不可选

    1. kairyou kairyou

      @kunl
      请问你的系统和ST版本?

  2. jack jack

    这个模板插件很不错,不过想问一下关于版本的设定,

    @version \$Id\$

    为啥我在attr设置还是没有变我想要的呢

    1. kairyou kairyou

      $Id$ 是给git(attributes)或svn(keywords)功能用的, 提交到代码库时自动加上版本号, 如果你定义了attr里, 要再xx.user.tmpl里把$Id$替换成${Id}

  3. Kingso Kingso

    你好,Kairyou
    我电脑装上这个插件后按快捷键ctrl+alt+p后会弹出[Warning] No such file:Packages\SublimeTmpl\templates\php.tmpl
    但是相关路径是有这个文件的。
    python我没接触过,但是勉强能看懂是在sublime-tmpl.py文件的94行抛出了异常,就是第92行
    code = sublime.load_resource(self.tmpl_path)
    执行不了,路径是正确的,请问为什么会这样?

    1. kairyou kairyou

      @Kingso
      你好, 你的環境是Windows+ST3嗎? package control 安裝的 SublimeTmpl? 系統的菜單-browse package, 請查看下有沒有SublimeTmpl文件夾.

    2. kairyou kairyou

      抱歉新版有个bug, 已经修复, 可以通过git pull下来, 或者等package control通过审核后update.

  4. woween woween

    学习了,正需要啊!想求博主,介绍一款插件或者怎么设置sublime text 3 输入javascript原生方法,输入正确这个方法名字,变个颜色啊!

    1. kairyou kairyou

      @woween
      抱歉, 没发现有这功能的插件, 语法检查SublimeLinter到还不错, 编写sublime-completions来自动补全不是更方便吗.

  5. xeme xeme

    如果模板里有中文的话,会出错,最好对读取模板文件时加上decode('utf8')

    1. kairyou kairyou

      @xeme
      谢谢, 后面我会加上.

  6. yiwa yiwa

    如何更改settings - user里的attr的内容呢? 文件找不到......

    1. kairyou kairyou

      settings-user默认都是不存在的, 可以把settings-default的内容copy过来保存.

  7. Sublime Text 普通人的编辑利器 | kdwycz'blog

    [...]开发者的介绍[...]

添加新评论 »