Awesome

Slimsag's SublimeHQ Packages Fork

These packages are developed against the latest Sublime Text 3 Dev Build. Bugs may exist on older builds, and the format used is not compatible with builds older than 3092.

Installation

If you want to make changes to these packages and test them locally, fork this repository and then symlink the changed packages into your Packages folder.

Replace Python in the following commands with the name of the syntax to install.

OS X

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

Linux

$ 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):

# 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.

After you've finished, keep in mind that you're now overriding a default package. When Sublime Text updates to a new version, you'll run the risk of having an out-of-date package unless you pull the latest changes from this repository.

Adding a new language

Find an open-source .tmLanguage or .sublime-syntax file

• With a .tmLanguage.json, .tmLanguage.yaml, or other, convert to .tmLanguage first:
  • Install the PackageDev plugin in Sublime Text 3.
  • Open the file with Sublime Text 3, press <kbd>Cmd+Shift+P</kbd>.
  • Search for PackageDev: Convert (YAML, JSON, PList) to and select Convert to: Property List
  • Rename the file to just .tmLanguage instead of .tmLanguage.plist (Sublime will not recognize it as a tmLanguage file otherwise).
  • Use <kbd>Cmd+Shift+P</kbd> and choose Set Syntax: Property List (XML)
  • Follow the steps below to convert the .tmLanguage to .sublime-syntax
• With a .tmLanguage file:
  • example: https://github.com/Microsoft/TypeScript-TmLanguage/blob/master/TypeScript.tmLanguage
  • Ensure it has exact .tmLanguage suffix, or else command will not be available.
  • Open the file with Sublime Text 3, press <kbd>Cmd+Shift+P</kbd>.
  • Search for Plugin Development: Convert Syntax to .sublime-syntax command.
  • If nothing happens, see the console (<kbd>Ctrl+`</kbd>)

Create a PR to this repository

Your PR should include:

• A folder like https://github.com/slimsag/Packages/tree/master/GraphQL with the final .sublime-syntax file.
• A SOURCE file with a URL where the syntax came from (e.g. link directly to the tmLanguage file on GitHub).
• A VERSION file with the Git commit hash of the SOURCE.
• An entry in the License table below, describing the license of the directory.

License

All contents are licensed under the following licenses, which allow for free commercial use and distribution of the files:

All files are licensed under the sublimehq/Packages MIT + Common License*, with different licenses for files generated by following the steps in a directory containing a SOURCE file:

Common License*

This indicates a common license used in TextMate syntax/grammar bundles, which reads as follows:

If not otherwise specified (see below), files in this repository fall under the following license:

Permission to copy, use, modify, sell and distribute this software is granted. This software is provided "as is" without express or implied warranty, and with no claim as to its suitability for any purpose.

An exception is made for files in readable text which contain their own license information, or files where an accompanying file exists (in the same directory) with a “-license” suffix added to the base-name name of the original file, and an extension of txt, html, or similar. For example “tidy” is accompanied by “tidy-license.txt”.

If an exception is made for the file we use, it must be noted as such in the table above.