Archives/bat
2
0
Fork 0
mirror of https://github.com/sharkdp/bat synced 2024-11-02 21:40:15 +00:00
Code Issues Projects Releases Wiki Activity
cf68b13322
bat/assets
History
sharkdp f03b45f3e5 Update TOML syntax
2019-10-20 20:48:14 +02:00
..
completions Update fish completions to use parameterized names 2019-09-27 12:13:55 -07:00
manual Update manual page to use parameterized names 2019-09-27 12:06:54 -07:00
syntaxes Update TOML syntax 2019-10-20 20:48:14 +02:00
themes Add Dracula theme 2019-10-11 20:18:22 +02:00
.gitattributes Add assets/.gitattributes 2018-11-11 14:50:59 +01:00
.ignore Add .ignore files to avoid searching asset folders 2018-05-25 17:44:50 +02:00
create.sh Update create.sh to quickly check for and update missing submodules 2019-10-10 23:49:39 +02:00
JavaDoc.sublime-syntax.patch Workaround for #81 2018-10-04 11:09:41 +02:00
README.md Add Org mode syntax, closes sharkdp#36 2019-05-29 19:52:06 +02:00
syntaxes.bin Update sublimehq/Packages to master 2019-09-23 08:58:56 +02:00
theme_preview.rs Small style changes to --list-themes 2018-08-28 20:24:13 +02:00
themes.bin Update syntaxes and themes 2019-05-15 22:12:02 +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 --build 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.

  5. If you send a pull request with your changes, please do not include the changed syntaxes.bin file. A new binary cache file will be created once before every new release of bat.

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:

  • Dart.sublime-syntax => removed #regex.dart include.
  • INI.sublime-syntax => added .hgrc, hgrc, and desktop file types.
  • Org mode.sublime-syntax => removed task file type.

Non-submodule additions