Sublime Text - Developing Plugin


Every editor includes plugin for the development, that triggers set of activities and default packages. Sublime Text editor includes a feature for developing your own customized plugin. This chapter discusses in detail about developing your own plugin in Sublime Text.

Developing Plugin

The following steps show you in detail how to develop a plugin in Sublime Text −

Step 1 − Select the New Plugin option by navigating through Tools → Developer → New Plugin as shown below −

Developing Plugin step1

Step 2 − The basic code of a plugin includes import of two main libraries: sublime and sublime_plugin.

Developing Plugin step2

The code for the plugin is −

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

Step 3 − The customized plugins are saved in Packages → User folder. Refer to the following screenshot that gives you the complete understanding of the plugins saved in Sublime Text editor.

Developing Plugin step3

Running the plugin

When you have created a plugin and saved it, open the console using the shortcut key Ctrl+` on Windows and Cmd+` on OSX, and execute the command shown here −

Font settings of Sublime Running the plugin

This command will execute the plugin defined by the user with the list of activities included in it.