Archives/bat
2
0
Fork 0
mirror of https://github.com/sharkdp/bat synced 2024-11-16 21:25:56 +00:00
Code Issues Projects Releases Wiki Activity
6c71a4324b
bat/assets
History
dependabot-preview[bot] 6c71a4324b Bump assets/syntaxes/Terraform from c683495 to 64208ea 
Bumps [assets/syntaxes/Terraform](https://github.com/alexlouden/Terraform.tmLanguage) from `c683495` to `64208ea`.
- [Release notes](https://github.com/alexlouden/Terraform.tmLanguage/releases)
- [Commits](c683495c64...64208ea816)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-01-26 13:51:59 +01:00
..
completions Update fish completions to use parameterized names 2019-09-27 12:13:55 -07:00
manual Update help text, closes #713 2019-12-22 16:05:00 +01:00
syntaxes Bump assets/syntaxes/Terraform from c683495 to 64208ea 2020-01-26 13:51:59 +01:00
themes Bump assets/themes/dracula-sublime from 1d068cb to c31934f 2019-12-27 18:34:13 +01: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 Nim syntax, closes #542 2019-10-30 19:47:24 +01: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