wangming1993 / issues

记录学习中的一些问题,体会与心得 https://wangming1993.github.io/issues
8 stars 4 forks source link

Sublime Text 3自定义插件 #24

Open wangming1993 opened 8 years ago

wangming1993 commented 8 years ago

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_个目录搜索插件:

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

自定义插件

环境

首先新建一个插件

  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_下面的快捷键设置,当然也可以为不同平台指定快捷键,具体支持如下:

其内容如下:

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

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

为插件添加菜单

_ST3_支持3种类型的菜单:

这里我定义了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 数组的形式组织的,其内容表现为:

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

更多技术细节:

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