Robot/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2024-10-31 20:11:01 +01:00
Code Issues Packages Projects Releases Wiki Activity
72152296c7
bat/assets
History
Mitchell Kember bb6594e691 Add 3 new themes: ansi-light, ansi-dark, base16 
Also, interpret transparent colors (#RRGGBB00) as specifying a terminal
color palette number with RR. The three new themes use this.
2019-05-08 07:35:43 -05:00
..
completions Updated fish completions to include parameter completion for available themes, added cache subcommand completions 2019-04-13 10:59:22 +02:00
syntaxes add fish shell syntax definition 2019-04-25 17:52:21 +02:00
themes Add 3 new themes: ansi-light, ansi-dark, base16 2019-05-08 07:35:43 -05: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 cache/misc: be more cautious with bash 2019-04-25 17:52:21 +02:00
JavaDoc.sublime-syntax.patch Workaround for #81 2018-10-04 11:09:41 +02:00
README.md Rename 'bat cache --init' to 'bat cache --build' 2019-02-07 23:27:53 +01:00
syntaxes.bin Update syntaxes 2019-02-07 23:01:06 +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 --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.

Non-submodule additions