Sublime Text 外掛程式開發流程

開啟選單tools-> developer->new plugin，sublime text會自動幫你建立好乙個外掛程式例子。如下：

import sublime, sublime_plugin
class
examplecommand
(sublime_plugin.textcommand):
defrun
(self, edit):
self.view.insert(edit, 0, "hello, world!")

例子的意思是，在開啟的檔案中，往檔案的首位新增hello world。之後開啟選單sublime text->preferences->browse packages，在此目錄上建立乙個資料夾，用來存放剛才的外掛程式。資料夾與指令碼分別命名為example與example.py。

指令碼的預載入有兩種情況，一種是sublime text第一次開啟的時候，一種是儲存指令碼的時候。而指令碼的解除安裝也有兩種情況，一種是sublime text關閉，一種是刪除這個指令碼的時候。每次預載入，都會搜尋指令碼裡的command類，繫結好所有的command。如果需要在載入與解除安裝時呼叫自己的邏輯，可以定義plugin_loaded()和plugin_unloaded()函式。

command類就是用來執行特定命令或操作的方法，外掛程式的編寫都需要建立自己的command類。類名必須以大駝峰命名法書寫，並且以command為字尾。在執行此command時，以下劃線命名法，並省略command。除錯時，可以按ctrl+'開啟控制台，輸入view.run_command('***')。例如建立了乙個examplecommand類，輸入view.run_command('example')，即可執行命令。

windowcommand類

可以對視窗進行操作

textcommand類

可以對當前標籤頁的文字進行操作

在example.py指令碼中，sublime text自動幫我們建立了乙個繼承自textcommand的examplecommand類。繼承自此類後，就可以對當前標籤頁的文字進行操作。如例子中，就是在當前的標籤文字中加入一行字串。

編寫完自己的外掛程式以後，就可以把command繫結到指定的組合鍵中。熱鍵的json檔案是以.sublime-keymap為字尾來存放的，可以直接複製其他外掛程式的sublime-keymap檔案來進行修改。一般命名為default (linux).sublime-keymap、default (osx).sublime-keymap、default (windows).sublime-keymap，可以看出是用於對應不同系統的，如果你只需要在特定系統上使用，可以不寫上其他2個檔案。

在編寫json檔案時，有兩個是必須要寫的鍵值，keys與command。而args如果外掛程式邏輯有用到可以穿入引數，例如：

[
]

sublime text提供了3種選單，字尾都以.sublime-menu，這3種分別為：

其中鍵值有：

一般情況，新增自己的選單選項只需要caption，children，command這個三個。如下：

[
/example/default (osx).sublime-keymap"
},                                "caption": "key bindings – default"
},                            /example/user (osx).sublime-keymap"
},                                "caption": "key bindings – user"
}                        ]}]
}]
}]

最後把所有檔案都儲存在之前建立的example裡面就可以了。對於sublime text api不了解的可以到官網檢視。

Sublime Text 外掛程式開發流程

sublimetext 安裝外掛程式

sublime text常用外掛程式

sublimeText外掛程式推薦

Sublime Text 外掛程式開發流程

sublimetext 安裝外掛程式

sublime text常用外掛程式

sublimeText外掛程式推薦

相關推薦