Sublime Text 开发插件

最近看到异次元推荐的代码编辑器Sublime Text2，感觉超好用，而且还有很多插件。不仅如此，还可以自己写个小插件。看到有人写了可以插入时间的小插件，于是想写一个可以插入代码文件头的小插件。在用eclipse和pycharm中可以在新建文件的头部加上作者和创建时间等信息。而在sublime中也想有这样的功能，没找到使用方法，于是自然想到自己写。sublime的插件开发是基于Python的，写起来很方便。另附上Sublime Text不完全使用手册的传送门。

sublime插件开发的方法还可以参考：

http://www.welefen.com/how-to-develop-sublime-text-plugin.html

http://www.cnblogs.com/Lvkun/archive/2012/03/28/plugin-eval-sel.html

 

1. 在菜单栏的Tools下有New Plugin，点击后就会给出一个可以往编辑器插入hello world的小插件。

2. 写好自己的插件代码，代码就不过多解释了，可以参考sublime的API。具体功能是可以记录文件创建时间和更新时间。

#-*- encoding: utf-8 -*-
'''
Created on 2013-01-07 22:05:01

@author: Neil
'''

import sublime, sublime_plugin, datetime

class insertSignatureCommand(sublime_plugin.TextCommand):
    def run(self, edit):
        date = datetime.datetime.now()
        dateStr = date.strftime("%Y-%m-%d %X")
        text_encode = """#-*- encoding: utf-8 -*-\n'''\n"""
        text_author = """\n\n@author: Neil\n'''\n"""
        text = text_encode + 'Created on ' + dateStr + text_author

        #for region in the selection
        #一个region是一个选择块，一次可以选择多个块
        for r in self.view.sel():
            str_r = self.view.substr(r)#str_r是所选择块的文本内容
            if 'Created on ' in str_r:
                if 'Updated on ' in str_r:
                    text = str_r[0:str_r.find('Updated on ')] + 'Updated on ' + dateStr + text_author
                else:
                    text = str_r.replace(text_author, '\nUpdated on ' + dateStr + text_author)
            self.view.erase(edit, r)
            self.view.insert(edit, r.begin(), text)

3.保存文件时，默认会让选择保存在“...\Sublime Text 2\Packages\User\” 文件夹下，取好文件名insert_signature.py，会发现保存后会自动生成insert_signature.pyc。

按下快捷键Ctrl + ‘ 打开SublimeText的控制台，执行如下命令就可以运行刚刚写的小插件：

view.run_command('insert_signature')

4.为了能够用快捷键来运行，需要额外设置快捷键映射文件，Default (Windows).sublime-keymap，Default (Linux).sublime-keymap，Default (OSX).sublime-keymap

分别对应不同的平台，最好是都输入快捷键的映射。这些文件与insert_signature.py保存在同以目录。就windows而言，在Default (Windows).sublime-keymap中输入

[
    {
        "keys": ["ctrl+f7"], "command": "insert_signature",
        "args": {}
    }
]

以后只要按下ctrl + F7就可以自动插入文件头部内容了。插入时可以先选择以前插入的内容，然后按下Ctrl + F7，就可以添加或更新文件的更新时间了。