Gutter Themes

When linting is done, SublimeLinter marks errors in two ways: the suspect code itself is marked, and the line on which the code occurs is marked in the gutter. Code marks and gutter marks are configured separately.

Gutter theme structure

There are actually two types of gutter marks: errors and warnings. This helps you to visually identify which marks are errors and which are warnings.

Gutter marks are drawn using PNG images. If a theme is colorized, the images are tinted with the current “error_color” or “warning_color” colors in your settings. Otherwise the images are drawn as is.

Standard gutter themes

Which gutter theme you use is a matter of taste. Below is a list of the built in gutter themes that come with SublimeLinter. (The names come from the third party icon set from which the icons were chosen.) If none of these suit you, you can easily create your own.

Note

Colorized icons are in fact mostly white; they are displayed here as they appear when drawn by SublimeLinter, tinted with the error or warning color. Creating the icons white allows the tint color to come through unchanged.

Name Error/Warning
Blueberry - cross bc_e   bc_w
Blueberry - round br_e   br_w
Circle cir_e   cir_w   [colorized]
Danish Royalty dr_e   dr_w
Default def_e   def_w   [colorized]
Hands h_e   h_w
Knob - simple k1_e   k1_w
Knob - symbol k2_e   k2_w
Koloria ko_e   ko_w
ProjectIcons pi_e   pi_w

Choosing a gutter theme

There are three ways to choose a gutter theme:

Command Palette
Bring up the Command Palette and type gutter. Among the commands you should see SublimeLinter: Choose Gutter Theme. If that command is not highlighted, use the keyboard or mouse to select it.

A list of the available gutter themes appears with the current gutter theme highlighted. Below each gutter theme name is an indication of whether the theme is a standard SublimeLinter theme or a user theme, as well as whether the theme is colorized.

If you type or use the arrow keys to move through the list, the current gutter theme will change dynamically to the currently selected theme. If you have a view open with gutter marks, this allows you to preview other themes. Pressing Return/Enter or clicking on a theme will commit that change. Pressing Escape will revert to the theme in use before the Command Palette opened.

Tools menu
At the bottom of the Sublime Text 3 Tools menu, you will see a SublimeLinter submenu. Select SublimeLinter > Choose Gutter Theme... and then follow the instructions for selecting from the Command Palette.

Context menu
If you right-click (or Control-click on OS X) within a file view, you will see a SublimeLinter submenu at the bottom of the context menu. Select SublimeLinter > Choose Gutter Theme... and then follow the instructions for selecting from the Command Palette.

Once you have selected a new gutter theme, all of the open views are redrawn with the new theme. The gutter theme you select is saved in your user settings, so it will still be active after restarting Sublime Text 3.

Creating a gutter theme

With SublimeLinter, you are free to create or install new gutter themes. You can mix and match the existing images, or use entirely new images. SublimeLinter’s built in gutter themes can be found in Packages/SublimeLinter/gutter-themes.

A gutter theme is simply a directory that contains the following three files:

<name>.gutter-theme
This file is what SublimeLinter uses to locate gutter themes, and <name> (without the < >) is used for the gutter theme name (the parent directory name can be anything). If a gutter theme is colorized, this file should contain the following JSON:

{
    "colorize": true
}

If the gutter theme is not colorized, the file may be empty, or it may include the same JSON but set "colorized" to false.

error.png
This image is displayed in the gutter on any line that has errors.

warning.png
This image is displayed in the gutter on any line that has warnings but no errors; errors always have precedence over warnings.

When you choose a gutter theme, SublimeLinter looks for any directory with these three files within Packages, Packages/User, or Installed Packages. Within Installed Packages, the gutter theme must be somewhere within a compressed .sublime-package file.

Gutter images

Sublime Text 3 scales gutter images to 16 x 16. For best results with Retina displays, gutter images should be 32 x 32 at 72dpi.

If your gutter icons will be colorized, they should be mostly white, with shades of gray used to create shadow areas. The entire image should be grayscale, so that the error and warning colors do not change when they are applied to the icons.

Installing gutter themes

Third party gutter themes may be searched for and installed via Package Control, or if you have created your own gutter theme, by placing the gutter theme directory in the Sublime Text 3 Packages or Packages/User directory. Once you have installed the new gutter theme, follow the instructions above to choose the theme. That’s all there is to it!