Sublime Text

https://www.sublimetext.com/docs
Admin
Sublime Text is a sophisticated text editor for code, markup and prose that offers powerful editing...
Tokens:44,920
Snippets:653
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### OpenGL Diagnostic Output Example

Source: https://www.sublimetext.com/docs/gpu_rendering.html

Example diagnostic information printed to the Console on startup when hardware acceleration is set to 'opengl'.

```text
OpenGL Context Information:
GL API Version: 4.1 INTEL-14.4.23
GLSL Version: 4.10
Vendor: Intel Inc.
Renderer: Intel Iris Pro OpenGL Engine

```

--------------------------------

### Build System Target Example

Source: https://www.sublimetext.com/docs/build_systems.html

Specify the command to run when the build system is invoked.

```JSON
"my_build"
```

--------------------------------

### Start Vintage in Command Mode

Source: https://www.sublimetext.com/docs/vintage.html

Configure Vintage to start in command mode instead of insert mode by default. Add this setting to your user preferences.

```json
"vintage_start_in_command_mode": true

```

--------------------------------

### Example Key Binding with Context

Source: https://www.sublimetext.com/docs/key_bindings.html

This example demonstrates a basic key binding that is activated when the auto-complete dropdown is visible. It shows how to use the 'context' key with 'auto_complete_visible'.

```json
[
    {
        "keys": ["ctrl+shift+`"],
        "command": "diff_changes",
        "context": [
            {
                "key": "auto_complete_visible",
                "operator": "equal",
                "operand": true
            }
        ]
    }
]
```

--------------------------------

### Build System Keyfiles Example

Source: https://www.sublimetext.com/docs/build_systems.html

Define keyfiles that enable a build system when present in opened folders.

```JSON
["Makefile"]
```

--------------------------------

### Operator Precedence Example

Source: https://www.sublimetext.com/docs/selectors.html

Provides an example of selector syntax demonstrating the order of operations for logical operators.

```text
a , b & -c | d , e

(a , ((b & (- c)) | d)) , e

```

--------------------------------

### Linux Build System Command Example

Source: https://www.sublimetext.com/docs/build_systems.html

Define specific command options for Linux execution.

```JSON
{
    "cmd": ["/usr/local/bin/my_command", "-d", "$file"]
}
```

--------------------------------

### Exec Target Path Example

Source: https://www.sublimetext.com/docs/build_systems.html

Provide a shortcut for setting the PATH environment variable.

```JSON
"path"
```

--------------------------------

### Windows Build System Command Example

Source: https://www.sublimetext.com/docs/build_systems.html

Define specific command options for Windows execution.

```JSON
{
    "cmd": ["my_command.exe", "/D", "$file"]
}
```

--------------------------------

### Build System Selector Example

Source: https://www.sublimetext.com/docs/build_systems.html

Use a selector to enable a build system for a specific syntax.

```JSON
"source.python"
```

--------------------------------

### macOS Build System Command Example

Source: https://www.sublimetext.com/docs/build_systems.html

Define specific command options for macOS execution.

```JSON
{
    "cmd": ["/Applications/MyProgram.app/Contents/MacOS/my_command", "-d", "$file"]
}
```

--------------------------------

### Build System File Patterns Example

Source: https://www.sublimetext.com/docs/build_systems.html

Specify file name patterns for build system enablement.

```JSON
["*.py"]
```

--------------------------------

### Sublime Text Completion Example

Source: https://www.sublimetext.com/docs/completions.html

An example of a .sublime-completions file demonstrating 'trigger', 'contents', 'kind', and 'details' fields for code completion.

```json
{
    "scope": "source.python",
    "completions": [
        {
            "trigger": "def",
            "contents": "def",
            "kind": "keyword"
        },
        {
            "trigger": "fun",
            "annotation": "basic function",
            "contents": "def ${1:name}($2):\n    $0\n",
            "kind": "snippet",
            "details": "A simple, non-<code>async</code> function definition"
        }
    ]
}

```

--------------------------------

### Exec Target Syntax Highlighting Example

Source: https://www.sublimetext.com/docs/build_systems.html

Specify the syntax file for highlighting the build system output panel.

```JSON
"Packages/JavaScript/JSON.sublime-syntax"
```

--------------------------------

### Build System Cancel Command Example

Source: https://www.sublimetext.com/docs/build_systems.html

Specify a command to cancel the build.

```JSON
"cancel_my_build"
```

--------------------------------

### Install zypper Sublime Text

Source: https://www.sublimetext.com/docs/linux_repositories.html

Installs Sublime Text using the zypper package manager.

```bash
sudo zypper install sublime-text
```

--------------------------------

### Exec Target Working Directory Example

Source: https://www.sublimetext.com/docs/build_systems.html

Specify the directory in which to execute the command.

```JSON
"$file_path"
```

--------------------------------

### Install dnf Sublime Text

Source: https://www.sublimetext.com/docs/linux_repositories.html

Installs Sublime Text using the dnf package manager.

```bash
sudo dnf install sublime-text
```

--------------------------------

### Exec Target Encoding Example

Source: https://www.sublimetext.com/docs/build_systems.html

Specify the encoding of the build system output.

```JSON
"iso-8859-1"
```

--------------------------------

### Example .tmTheme Color Scheme File

Source: https://www.sublimetext.com/docs/color_schemes_tmtheme.html

This is a complete example of a .tmTheme file, demonstrating global settings and various scope styles for comments, strings, and numbers. It uses XML format and includes comments for clarity.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>name</key>
    <string>Example Color Scheme</string>
    <key>settings</key>
    <array>
        <!-- Global settings -->
        <dict>
            <key>settings</key>
            <dict>
                <key>background</key>
                <string>#222222</string>
                <key>foreground</key>
                <string>#EEEEEE</string>
                <key>caret</key>
                <string>#FFFFFF</string>
            </dict>
        </dict>
        <!-- Scope styles -->
        <dict>
            <key>name</key>
            <string>Comment</string>
            <key>scope</key>
            <string>comment</string>
            <key>settings</key>
            <dict>
                <key>foreground</key>
                <string>#888888</string>
            </dict>
        </dict>
        <dict>
            <key>name</key>
            <string>String</string>
            <key>scope</key>
            <string>string</string>
            <key>settings</key>
            <dict>
                <key>foreground</key>
                <string>#FFD500</string>
            </dict>
        </dict>
        <dict>
            <key>name</key>
            <string>Number</string>
            <key>scope</key>
            <string>constant.numeric</string>
            <key>settings</key>
            <dict>
                <key>foreground</key>
                <string>#7F00FF</string>
            </dict>
        </dict>
    </array>
</dict>
</plist>
```

--------------------------------

### Exec Target Command Example

Source: https://www.sublimetext.com/docs/build_systems.html

Specify the executable and arguments for the 'exec' target.

```JSON
["my_command", "-d", "$file"]
```

--------------------------------

### Build System Variant Example

Source: https://www.sublimetext.com/docs/build_systems.html

Define a variant for a build system, overriding or adding options.

```JSON
[
    {
        "name": "Debug Symbols",
        "cmd": ["my_command", "-D", "$file"]
    }
]
```

--------------------------------

### Update pacman and Install Sublime Text

Source: https://www.sublimetext.com/docs/linux_repositories.html

Synchronizes pacman package databases and installs Sublime Text.

```bash
sudo pacman -Syu sublime-text
```

--------------------------------

### Build System Cancel Options Example

Source: https://www.sublimetext.com/docs/build_systems.html

Specify options to add when cancelling a build with a custom target.

```JSON
{ "kill": true }
```

--------------------------------

### Sublime Text Snippet Example

Source: https://www.sublimetext.com/docs/completions.html

An example of a .sublime-snippet file showing 'scope', 'tabTrigger', 'content', and 'description' for creating reusable code blocks.

```xml
<snippet>
    <scope>source.python</scope>
    <tabTrigger>fun</tabTrigger>
    <content><![CDATA[def ${1:name}($2):
    ${0:pass}]]></content>
    <description>function, non-async</description>
</snippet>

```

--------------------------------

### Update apt and Install Sublime Text

Source: https://www.sublimetext.com/docs/linux_repositories.html

Updates the apt package list and installs the Sublime Text package.

```bash
sudo apt-get update
sudo apt-get install sublime-text
```

--------------------------------

### Exec Target Quiet Mode Example

Source: https://www.sublimetext.com/docs/build_systems.html

Reduce the amount of output shown about the build system invocation.

```JSON
true
```

--------------------------------

### Exec Target Environment Variables Example

Source: https://www.sublimetext.com/docs/build_systems.html

Set environment variables for the execution of the command.

```JSON
{
    "PYTHONIOENCODING": "utf-8"
}
```

--------------------------------

### Exec Target File Regex Example

Source: https://www.sublimetext.com/docs/build_systems.html

Define a regex to parse file information from build output for result navigation.

```JSON
"^\s*(\S[^:]*)\((\d+):(\d+)\): ([^\n]+)"
```

--------------------------------

### Install yum Sublime Text

Source: https://www.sublimetext.com/docs/linux_repositories.html

Installs Sublime Text using the yum package manager.

```bash
sudo yum install sublime-text
```

--------------------------------

### Exec Target Shell Command Example

Source: https://www.sublimetext.com/docs/build_systems.html

Execute a shell command, allowing for piping and redirection.

```JSON
"my_command \"$file\" | other_command"
```

--------------------------------

### User Key Bindings Example

Source: https://www.sublimetext.com/docs/key_bindings.html

This is a basic example of a user-defined key binding in Sublime Text. It maps 'Ctrl+Shift+`' to the 'diff_changes' command, intended to show unsaved changes.

```json
[
    {
        "keys": ["ctrl+shift+`"],
        "command": "diff_changes"
    }
]
```

--------------------------------

### Example Sublime Text Keymap File

Source: https://www.sublimetext.com/docs/key_bindings.html

This snippet shows the overall structure of a .sublime-keymap file, including multiple key bindings with commands, arguments, and context.

```json
[
    {
        "keys": ["super+ctrl+m"],
        "command": "convert_syntax"
    },
    {
        "keys": ["super+shift+9"],
        "command": "set_layout",
        "args":
        {
            "cols": [0.0, 0.33, 0.66, 1.0],
            "rows": [0.0, 0.33, 0.66, 1.0],
            "cells":
            [
                [0, 0, 1, 1], [1, 0, 2, 1], [2, 0, 3, 1],
                [0, 1, 1, 2], [1, 1, 2, 2], [2, 1, 3, 2],
                [0, 2, 1, 3], [1, 2, 2, 3], [2, 2, 3, 3]
            ]
        }
    },
    {
        "keys": ["super+alt+up"],
        "command": "noop",
        "context":
        [
            {"key": "panel", "operand": "find"},
            {"key": "panel_has_focus"},
        ]
    }
]
```

--------------------------------

### Example Ignored Snippet Files

Source: https://www.sublimetext.com/docs/completions.html

Specifies file patterns for snippet files that should be ignored by Sublime Text. This example shows how to ignore all default C++ snippets.

```json
[
    "C++/*"
]
```

--------------------------------

### Inherit Syntax Definition

Source: https://www.sublimetext.com/docs/syntax.html

This example shows how to inherit from another syntax definition using the 'extends' key. It specifies the package path to the parent syntax file.

```yaml
%YAML 1.2 
---
name: C++
file_extensions: [cc, cpp]
scope: source.c++
extends: Packages/C++/C.sublime-syntax

```

--------------------------------

### sublime.get_log_build_systems()

Source: https://www.sublimetext.com/docs/api_reference.html

Get whether build system logging is enabled.

```APIDOC
## sublime.get_log_build_systems()

### Description
Get whether build system logging is enabled.

### Returns
- **bool** - True if build system logging is enabled, False otherwise.
```

--------------------------------

### Example Text for Syntax Matching

Source: https://www.sublimetext.com/docs/syntax.html

The input text used to demonstrate the capture group behavior in the syntax definition.

```text
yx
```

--------------------------------

### Exec Target Line Regex Example

Source: https://www.sublimetext.com/docs/build_systems.html

Define a regex to parse line information from build output when file information is not directly available.

```JSON
"^\s*line (\d+) col (\d+): ([^\n]+)"
```

--------------------------------

### Define UI element styles in a .sublime-theme file

Source: https://www.sublimetext.com/docs/themes.html

This example demonstrates the structure of a theme file, including texture definitions, hover state attributes, and label styling.

```json
[
    // Set up the textures for a button
    {
        "class": "button_control",
        "layer0.tint": "#000",
        "layer0.opacity": 1.0,
        "layer1.texture": "Theme - Example/textures/button_background.png",
        "layer1.inner_margin": 4,
        "layer1.opacity": 1.0,
        "layer2.texture": "Theme - Example/textures/button_highlight.png",
        "layer2.inner_margin": 4,
        "layer2.opacity": 0.0,
        "content_margin": [4, 8, 4, 8]
    },
    // Show the highlight texture when the button is hovered
    {
        "class": "button_control",
        "attributes": ["hover"],
        "layer2.opacity": 1.0
    },
    // Basic text label style
    {
        "class": "label_control",
        "fg": [240, 240, 240],
        "font.bold": true
    },
    // Brighten labels contained in a button on hover
    {
        "class": "label_control",
        "parents": [{"class": "button_control", "attributes": ["hover"]}],
        "fg": [255, 255, 255]
    }
]
```

--------------------------------

### Example .sublime-color-scheme File

Source: https://www.sublimetext.com/docs/color_schemes.html

This snippet shows the basic structure of a .sublime-color-scheme file, including global settings and rules for styling scopes like comments, strings, and numbers. Use this as a template for creating custom color schemes.

```json
{
    "name": "Example Color Scheme",
    "globals":
    {
        "background": "rgb(34, 34, 34)",
        "foreground": "#EEEEEE",
        "caret": "white"
    },
    "rules":
    [
        {
            "name": "Comment",
            "scope": "comment",
            "foreground": "#888888"
        },
        {
            "name": "String",
            "scope": "string",
            "foreground": "hsla(50, 100%, 50%, 1)",
        },
        {
            "name": "Number",
            "scope": "constant.numeric",
            "foreground": "#7F00FF",
            "font_style": "italic",
        }
    ]
}

```

--------------------------------

### Adding Entries to Submenus

Source: https://www.sublimetext.com/docs/menus.html

This example demonstrates how to add new entries to an existing submenu by referencing the parent entry's 'id' and providing a 'children' array.

```json
[
    {
        "id": "layout",
        "children":
        [
            {
                "caption": "Grid: 9",
                "command": "set_layout",
                "args":
                {
                    "cols": [0.0, 0.33, 0.66, 1.0],
                    "rows": [0.0, 0.33, 0.66, 1.0],
                    "cells":
                    [
                        [0, 0, 1, 1], [1, 0, 2, 1], [2, 0, 3, 1],
                        [0, 1, 1, 2], [1, 1, 2, 2], [2, 1, 3, 2],
                        [0, 2, 1, 3], [1, 2, 2, 3], [2, 2, 3, 3]
                    ]
                }
            },
        ]
    }
]
```

--------------------------------

### C Typedef Declarations

Source: https://www.sublimetext.com/docs/syntax.html

Demonstrates C code examples for defining simple and complex typedefs, including structures.

```c
typedef int coordinate_t;

typedef struct
{
    int x;
    int y;
} point_t;


```

--------------------------------

### Install apt GPG Key

Source: https://www.sublimetext.com/docs/linux_repositories.html

Adds the Sublime Text GPG key for apt-based systems (Ubuntu, Debian).

```bash
wget -qO - https://download.sublimetext.com/sublimehq-pub.gpg | sudo tee /etc/apt/keyrings/sublimehq-pub.asc > /dev/null
```

--------------------------------

### Install yum GPG Key

Source: https://www.sublimetext.com/docs/linux_repositories.html

Imports the Sublime Text GPG key for yum-based systems (CentOS).

```bash
sudo rpm -v --import https://download.sublimetext.com/sublimehq-rpm-pub.gpg
```

--------------------------------

### Install pacman GPG Key

Source: https://www.sublimetext.com/docs/linux_repositories.html

Downloads and adds the Sublime Text GPG key for pacman-based systems (Arch).

```bash
curl -O https://download.sublimetext.com/sublimehq-pub.gpg && sudo pacman-key --add sublimehq-pub.gpg && sudo pacman-key --lsign-key 8A8F901A && rm sublimehq-pub.gpg
```

--------------------------------

### Basic .sublime-completions File

Source: https://www.sublimetext.com/docs/completions.html

This is a basic example of a .sublime-completions file in JSON format. It defines completions for Python source files, including keywords and boolean values.

```json
{
    "scope": "source.python",
    "completions": [
        "def",
        "class",
        "None",
        "True",
        "False"
    ]
}
```

--------------------------------

### CSS Variables Example

Source: https://www.sublimetext.com/docs/minihtml.html

Demonstrates the use of CSS custom properties and the var() functional notation. Custom properties are defined with '--' and can be referenced using var().

```css
html {
    --fg: #f00;
}
.error {
    background-color: var(--fg);
}


```

--------------------------------

### Start Sublime Text in Safe Mode

Source: https://www.sublimetext.com/docs/safe_mode.html

Use the command line interface to launch Sublime Text with safe mode enabled. This is a cross-platform method.

```bash
subl --safe-mode

```

--------------------------------

### C Syntax Test Example

Source: https://www.sublimetext.com/docs/syntax.html

This snippet demonstrates a syntax test file for C code. It uses caret (`^`), arrow (`<-`), and at (`@`) tokens to test scopes and symbol definitions against the C.sublime-syntax definition.

```source.c
// SYNTAX TEST "Packages/C/C.sublime-syntax"
#pragma once
// <- source.c meta.preprocessor.c++
 // <- keyword.control.import

// foo
// ^ source.c comment.line
// <- punctuation.definition.comment

/* foo */
// ^ source.c comment.block
// <- punctuation.definition.comment.begin
//     ^ punctuation.definition.comment.end

#include "stdio.h"
// <- meta.preprocessor.include.c++
//       ^ meta string punctuation.definition.string.begin
//               ^ meta string punctuation.definition.string.end
int square(int x)
// <- storage.type
//  ^ meta.function entity.name.function
//         ^ storage.type
//  @@@@@@ definition
{
    printf("check %d\n", x);
//  @@@@@@ reference

    return x * x;
//  ^^^^^^ keyword.control
}

"Hello, World! // not a comment";
// ^ string.quoted.double
//                  ^ string.quoted.double - comment

```

--------------------------------

### find(pattern: str, start_pt: Point, flags=FindFlags.NONE) -> Region

Source: https://www.sublimetext.com/docs/api_reference.html

Searches for a pattern starting from a specific point.

```APIDOC
## find(pattern: str, start_pt: Point, flags=FindFlags.NONE) -> Region

### Description
Find the first Region matching the provided pattern.

### Parameters
- **pattern** (str) - Required - The regex or literal pattern to search by.
- **start_pt** (Point) - Required - The Point to start searching from.
- **flags** (FindFlags) - Optional - Controls various behaviors of find.

### Returns
- **Region** - The first Region matching the provided pattern.
```

--------------------------------

### Example Auto Complete Triggers

Source: https://www.sublimetext.com/docs/completions.html

Defines specific characters that trigger the auto-completion popup based on the current selector. This overrides the general auto_complete_selector setting.

```json
[
    {
        "selector": "text.html",
        "characters": "<"
    }
]
```

--------------------------------

### Example Sublime Text Menu Structure

Source: https://www.sublimetext.com/docs/menus.html

This snippet shows the basic JSON structure for a .sublime-menu file, defining a 'File' menu with several child entries.

```json
[
    {
        "caption": "File",
        "mnemonic": "F",
        "id": "file",
        "children":
        [
            { "command": "new_file", "caption": "New File", "mnemonic": "N" },

            { "command": "prompt_open_file", "caption": "Open File…", "mnemonic": "O", "platform": "!OSX" },
            { "command": "prompt_open_folder", "caption": "Open Folder…", "platform": "!OSX" },
            { "command": "prompt_open", "caption": "Open…", "platform": "OSX" }
        ]
    }
]
```

--------------------------------

### Include HTML Syntax in Jinja Templating

Source: https://www.sublimetext.com/docs/syntax.html

This example demonstrates how a templating language like Jinja can include HTML syntax. It defaults to HTML mode and uses 'with_prototype' to inject Jinja's expression delimiters into HTML contexts.

```yaml
scope: text.jinja
contexts:
  main:
    - match: ''
      push: Packages/HTML/HTML.sublime-syntax
      with_prototype:
        - match: '{{'
          push: expr

  expr:
    - match: '}}'
      pop: true
    - match: '\b(if|else)\b'
      scope: keyword.control

```

--------------------------------

### context_backtrace(pt: Point) -> list[ContextStackFrame]

Source: https://www.sublimetext.com/docs/api_reference.html

Get a backtrace of ContextStackFrames at the provided Point. Note this function is particularly slow.

```APIDOC
## context_backtrace(pt: Point) -> list[ContextStackFrame]

### Description
Get a backtrace of `ContextStackFrame`s at the provided `Point`. Note this function is particularly slow.
```

--------------------------------

### Custom Key Binding to Exit Insert Mode

Source: https://www.sublimetext.com/docs/vintage.html

Example of a custom key binding to exit insert mode by pressing 'j' twice. This is useful for customizing vi-like behavior.

```json
{
    "keys": ["j", "j"],
    "command": "exit_insert_mode",
    "context":
    [
        { "key": "setting.command_mode", "operand": false },
        { "key": "setting.is_widget", "operand": false }
    ]
}

```

--------------------------------

### Specify Colors using Legacy HSL Syntax

Source: https://www.sublimetext.com/docs/themes.html

Define colors using an array starting with 'hsl', followed by hue (0-360), saturation (0-100), lightness (0-100), and optional opacity (0.0-1.0).

```json
["hsl", 325, 100, 30]
```

```json
["hsl", 180, 100, 75, 0.5]
```

--------------------------------

### Key Binding with Arguments

Source: https://www.sublimetext.com/docs/key_bindings.html

Shows how to include arguments for a command, using the 'build' command with a 'select' argument.

```json
{
    "keys": ["primary+shift+b"],
    "command": "build",
    "args": {"select": true}
}
```

--------------------------------

### Basic Python Build System

Source: https://www.sublimetext.com/docs/build_systems.html

This is a basic build system that executes the currently open Python file. It uses the 'exec' target with a command to run Python and a selector to associate it with Python files.

```json
{
    "cmd": ["python", "$file"],
    "selector": "source.python",
    "file_regex": "^\\s*File \"(...*?)\", line ([0-9]*)"
}
```

--------------------------------

### sublime.platform()

Source: https://www.sublimetext.com/docs/api_reference.html

Retrieves the operating system platform.

```APIDOC
## sublime.platform()

### Description
Returns the platform which the plugin is being run on.

### Returns
- **Literal['osx', 'linux', 'windows']** - The platform name.
```

--------------------------------

### Set Color Scheme with Key Binding

Source: https://www.sublimetext.com/docs/settings.html

Use the `set_setting` command to create a key binding that sets a specific value for a setting, such as changing the color scheme for the current file.

```json
{
    "keys": ["ctrl+k", "ctrl+c"],
    "command": "set_setting",
    "args":
    {
        "setting": "color_scheme",
        "value": "Packages/Color Scheme - Default/Cobalt.tmTheme"
    }
}

```

--------------------------------

### show_input_panel(caption: str, initial_text: str, on_done, on_change, on_cancel)

Source: https://www.sublimetext.com/docs/api_reference.html

Shows the input panel to collect a line of input from the user.

```APIDOC
### show_input_panel(caption: str, initial_text: str, on_done, on_change, on_cancel)

Shows the input panel, to collect a line of input from the user.

#### Parameters
- **caption** (str) - The label to put next to the input widget.
- **initial_text** (str) - The initial text inside the input widget.
- **on_done** (Callable) - Called with the final input when the user presses enter.
- **on_change** (Callable) - Called with the input when it’s changed.
- **on_cancel** (Callable) - Called when the user cancels input using esc.
```

--------------------------------

### Define and Use Color Scheme Variables

Source: https://www.sublimetext.com/docs/color_schemes.html

Demonstrates how to define color variables in the 'variables' key and reference them in 'globals' and 'rules' using the 'var()' syntax. This allows for reusable color definitions across your color scheme.

```json
{
    "name": "Example Color Scheme",
    "variables":
    {
        "green": "hsla(153, 80%, 40%, 1)",
        "black": "#111",
        "white": "rgb(242, 242, 242)"
    },
    "globals":
    {
        "background": "var(black)",
        "foreground": "var(white)",
        "caret": "color(var(white) alpha(0.8))"
    },
    "rules":
    [
        {
            "name": "Comment",
            "scope": "comment",
            "foreground": "color(var(black) blend(#fff 50%))"
        },
        {
            "name": "String",
            "scope": "string",
            "foreground": "var(green)",
        },
        {
            "name": "Number",
            "scope": "constant.numeric",
            "foreground": "#7F00FF",
            "font_style": "italic",
        }
    ]
}

```

--------------------------------

### sublime.run_command

Source: https://www.sublimetext.com/docs/api_reference.html

Executes an ApplicationCommand.

```APIDOC
## sublime.run_command

### Description
Run the named ApplicationCommand.

### Parameters
- **cmd** (str) - Required - The command name.
- **args** (CommandArgs) - Optional - Arguments for the command.
```

--------------------------------

### sublime.load_settings(base_name)

Source: https://www.sublimetext.com/docs/api_reference.html

Loads the named settings object.

```APIDOC
## sublime.load_settings(base_name)

### Description
Loads the named settings. The name should include a file name and extension, but not a path. Subsequent calls with the same base_name return the same object.

### Parameters
- **base_name** (str) - Required - The file name and extension of the settings file.

### Returns
- **Settings** - The settings object.
```

--------------------------------

### Sublime Text CLI Help

Source: https://www.sublimetext.com/docs/command_line.html

Displays the available command-line flags for Sublime Text. The specific flags may vary by operating system.

```bash
Sublime Text build 4131

Usage: subl [arguments] [files]         Edit the given files
   or: subl [arguments] [directories]   Open the given directories
   or: subl [arguments] -- [files]      Edit files that may start with '-'
   or: subl [arguments] -               Edit stdin
   or: subl [arguments] - >out          Edit stdin and write the edit to stdout

Arguments:
  --project <project>:    Load the given project
  --command <command>:    Run the given command
  -n or --new-window:     Open a new window
  --launch-or-new-window: Only open a new window if the application is open
  -a or --add:            Add folders to the current window
  -w or --wait:           Wait for the files to be closed before returning
  -b or --background:     Don't activate the application
  --safe-mode:            Launch using a sandboxed (clean) environment
  -h or --help:           Show help (this message) and exit
  -v or --version:        Show version and exit

Filenames may be given a :line or :line:column suffix to open at a specific
location.

```

--------------------------------

### Key Binding for Select All Command

Source: https://www.sublimetext.com/docs/key_bindings.html

Demonstrates a key binding for the 'select_all' command, typically triggered by Ctrl+A.

```json
{
    "keys": ["ctrl+a"],
    "command": "select_all"
}
```

--------------------------------

### Define settings using an array of strings

Source: https://www.sublimetext.com/docs/themes.html

Use an array of strings to check for boolean settings, prefixing with '!' to check for a false value.

```json
["bold_folder_labels", "!always_show_minimap_viewport"]
```

--------------------------------

### Configure Hardware Acceleration

Source: https://www.sublimetext.com/docs/gpu_rendering.html

Set the `hardware_acceleration` setting to control rendering mode. Use 'none' for software rendering or 'opengl' for GPU acceleration.

```json
{
    "hardware_acceleration": "opengl"
}
```

--------------------------------

### Match Pattern with set and meta_content_scope

Source: https://www.sublimetext.com/docs/syntax.html

Demonstrates a bug where the matched text gets the meta_content_scope of the context being popped when a set action is performed. This behavior is fixed in version 2.

```yaml
scope: source.lang
contexts:
  function:
    - meta_content_scope: meta.function
    - match: '[a-zA-Z0-9_]+'
      scope: variable.function
    - match: \
      scope: punctuation.section.group.begin
      set: function-params

  function-params:
    - meta_scope: meta.function.params
    - match: \
      scope: punctuation.section.group.end
      pop: true

```

--------------------------------

### create_output_panel(name: str, unlisted=False) -> View

Source: https://www.sublimetext.com/docs/api_reference.html

Finds or creates an output panel view.

```APIDOC
### create_output_panel(name: str, unlisted=False) -> View

Find the `View` associated with the named output panel, creating it if required.

#### Parameters
- **name** (str) - The name of the output panel.
- **unlisted** (bool) - Control if the output panel should be listed in the panel switcher.
```

--------------------------------

### Toggle Word Wrap Setting with Key Binding

Source: https://www.sublimetext.com/docs/settings.html

Use the `toggle_setting` command to create a key binding that toggles the `word_wrap` setting for the current file.

```json
{
    "keys": ["alt+w"],
    "command": "toggle_setting",
    "args":
    {
        "setting": "word_wrap"
    }
}

```

--------------------------------

### Syntax Definition with Capture Groups

Source: https://www.sublimetext.com/docs/syntax.html

Defines a syntax scope and contexts with a regular expression using capture groups. This example illustrates how capture group numbering affects scope application.

```yaml
scope: source.lang
contexts:
  main:
    - match: '(?:(x)|(y))+'
      captures:
        1: identifier.x
        2: identifier.y
```

--------------------------------

### Match PHP Heredocs with Captured Identifiers

Source: https://www.sublimetext.com/docs/syntax.html

This example demonstrates how to match Heredocs in PHP. The main context captures the heredoc identifier, which is then used in the heredoc context to identify the closing delimiter.

```yaml
name: PHP
scope: source.php

contexts:
  main:
    - match: <<<([A-Za-z][A-Za-z0-9_]*)
      push: heredoc

  heredoc:
    - meta_scope: string.unquoted.heredoc
    - match: ^\1;
      pop: true

```

--------------------------------

### Define settings using an object

Source: https://www.sublimetext.com/docs/themes.html

Use an object to match specific setting values, including booleans, strings, or arrays of strings.

```json
{"bold_folder_labels": true, "file_tab_style": "rounded"}
```

--------------------------------

### Highlight Excessive Semicolons in C For Statements

Source: https://www.sublimetext.com/docs/syntax.html

This example highlights a C-style for loop statement that contains too many semicolons. It uses sequential contexts to track the expected position of semicolons and the closing parenthesis.

```yaml
for_stmt:
  - match: "("
    set: for_stmt_expr1
for_stmt_expr1:
  - match: ';'
    set: for_stmt_expr2
  - match: ")"
    pop: true
  - include: expr
for_stmt_expr2:
  - match: ';'
    set: for_stmt_expr3
  - match: ")"
    pop: true
  - include: expr
for_stmt_expr3:
  - match: ")"
    pop: true
  - match: ';'
    scope: invalid.illegal.stray-semi-colon
  - include: expr

```

--------------------------------

### Branching with Fallback Highlighting

Source: https://www.sublimetext.com/docs/syntax.html

Attempts one highlighting path (`branch`) and falls back to another if it fails. Uses `branch_point` to mark potential fallback locations.

```yaml
expression:
  - match: (?=\() 
    branch_point: open_parens
    branch:
      - paren_group
      - arrow_function

paren_group:
  - match: \(
    scope: punctuation.section.parens.begin.js
    push:
      - include: expressions
      - match: \)
        scope: punctuation.section.parens.begin.js
        set:
          - match: =>
            fail: open_parens
          - match: (?=\S)
            pop: 2

arrow_function:
  - match: \(
    scope: punctuation.section.parens.begin.js
    push:
      - match: \w+
        scope: variable.parameter.js
      - match: ','
        scope: punctuation.separator.comma.js
      - match: \)
        scope: punctuation.section.parens.begin.js
        set:
          - match: =>
            scope: storage.type.function.arrow.js
            push: arrow_function_body

```

--------------------------------

### sublime.Window.open_file

Source: https://www.sublimetext.com/docs/api_reference.html

Opens a file by path.

```APIDOC
## sublime.Window.open_file(fname, flags=NewFileFlags.NONE, group=-1)

### Description
Open the named file. If the file is already opened, it will be brought to the front.

### Parameters
- **fname** (str) - The path to the file to open.
- **flags** (NewFileFlags) - NewFileFlags to apply.
- **group** (int) - The group to add the sheet to. -1 for the active group.

### Returns
- **View** - The view for the file.
```

--------------------------------

### Java Syntax Test Example with Partial Symbols

Source: https://www.sublimetext.com/docs/syntax.html

This snippet shows a partial syntax test for Java code, specifically testing a switch statement. It uses the `partial-symbols` option to limit the scope of symbol testing.

```source.java
// SYNTAX TEST partial-symbols "Packages/Java/Java.sublime-syntax"

switch (foo) {
//     ^^^^^ meta.statement.conditional.switch.java meta.group.java
//      ^^^ variable.other.java

  case bar:
//     @@@ local-definition "case bar"


```
Tokens:
Raw