Sublime Text 3自定义插件

http://docs.sublimetext.info/en/latest/extensibility/plugins.html
https://clarknikdelpowell.com/blog/creating-sublime-text-3-plugins-part-1/

Sublime Text 3 (ST3) 作为我工作之后的唯一编辑器, 已经彻底征服了我的心,它非凡的性能变现以及众多插件的扩展性,已经让我欲罢不能了.每一个独特功能的插件都加速了我的日常工作,这使我萌生了自定义插件的想法.

关于插件

ST3的插件以文件的形式组织,它会在3个目录搜索插件:

  • Installed Packages
  • Packages
  • Packages/pkg_name/

但是如果Packages下文件嵌套太深,插件将不会被load
另外,ST3 的插件是已Python编写的,这要求你需要知道如何使用Python3

自定义插件

环境

  • x86_64 GNU/Linux
  • Sublime Text 3
  • Python 3+

添加插件

首先新建一个插件

  1. 点击 Perferences -> Browse Packages..., 在打开的文件夹下面新建一个目录:Mike;
  2. 点击 Tools -> New Plugin...,将文件保存到插件目录 Mike 下面,取名为: mike.py, 修改文件内容如下:
import sublime, sublime_plugin

class MikeCommand(sublime_plugin.TextCommand):
    def run(self, edit):
        self.view.insert(edit, 0, "Hello, World!")
  1. 使用 Ctrl + ` 打开 ST3 的命令行,输入:
view.run_command("mike")

如果成功在当前文件下看到 Hello, World! 表示插件已经添加成功

插件命令的解析规则很简单, 命令名称 + Command 构成class, 当然这里的命令名称是首字母大写的,但是执行的时候会转化为小写的,例如:
class MikeWangCommand 所对应的命令是: mike_wang

为插件添加快捷键

在插件的目录Mike下面新建文件: Default (Linux).sublime-keymap,
表示在Linux下面的快捷键设置,当然也可以为不同平台指定快捷键,具体支持如下:

  • Default (Windows).sublime-keymap
  • Default (OSX).sublime-keymap
  • Default (Linux).sublime-keymap

其内容如下:

[
    {
        "keys": [
            "ctrl+alt+k"
        ],
        "command": "mike"
    }
]

文件内容必须是一个json格式的数组, keys表示快捷键的组合方式, command则表示所要执行的命令.

为插件添加菜单

ST3支持3种类型的菜单:

  • Main.sublime-menu
    既所谓的顶部菜单,位于ST3菜单栏具体菜单下
  • Side Bar.sublime-menu
    侧边栏菜单,当在侧边栏右键时弹出
  • Context.sublime-menu
    当在文字区域内右键是弹出的上下文菜单

这里我定义了3中菜单:
Main.sublime-menu, 内容如下:

[
  {
    "id": "tools",
    "children": [
      {
        "caption": "Mike Wang",
        "id": "mike",
        "command": "mike"
      }
    ]
  }
]

效果为:在菜单栏Tools下面有一个 Mike Wang的菜单项

Side Bar.sublime-menu, 内容如下:

[
  {
    "caption": "Mike Wang",
    "command": "mike"
  }
]

效果为:在侧边栏右键是可以看到一个 Mike Wang的菜单项

Context.sublime-menu, 内容如下:

[
  {
    "id": "mike",
    "command": "mike",
    "caption": "Mike Wang"
  }
]

效果为:在文字区域右键有一个 Mike Wang的菜单项

很明显,这些文件都是以 json 数组的形式组织的,其内容表现为:

  • id
    每一个菜单项的唯一标识
  • caption
    相当于菜单的一个展示名称,所看到的效果
  • command
    大小写敏感,所要执行的命令
  • children
    用于定义子菜单

总结

到这里,一个简单的 ST3 插件就定义完毕,这里只是表现了一个插件的组织结构,并不具备什么有用的功能,因为这里并没有结合 ST3API . 但千里之行始于足下,具备了完整的结构才可以继续开展壮大起来.

更多技术细节:

http://www.sublimetext.com/docs/3/api_reference.html
http://www.sublimetext.com/docs/api-reference
http://docs.sublimetext.info/en/latest/reference/reference.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,636评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,890评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,680评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,766评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,665评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,045评论 1 276
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,515评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,182评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,334评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,274评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,319评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,002评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,599评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,675评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,917评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,309评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,885评论 2 341

推荐阅读更多精彩内容

  • Sublime Text:一款具有代码高亮、语法提示、自动完成且反应快速的编辑器软件,不仅具有华丽的界面,还支持插...
    xiaotao123阅读 9,471评论 0 27
  • Sublime Text:一款具有代码高亮、语法提示、自动完成且反应快速的编辑器软件,不仅具有华丽的界面,还支持插...
    晚晴幽草阅读 710,803评论 149 1,114
  • Sublime Text:一款具有代码高亮、语法提示、自动完成且反应快速的编辑器软件,不仅具有华丽的界面,还支持插...
    追風逸少丶阅读 11,303评论 1 34
  • 注册 打开Sublime Text 3的 “Help”–“Enter Licence”,然后根据版本选择输入下面的...
    passerbyli阅读 4,321评论 0 10
  • Sublime Text 是个轻量而强悍的跨平台文本编辑器,它具有很强的扩展能力。Sublime的自动补全,语言定...
    invalid_name阅读 6,519评论 1 11