0

0

sublime怎么写一个简单的插件_sublime自定义插件编写入门指南

穿越時空

穿越時空

发布时间:2025-10-28 12:55:01

|

851人浏览过

|

来源于php中文网

原创

Sublime Text插件用Python编写,存于Packages目录,继承sublime_plugin.Command类;创建插件可通过Tools→Developer→New Plugin,保存为.py文件至User目录;命令通过命令面板、快捷键或菜单调用,命名需转为snake_case;常用类型有TextCommand、WindowCommand和EventListener,如监听保存事件自动转大写;从简单示例入手,熟悉API与细节即可开发实用工具。

sublime怎么写一个简单的插件_sublime自定义插件编写入门指南

Sublime Text 是一款高度可定制的文本编辑器,支持通过 Python 编写插件来扩展功能。如果你希望提升工作效率或实现特定功能,写一个简单的 Sublime 插件是个不错的起点。下面是一份简明实用的入门指南。

理解 Sublime 插件的基本结构

Sublime 插件本质上是用 Python(版本 3.8+,对应 Sublime Text 4)编写的脚本文件,存放在特定的 Packages 目录下。每个插件通常是一个 .py 文件,包含一个继承自 sublime_plugin.Command 的类。

基本结构如下:

import sublime
import sublime_plugin

class HelloWorldCommand(sublime_plugin.TextCommand):
    def run(self, edit):
        self.view.insert(edit, 0, "Hello, World!")

这个插件定义了一个名为 HelloWorldCommand 的命令,它会在当前文件的开头插入一段文字。

创建你的第一个插件

按照以下步骤快速创建并运行一个插件:

  • 打开 Sublime Text,点击菜单栏的 Tools → Developer → New Plugin...
  • 会弹出一个模板文件,包含两个类:Event Listener 和 Command。删除不需要的部分,保留 TextCommand 示例。
  • 修改类名和内容,例如改成上面的 HelloWorldCommand 示例。
  • 保存为 hello_world.py,建议放在 Packages/User/ 目录下(可通过 Preferences → Browse Packages... 进入)。

保存后插件即刻生效,无需重启 Sublime。

阿里云-虚拟数字人
阿里云-虚拟数字人

阿里云-虚拟数字人是什么? ...

下载

如何调用插件命令

Sublime 插件命令可以通过多种方式触发:

  • 命令面板(Command Palette):按下 Ctrl+Shift+PmacOS 为 Cmd+Shift+P),输入 “Hello World”,选择命令执行。
  • 快捷键绑定:在 Preferences → Key Bindings 中添加:
        { "keys": ["ctrl+alt+h"], "command": "hello_world" }
        
    注意:命令名是类名去掉 Command 后缀,并使用下划线命名法(CamelCase → snake_case)。
  • 菜单或鼠标右键:可通过修改 .sublime-menu 文件将命令加入上下文菜单或工具栏。

常见类型与用途说明

Sublime 支持多种插件类型,最常用的是:

  • TextCommand:作用于文本视图,可以修改内容,如插入、替换、格式化等。
  • WindowCommand:作用于窗口级别,比如打开新标签、切换面板等。
  • EventListener:监听事件,如文件保存、焦点变化,适合自动执行操作。

例如,监听保存事件自动转大写:

class OnSaveUppercaseListener(sublime_plugin.EventListener):
    def on_pre_save(self, view):
        region = sublime.Region(0, view.size())
        content = view.substr(region)
        view.run_command("replace_all_text", {"text": content.upper()})

基本上就这些。从一个简单的命令开始,逐步熟悉 API 和运行机制,就能开发出真正有用的工具。官方文档和社区插件是很好的学习资源。不复杂但容易忽略细节,比如命令命名转换规则和 edit 对象的使用。多试几次,很快就能上手。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

720

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

627

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

744

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

617

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1236

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

575

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

700

2023.08.11

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

74

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.7万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.0万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号