bat/assets at 01984e1d02f45a7607a85ea43f7bb96e79587c19 - bat

mirror of https://github.com/sharkdp/bat synced 2024-11-18 15:26:16 +00:00

History

sharkdp a770cbf25e Update assets		2018-10-17 23:14:07 +02:00
..
syntaxes	syntax: Add robot framework support	2018-10-09 20:27:01 +02:00
themes	Add OneHalf themes, closes #256	2018-09-03 22:12:41 +02:00
.ignore	Add .ignore files to avoid searching asset folders	2018-05-25 17:44:50 +02:00
create.sh	Always remove the local cache when creating new assets	2018-10-10 21:49:03 +02:00
JavaDoc.sublime-syntax.patch	Workaround for #81	2018-10-04 11:09:41 +02:00
README.md	Update VimL syntax	2018-10-05 18:44:51 +02:00
syntaxes.bin	Update assets	2018-10-17 23:14:07 +02:00
theme_preview.rs	Small style changes to --list-themes	2018-08-28 20:24:13 +02:00
themes.bin	Bump version, update assets	2018-09-12 22:01:01 +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: