sublime的API是什么_sublime插件开发入门基础-sublime-PHP中文网

sublime的API是什么_sublime插件开发入门基础

尼克

发布： 2025-12-18 11:14:02

原创

552人浏览过

Sublime Text的API是一套基于Python 3.3+的插件开发接口，1. 提供sublime、sublime_plugin等模块以操作文本、窗口和事件；2. 通过继承TextCommand创建命令如插入时间戳；3. 使用EventListener监听on_pre_save等动作实现自动化；4. 命令可通过快捷键文件绑定触发。掌握核心对象与机制后可扩展丰富功能。

sublime的api是什么_sublime插件开发入门基础

Sublime Text 的 API 是一套供开发者用来创建插件的接口，它允许你通过 Python 脚本扩展编辑器功能。这些 API 由 Sublime Text 内置的 Python 环境提供，主要基于 Python 3.3+（具体版本取决于 Sublime 版本），让你可以操作文本、窗口、菜单、设置等核心组件。

API 核心模块与对象

开发插件前需了解几个关键类和模块：

sublime：提供全局控制，如获取窗口、读取设置、显示面板等。
sublime_plugin：所有插件必须继承自这个模块中的基类，比如 EventListener 或 TextCommand。
View：代表一个打开的文件视图，用于操作光标、选区、文本内容。
Window：表示主窗口，可用来新建标签页、查找符号等。
Region：描述文本中的一段范围，常用于高亮或替换。

编写第一个插件

以添加“在当前行插入时间戳”为例：

打开菜单 Tools → Developer → New Plugin…
替换默认代码为：

import sublime
import sublime_plugin
import datetime
<p>class InsertTimestampCommand(sublime_plugin.TextCommand):
def run(self, edit):
for region in self.view.sel():
if region.empty():
timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
self.view.insert(edit, region.begin(), timestamp)
else:
self.view.replace(edit, region, datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"))

登录后复制

保存为 Packages/User/insert_timestamp.py（可通过 Preferences → Browse Packages… 进入）

绑定命令与快捷键

让插件更易用，可添加快捷键或菜单项：

FlowMuse AI

节点式AI视觉创作引擎

查看详情

创建文件 Packages/User/Default.sublime-keymap
加入内容：

[
    { "keys": ["ctrl+alt+t"], "command": "insert_timestamp" }
]

登录后复制

注意命令名是将类名 InsertTimestampCommand 转为小写下划线格式，并去掉 Command 后缀。

监听事件自动响应

使用 EventListener 可监听编辑行为，例如保存时格式化：

class OnSaveFormatListener(sublime_plugin.EventListener):
    def on_pre_save(self, view):
        # 示例：保存前执行某个命令
        view.run_command("auto_format_on_save")

登录后复制

常见事件包括：on_load、on_modified、on_selection_modified、on_post_save 等。

基本上就这些。掌握 View 操作、命令结构和事件机制后，就能实现跳转、高亮、自动补全等复杂功能。官方文档虽简洁，但结合社区示例和调试输出（console 中输入 sublime.log_commands(True) 查看命令名），上手并不难。

以上就是sublime的API是什么_sublime插件开发入门基础的详细内容，更多请关注php中文网其它相关文章！