Sublime Text Official Packages

repository·master·Indexed 25 days ago

https://github.com/sublimehq/packages

Official syntax-definition-focused packages for Sublime Text. This repository allows developers to contribute or modify syntax definitions, providing instructions for local development via symlinking and guidelines for submitting pull requests. Compatible with Sublime Text builds 4095 and newer.

Tokens
715
Snippets
1
Records
4
Agent score
34%

What's inside sublimehq-packages

  1. Prevent package file merging by overriding shipped packages

    master

    When you symlink a package from this repository, it overrides the default package. However, if you rename or delete files within your symlinked folder, the original files from the shipped .sublime-package may still be loaded by Sublime Text.

    To prevent this, you can force Sublime Text to load an empty package instead of the shipped one by creating an empty .sublime-package zip file in your Installed Packages directory. This ensures you are overriding the shipped package entirely rather than merging files.

  2. Install Sublime Packages for local development

    master

    To modify and test Sublime Text packages locally, fork this repository and symlink the specific package folders into your Sublime Text Packages directory. Replace Python in the examples below with the name of the syntax or package you wish to install.

    ### OS X
    ```bash
    $ git clone https://github.com/sublimehq/Packages.git
    $ ln -s `pwd`/Packages/Python ~/Library/Application\ Support/Sublime\ Text/Packages/

    Linux

    $ git clone https://github.com/sublimehq/Packages.git
    $ ln -s `pwd`/Packages/Python ~/.config/sublime-text/Packages/

    Windows (using PowerShell)

    # Using PowerShell
    PS> git clone https://github.com/sublimehq/Packages.git
    PS> cmd /c mklink /J "$env:APPDATA/Sublime Text/Packages/Python" (convert-path ./Packages/Python)
  3. Guidelines for submitting Pull Requests

    master

    When submitting pull requests to this repository, follow these requirements:

    1. Naming: Start the PR with the package name in square brackets, e.g., [XML].
    2. Scope: Keep changes as small and self-contained as possible.
    3. Syntax Tests: Include a new or enhanced syntax test when modifying a .sublime-syntax file.
    4. Performance: For significant changes, include multiple syntax tests and a set of performance measurements (comparing old vs. new).
    5. History: Squashing commits on merge is required to keep the history linear.

    Note on New Packages: Pull requests for entirely new packages are currently not accepted to avoid conflicts with existing packages installed via Package Control.

  4. Requirements for using Sublime Packages

    master

    These packages are developed against the latest build of Sublime Text in the dev channel.

    Compatibility Warning: The format used in this repository is not compatible with builds older than Build 4095. Bugs may exist on older builds.