ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Highlight Token

by cepthomas ST4 WinLinux

Sublime Text plugin for highlighting text, with persistence and user scopes and colors.

Labels highlight

Details

Installs

  • Total 15
  • Win 10
  • Mac 0
  • Linux 5
Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29 Oct 28 Oct 27 Oct 26
Windows 0 0 0 1 0 0 0 1 0 0 2 1 0 0 0 0 0 0 3 1 0 0 4 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Mac 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 1 2 2 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

Highlight Token

Sublime Text plugin to do text color highlighting per document. Loosely based on the old StyleToken.

Built for ST4 on Windows. Linux and OSX should be ok but are minimally tested - PRs welcome.

Features

  • Persisted per project to ...\Packages\User\HighlightToken\HighlightToken.store.
  • Select some text and right click to select one of six highlight colors. Select whole word by placing the caret at the start of the word.
  • Other options clear the highlights in the current file or the whole project.
  • To refresh highlighting while editing, save the file.
  • Utilities to show colorized list of the scopes at the caret, or all scopes in the view. Handy when selecting the highlight colors.
  • After editing your.sublime-color-scheme, refresh by close/reopen affected views. May be improved in the future.

ex1

Commands and Menus

Command Description Args
sbot_highlight_text Highlight text hl_index: scope markup.user_hl1 - 6
sbot_clear_highlights Remove all highlights in file
sbot_clear_all_highlights Remove all highlights in project
sbot_scope_info Show scopes at caret in color
sbot_all_scopes Show all scopes in view in color

There is no default Context.sublime-menu file in this plugin. Add the commands you like to your own User\Context.sublime-menu file. Typical entries are:

{ "caption": "HL 1", "command": "sbot_highlight_text", "args" : {"hl_index" : "0"} },
{ "caption": "HL 2", "command": "sbot_highlight_text", "args" : {"hl_index" : "1"} },
{ "caption": "Highlight",
    "children":
    [
        { "caption": "HL 3", "command": "sbot_highlight_text", "args" : {"hl_index" : "2"} },
        { "caption": "HL 4", "command": "sbot_highlight_text", "args" : {"hl_index" : "3"} },
        { "caption": "HL 5", "command": "sbot_highlight_text", "args" : {"hl_index" : "4"} },
        { "caption": "HL 6", "command": "sbot_highlight_text", "args" : {"hl_index" : "5"} },
        { "caption": "-" },
        { "caption": "Scope Info", "command": "sbot_scope_info" },
        { "caption": "All Scopes", "command": "sbot_all_scopes" },
        { "caption": "Clear All Highlights in Project", "command": "sbot_clear_all_highlights" },
    ]
},
{ "caption": "Clear Highlights in File", "command": "sbot_clear_highlights" },

Settings

Setting Description Options
scopes_to_show Scope list for sbot_all_scopes command.

Colors

New scopes have been added to support this application. Adjust these to taste and add to your Packages\User\your.sublime-color-scheme file. Note that these are also used by other members of the sbot family.

{ "scope": "markup.user_hl1", "background": "red", "foreground": "white" },
{ "scope": "markup.user_hl2", "background": "green", "foreground": "white" },
{ "scope": "markup.user_hl3", "background": "blue", "foreground": "white" },
{ "scope": "markup.user_hl4", "background": "yellow", "foreground": "black" },
{ "scope": "markup.user_hl5", "background": "lime", "foreground": "black" },
{ "scope": "markup.user_hl6", "background": "cyan", "foreground": "black" },

Notes

  • Some ST quirks:

    • The way ST works, you have to define which scope to use for each of the different highlights.
    • Coloring for markup.user_hls only supports fore and back colors, unfortunately not font_style.
    • Regions added by self.view.add_regions()cannot set the foreground color. The scope color is used for the region background color. Also they are not available viaextract_scope()“.
  • sbot_common.py contains miscellaneous common components primarily for internal use by the sbot family. This includes a very simple logger primarily for user-facing information, syntax errors and the like. Log file is in $APPDATA\Sublime Text\Packages\User\HighlightToken\HighlightToken.log.