Archives/bat
2
0
Fork 0
mirror of https://github.com/sharkdp/bat synced 2024-11-04 18:00:24 +00:00
Code Issues Projects Releases Wiki Activity
3f8b340ed8
bat/assets
History
Gert Hulselmans 3f8b340ed8 Add AWK syntax.
2018-06-15 16:41:51 +02:00
..
syntaxes Add AWK syntax. 2018-06-15 16:41:51 +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
create.sh Use default Markdown syntax, closes #157 2018-05-30 20:40:02 +02:00
README.md Add syntax docu, add VimL, CMake, INI, LESS syntax 2018-05-18 19:57:58 +02:00
syntaxes.bin Add AWK syntax. 2018-06-15 16:41:51 +02:00
themes.bin Add a few popular Sublime Text themes 2018-05-18 20:41:40 +02:00

README.md

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:

  1. 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).

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

  3. 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).

  4. Re-compile bat. At compilation time, the syntaxes.bin file will be stored inside the bat binary.

Troubleshooting

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

Manual modifications

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

  • VimL.sublime-syntax => added .vimrc file type.