今天给大家分享一下编写一个Sublime Text3 插件的流程以及使用插件解决的一个实际问题。
一、开发插件的前提条件
二、新建插件
1. 通过Tools -> New Plugin...来打开一个初始化的插件编辑文件。
初始化后的插件有如下内容:
2. 通过Preferences -> Browse Packages...打开Packages文件夹,在该文件夹下建立个子文件夹,名字为你想开发的插件名字,如:defineReplace。
回到插件开发的初始化编辑器页面,通过 ctrl+s 保存这个文件,并放到你建立的子文件夹下,文件名如:defineReplace.py 。
3、通过 ctrl+` 快捷键或者View -> Show Console 打开SublimeText的控制台。
并在输入框执行如下的命令:view.run_command('example')
执行结果如下,第一行插入了Hello,World!:
4、ExampleCommand类名字改为你想要的插件名字,如: definereplaceCommand(Command之前的名称小写),然后就可以开发该插件对应的功能了,当然这时候输入的命令也变成了view.run_command('definereplace'),这样执行才有效。
5、通过官方的API文档查找你需要的接口,文档见:http://www.sublimetext.com/docs/3/api_reference.html
二、编写插件
下面我分享一下我写的一个插件,这个插件的功能是将verilog文件中的define定义,全部替换成真实的值。
将文件中的宏定义替换成真实的值:
下面将我插件的源代码分享一下,并且提供了详细的注释,大家可以对照着API文档,理解我代码的内容,由于手机上不容易显示,我截几张图,详细的代码可以通过阅读原文去我的博客进行了解:
三、绑定快捷键
在defineReplace文件夹下新建映射文件,文件名是固定的。
这两个文件分别对应着不同的平台windows和linux,当然在Mac平台是Default (OSX).sublime-keymap。文件内容如下:
keys代表对应的快捷键,command代表着要执行的命令。
四、运行效果
运行前:
ctrl+shift+r运行后:
今天的分享就到这里,下一篇继续分析。如果大家觉得还可以呀,记得推荐呦。