Configuration and usage of ScopeHunter.
All commands are accessible via the command palette.
Show scope under cursor or cursors (depending whether multi-select is enabled)
Toggle scoping under cursor constantly.
In order to change the standard settings of Scope Hunter, please go to Preferences -> Package Settings -> Scope Hunter and click on Settings - User. Repeat that for Settings - Default, copy all the settings from the default file that you wish to change to the user settings file.
ScopeHunter on ST3, by default, uses the output panel to communicate the scope. But if you prefer a more subtle or flashier way of displaying the scope, ScopeHunter can be configured to do so.
///////////////////////////
// View Options
///////////////////////////
// Show popup tooltip with info about scope
"show_popup": false,
// Show scope in status bar
"show_statusbar": false,
// Show scope in auto-popup panel
"show_panel": true,
// Show scopes in console
"console_log": false,This uses the new ST3 tooltip API to display as is my personal favorite. It shows a styled tooltip with all the information about the scope of the current cursor(s). You get previews of the colors, and you can click links to copy the info to the clipboard.
This shows just the scope in the status bar. Simple and subtle.
This shows the scope and related info in an output panel. This allows a user to directly copy and paste the info from the panel.
This is useful if you are doing something like show_statusbar. You can keep the output subtle, but you can open the console and get more in depth info that you can copy and paste.
For modes like show_panel, console_log, and show_popup you can control the info displayed. You can keep it just to the scope, or you can extend it show other useful info.
///////////////////////////
// Additional Scope Info
///////////////////////////
// Show scope extent in point format
"extent_points": true,
// Show scope extent in line/char format
"extent_line_char": true,
// Show color and style at the given point
"styling": true,
// When showing a color with alpha transparency,
// Simulate what the color would look like in sublime
// by mixing the relevant background color,
"show_simulated_alpha_colors": true,
// Show the selector names and scopes
// responsible for the color and styles
"selectors": true,
// Show current syntax and color scheme paths
// (click to open if using tooltips)
"file_paths": true,
// Highlight scope extent in view
"highlight_extent": true,Show the extent of the scope as view points.
Show the extent of the scope as line/char or row/col format.
Highlight the scope extent.
Show not only the color value of the scope and text styling.
When showing color values, ScopeHunter can show the perceived color value of transparent colors (or mix the transparent foreground with the background giving the color value you are actually seeing).
Show the color scheme selectors that are responsible for applying the visible color and styles.
Show the file paths of the color scheme and language file that are responsible for giving the styled appearance of your view. In the tooltip, you can click these links and open the responsible file directly in Sublime Text.
When highlight_extent is enabled, this controls the visual style of the highlights. Due to the way the Sublime Text API for highlighting regions works, colors must be described as scope names from your color scheme file. Just define the scope to use and the supported style as shown below.
///////////////////////////
// Highlight Configuration
///////////////////////////
// Scope to use for the color
"highlight_scope": "invalid",
// Highlight style (underline|solid|outline|thin_underline|squiggly|stippled)
"highlight_style": "outline",Lastly there are a couple of other options:
///////////////////////////
// Additional Options
///////////////////////////
// Automatically copy scopes to clipboard
"clipboard": false,
// Allow multi-select scope hunting
"multiselect": true,
// Max region size to highlight
"highlight_max_size": 100,
// Use SubNotify plugin messages if installed
"use_sub_notify": trueAuto-copies just the scope to the clipboard.
Allow displaying the scope info for multiple cursor selections (does not work for show_statusbar as space is limited).
For performance, ScopeHunter is limited to highlight regions less that a given size. If a region is bigger than the defined limit, it will not be highlighted. You can control that limit here.
If you have the SubNotify installed, this will enable or disable messages through it.
You can choose a different theme style if you desire. See customizing tooltip theme for more info on creating your own theme.
///////////////////////////
// Tooltip Configurations
///////////////////////////
// Override theme. Use forward slashes.
"tooltip_theme": "ScopeHunter/tt_theme",Simply provide the path to the theme relative from the Sublime Packages folder.
On the latest ST3 branches, a new tooltip API is available. ScopeHunter can take advantage of this feature and provide useful scope tooltips when invoked. ScopeHunter comes with a theme that provides a light and dark variant that will be used depending on how light or dark you current color scheme is.
You can create your own if desired and use it instead of the default. The theme folder must include a light.tt_theme file and a dark.tt_theme file. The tt_theme files are a JSON files with a slightly modified syntax allowing JavaScript style comments. tt_theme files point to needed theme assets and set certain variables that are not defined in CSS files. All assets should be contained within the tt_theme folder and paths in the tt_theme files are relative to the tt_theme file itself. Do not use windows style backslashes \.
Example tt_theme structure:
tt_theme/
dark.tt_theme
light.tt_theme
css/
dark.css
light.css
Please use the default tt_theme as an example and template for creating your own. In the default tt_theme you should be able to see all the settings that can be set, and all the CSS classes that can be targeted.