extern/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2024-11-23 08:13:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
63c77383ce
bat/assets
History
Harald Hoyer 91deef8b13 add varlink syntax 
Varlink is an interface description format and protocol that aims
to make services accessible to both humans and machines in the
simplest feasible way.

See: https://varlink.org/ and https://github.com/varlink/ for
more information
2019-02-07 07:40:22 +01:00
..
syntaxes add varlink syntax 2019-02-07 07:40:22 +01:00
themes Add sublime-snazzy theme 2018-10-20 11:32:25 +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 link to new issue 2018-11-11 11:08:08 +01:00
JavaDoc.sublime-syntax.patch Workaround for #81 2018-10-04 11:09:41 +02:00
README.md Update README.md 2019-01-16 20:04:46 +01:00
syntaxes.bin Add AsciiDoc syntax. 2018-12-11 21:12:29 +01: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-11-11 12:55:38 +01: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.

  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.

Non-submodule additions