Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sublimehq/Packages
Syntax highlighting files shipped with Sublime Text and Sublime Merge
https://github.com/sublimehq/Packages
sublime sublime-syntax sublime-text syntax-highlighting
Last synced: 3 months ago
JSON representation
Syntax highlighting files shipped with Sublime Text and Sublime Merge
- Host: GitHub
- URL: https://github.com/sublimehq/Packages
- Owner: sublimehq
- License: other
- Created: 2015-06-13T04:17:44.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T18:04:22.000Z (3 months ago)
- Last Synced: 2024-10-24T22:35:05.726Z (3 months ago)
- Topics: sublime, sublime-syntax, sublime-text, syntax-highlighting
- Language: Shell
- Homepage: https://sublimetext.com
- Size: 13.6 MB
- Stars: 2,951
- Watchers: 107
- Forks: 587
- Open Issues: 225
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sublime Packages
## Requirements
These packages are developed against the latest build of Sublime Text in the [`dev` channel](https://www.sublimetext.com/dev).
The latest release of Packages shipped with Sublime Text should be tagged via git in this repository, you can find a list at .
Bugs may exist on older builds, and the format used is **not compatible** with builds older than Build 4095.
## Installation
To make changes to these packages and test them locally, fork this repository. Then symlink the changed packages into your [`Packages`](https://www.sublimetext.com/docs/packages.html) folder. (Replace `Python` in the following commands with the name of the syntax to install.)
### OS X
```bash
$ git clone https://github.com/sublimehq/Packages.git
$ ln -s `pwd`/Packages/Python ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/
```
### Linux
```bash
$ git clone https://github.com/sublimehq/Packages.git
$ ln -s `pwd`/Packages/Python ~/.config/sublime-text-3/Packages/
```
### Windows
On Windows, you can use directory junctions instead of symlinks (symlinks require administrative rights; directory junctions don't):
```powershell
# Using PowerShell
PS> git clone https://github.com/sublimehq/Packages.git
PS> cmd /c mklink /J "$env:APPDATA/Sublime Text 3/Packages/Python" (convert-path ./Packages/Python)
```
Alternatively, download the portable version and clone this repository directly as a subdirectory of the `Data` folder.
### ⚠️ Things to keep in mind
After you've finished, keep in mind that you're now overriding a default package.
If other people make upstream changes to an overridden package, yours will be out-of-date when Sublime Text updates to a new version. To get the latest version, pull the changes from this repository.
## Reference
Please refer to the official documentation:
* [Syntax definitions](https://www.sublimetext.com/docs/syntax.html#ver-dev)
* [Scope naming](https://www.sublimetext.com/docs/scope_naming.html)
## Pull Requests
Pull requests should:
1. Start with the name of the package in square brackets, e.g. `[XML]`.
2. Be as small and self-contained as is reasonable. Smaller changes are quicker to review.
3. Include a new (or enhanced) [syntax test](https://www.sublimetext.com/docs/syntax.html#testing) when changing a `.sublime-syntax` file.
4. Have multiple syntax tests and a set of performance measurements (old vs. new) when making significant changes.
### New Packages
Pull requests for new [packages](https://www.sublimetext.com/docs/packages.html) won't be accepted at this stage, as new packages can cause issues for users who have a package with the same name installed via [Package Control](https://packagecontrol.io/).
There are some planned changes that will address this in the future.
Complex plugins such as auto complete systems and linters should generally be in a stand-alone package, rather than included in the default set of packages.
## Missing Packages
This repository only contains syntax-definition-focused packages.
Notably, packages such as `Default` and `Theme - Default` are not included.