syntax is used to set the syntax definition file which will be applied to the output panel, thus giving it syntax highlighting.

The variants can also specify or override the same JSON keys, and they will apply only to that variant.

variants can be used to allow a different command to be run, for example to just check the syntax of the file rather than execute it.

There's no point running a Python interpreter on PHP code, for example.

selector is a scope selector that defines what syntax the build is relevant for.

result_file_regex and result_line_regex are used to parse the output from a failed build and show the errors in such a way that it is possible to navigate the editor to where an error occurred.

shell_cmd specifies the exact command to run in the shell, and has support for variable placeholders (like $ that refers to the currently open file).

To work around this, many people use a REPL plugin. The code will just block waiting for input forever. Write some bytes to REPL’s outgoing stream.Build Systems are output-only, meaning it is not possible to execute some code that will request user input using the build system. ReplReader pump that keeps polling this method. ReplManager will set up a separate thread with a Read and return some bytes from REPL’s incoming stream, blocking as

A REPL over SublimeText’s internal Python interpreter.Īll these can be found in the plugin’s repl/ subdirectory.Ī REPL class is expected to provide a standard interface for SublimeREPL integration: read_bytes ( ) ¶ This is only used by Execnet Python integration This is only used by PowerShell integration. There are three integrations that provide their own classes: Presumably having been spawned externally, and the REPL connects to it over The process is connected to the output and the input of the REPL Running in the REPL is a subprocess of the editor.

Class SubprocessRepl for subprocess-based REPLs.

New integrations canĮither provide their own class, or use one of the base classes that ship with For this reason, actual REPL configuration is concentratedĪll REPL instances are descendants of Repl. This allows the command paletteĬonfiguration to specify a reference to the REPL configuration command instead The configuration item until one is found. Item and the name of a file where the configuration is stored, and scans theĪvailable Sublime configuration folders for the file and within the file for Its function is to execute another command. They replace the older method of input and quick panels (Window.showinputpanel and Window.showquickpanel) for a unified user experience in a single component.

This command is a wrapper that is used in the command palette configuration. Input handlers are a mechanism to query a user for one or multiple input parameters via the Command Palette.

Latter is achieved by the command run_existing_window_command (class It is obvious that the REPL configuration is concentrated in the menu files,Īnd the palette configuration only refers to those by ID and file name.

Sublime text editor plugins user input