編寫自己的Sublime Text2 插件

Sublime Text2(下文簡稱ST2) 是個小而強悍的跨平臺編輯器(貌似很多文章開頭都喜歡這樣說一句,我也就不免俗了),至於特點和介紹我就不重複了,相信看這篇文章的你,一定對該軟件有着一定的瞭解。不過有一點不得不說,那就是強大的插件功能,讓原本精悍的ST2變的無比強大。本文呢,就是要介紹給大家,如何創建自己的ST2插件。

好了,話不多說,開始切入主題。大家跟着步驟一起操作吧:

1. To to Preferences -> Browse Packages… 打開Packages文件夾,在裏面創建一個子文件夾(例:MypluginFolder),用來存放我們自己的插件。

2. To to Tools -> New Plugin… 創建一個新的插件。現在你所看到內容就是一個默認的示例,我們把它保存到我們剛纔所創建的文件夾中(例:MyPlugin.py)。

3. 使用快捷鍵:ctrl+` 來打開Sublime Txt的控制檯,在輸入框中輸入:view.run_command(‘example’) 並按回車執行。如果在文件的最上方,看到”Hello, World!”字樣的插入,那麼你的第一個插件已成功執行了。

4. 接着,我們把示例中的“ExampleCommand”改爲你自己的插件名稱(例:MypluginCommand)。

5. 爲了方便使用插件,還需要給它定義一個快捷鍵。在我們的插件目錄下,創建Default (Windows).sublime-keymap、Default (Linux).sublime-keymap和Default (OSX).sublime-keymap這3個文件,它們分別對應的不同平臺。如果我們是windows系統,那麼打開剛纔所創建的Default (Windows).sublime-keymap文件,輸入:

[
      {"keys": ["f12"], "command": "myplugin"}
]

注:這裏有一個需要注意的地方,這裏的command值必須是小寫(例:MyPluginCommand -> my_plugin)。另外,如果我們的插件名稱是駝峯式命名,那大小寫之間要用”_”連接(例:MyPluginCommand -> my_plugin)。

6. 把我們的插件,加入到頂部菜單欄或右鍵菜單欄。根據需求創建對應的文件,Main.sublime-menu 頂部菜單、 Side Bar.sublime-menu 右鍵操作左側Side Bar菜單、Context.sublime-menu controls 右鍵操作文件菜單。
現在我們把它加入到頂部菜單欄,打開Main.sublime-menu

[
     {
          "caption": "Preferences",
          "mnemonic": "n",
          "id": "preferences",
          "children":
          [
               {
                    "caption": "Package Settings",
                    "mnemonic": "P",
                    "id": "package-settings",
                    "children":
                    [
                         {
                              "caption": "My Plugin",
                              "mnemonic": "M",
                              "id": "my-plugin",
                              "children":
                              [
                                   {
                                        "command": "open_file", "args":
                                   {
                                        "file": "${packages}/MypluginFolder/Myplugin.py"
                                   },
                                        "caption": "View Source"
                                   },
                                   {
                                        "caption": "Running plugin",
                                        "id": "running-plugin",
                                        "command": "my_plugin"
                                   }
                              ]
                         }
                    ]
               }
          ]
     }
]

我們在菜單欄中選擇 Preferences -> Package Settings 看看是不是已經有我們所創建的內容了?插件的執行方式,可以根據我們所的快捷鍵,也可以通過菜單選項來執行。

至此,一個簡單的ST2插件便全部創建完成。大家如有遇到什麼問題和不明白的可以給我留言,相互共勉O(∩_∩)O

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章