bat/assets at 4f812c32ab68e3bd99dde4b431be1f7794a1d1c5 - Mirrors/bat

mirror of https://github.com/sharkdp/bat synced 2024-11-15 08:37:12 +00:00

History

Colin Dean 4f812c32ab Adds zenburn theme submodule Work towards #224 but @sharkdp is going to rebuild themes.bin		2018-08-28 07:37:27 +02:00
..
syntaxes	Update submodules	2018-08-18 19:30:35 +02:00
themes	Adds zenburn theme submodule	2018-08-28 07:37:27 +02:00
.ignore	Add .ignore files to avoid searching asset folders	2018-05-25 17:44:50 +02:00
create.sh	Add new '--blank' option for 'bat cache --init'	2018-08-20 21:34:08 +02:00
README.md	Add syntax docu, add VimL, CMake, INI, LESS syntax	2018-05-18 19:57:58 +02:00
syntaxes.bin	Load customized themes in addition to defaults	2018-08-20 21:39:21 +02:00
themes.bin	Load customized themes in addition to defaults	2018-08-20 21:39:21 +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: