Sublime Text 3 插件开发入门

注意:

1. Sublime 插件使用 Python 语言编写
2. 本文并不涉及实战项目讲解
3. 本文仅用作引导开发者掌握 Hello World 示例的编写和运行

插件的创建与保存

插件存储目录

插件存储位于: C:\Users\<Your Name>\AppData\Roaming\Sublime Text 3\Packages

你也可以通过 menu > preferences > browser packages... 打开该文件夹.

创建一个插件

通过 menu > tools > developer > new plugin... 创建一个新插件:

import sublime
import sublime_plugin

class ExampleCommand(sublime_plugin.TextCommand):
    def run(self, edit):
        # 在 sublime 编辑器的起始位置 (第一行第一列) 插入一句 "Hello, World!"
        self.view.insert(edit, 0, "Hello, World!")

将该文件以 ".py" 为后缀保存到插件目录, sublime 会自动重载并激活该模块.

如何调用模块

1. 通过控制台命令调用

打开 menu > view > show console 启用控制台.

注意我们刚才写好的类名字叫 "ExampleCommand", sublime 的调用方法为: 去掉末尾的 "Command", 将剩余的部分改成小写字母下划线式写法, 即可调用.

因此在控制台输入 view.run_command('example'), 即可调用 ExampleCommand 类功能.

同理, view.run_command('hello_world') 可调用 HelloWorldCommand, 输入 view.run_command('h_t_m_l_viewer') 可调用 HTMLViewerCommand (只是举个例子, 一般人不会这么写).

如果要调用的类不存在, 则不会显示任何效果.

2. 通过键绑定调用

打开 menu > prefereces > key bindings, 编辑用户文件.

假设我们要绑定 ExampleCommand 到快捷键 "ctrl shift v", 则输入: [{ "keys": ["ctrl shift v"], "command": "example" }].

保存后 sublime 会自动重载并激活, 现在可以通过快键键达到在命令行同样的效果.

3. 通过事件绑定调用

TODO

确保插件所依赖的模块平稳运行

TODO