bat/assets at 39e2971e96137bd61fb3f577164728cfbcaeb55b - bat

History

sharkdp 39e2971e96 Add .ignore files to avoid searching asset folders		2018-05-25 17:44:50 +02:00
..
syntaxes	Add syntax docu, add VimL, CMake, INI, LESS syntax	2018-05-18 19:57:58 +02:00
themes	Add a few popular Sublime Text themes	2018-05-18 20:41:40 +02:00
.ignore	Add .ignore files to avoid searching asset folders	2018-05-25 17:44:50 +02:00
README.md	Add syntax docu, add VimL, CMake, INI, LESS syntax	2018-05-18 19:57:58 +02:00
create.sh	Include syntaxes and themes in repository	2018-05-16 22:04:12 +02:00
syntaxes.bin	Add syntax docu, add VimL, CMake, INI, LESS syntax	2018-05-18 19:57:58 +02:00
themes.bin	Add a few popular Sublime Text themes	2018-05-18 20:41:40 +02:00

Syntax Highlighting in bat

bat uses the syntect library to highlight source code. As a basis, syntect uses Sublime Text syntax definitions in the .sublime-syntax format.

In order to add new syntaxes to bat, follow these steps:

Find a Sublime Text syntax for the given language, preferably in a separate Git repository which can be included as a submodule (under assets/syntaxes).
If the Sublime Text syntax is only available as a .tmLanguage file, open the file in Sublime Text and convert it to a .sublime-syntax file via Tools -> Developer -> New Syntax from XXX.tmLanguage.... Save the new file in the assets/syntaxes folder.
Run the create.sh script. It calls bat cache --init to parse all available .sublime-syntax files and serialize them to a syntaxes.bin file (in this folder).
Re-compile bat. At compilation time, the syntaxes.bin file will be stored inside the bat binary.

Make sure that the local cache does not interfere with the internally stored syntaxes and themes (bat cache --clear).

The following files have been manually modified after converting from a .tmLanguage file: