bat/assets at 5efc0033a1785b0ebf4ad7c75ba5b5af056c6194 - bat

mirror of https://github.com/sharkdp/bat synced 2024-11-04 18:00:24 +00:00

History

dependabot-preview[bot] 02cd68db37 Bump assets/syntaxes/02_Extra/AWK from `1ce5f90` to `e593eb6` Bumps [assets/syntaxes/02_Extra/AWK](https://github.com/JohnNilsson/awk-sublime) from `1ce5f90` to `e593eb6`. - [Release notes](https://github.com/JohnNilsson/awk-sublime/releases) - [Commits](`1ce5f90d44...e593eb6d42`) Signed-off-by: dependabot-preview[bot] <support@dependabot.com>		2020-09-30 19:50:19 +02:00
..
completions	Fix packaging and Use parameterized names for zsh completion	2020-09-14 11:28:09 +02:00
manual	Remove 'liquid' dependency	2020-09-20 19:50:39 +02:00
patches	Patch Markdown syntax	2020-05-11 20:22:50 +02:00
syntaxes	Bump assets/syntaxes/02_Extra/AWK from `1ce5f90` to `e593eb6`	2020-09-30 19:50:19 +02:00
themes	Add new theme: base16-256	2020-08-03 11:39:49 +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	Add patch for C# syntax	2020-04-11 23:55:27 +02:00
README.md	Document manual change in Apache sublime syntax file	2020-09-14 10:36:22 +02:00
syntaxes.bin	Add syntaxes.bin changes	2020-07-09 08:15:04 +02:00
theme_preview.rs	Small style changes to --list-themes	2018-08-28 20:24:13 +02:00
themes.bin	Update themes.bin	2020-08-03 11:39:49 +02:00

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:

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).
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.
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).
Re-compile bat. At compilation time, the syntaxes.bin file will be stored inside the bat binary.
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.

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

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

Assembly (x86_64) has been manually added from https://github.com/13xforever/x86-assembly-textmate-bundle due to git clone recursion problems
Nim.sublime-syntax has been added manually from https://github.com/getzola/zola/blob/master/sublime_syntaxes/Nim.sublime-syntax as there was no suitable Git repository for it. The original syntax seems to originate from https://github.com/Varriount/NimLime
Rego.sublime-syntax has been added manually from https://github.com/open-policy-agent/opa/blob/master/misc/syntax/sublime/rego.sublime-syntax as it is not kept in a standalone repository. The file is generated from https://github.com/open-policy-agent/opa/blob/master/misc/syntax/textmate/Rego.tmLanguage
SML.sublime_syntax has been added manually from https://github.com/seanjames777/SML-Language-Definitiona as it is not kept in a standalone repository. The file generated is from https://github.com/seanjames777/SML-Language-Definition/blob/master/sml.tmLanguage
Cabal.sublime_syntax has been added manually from https://github.com/SublimeHaskell/SublimeHaskell/ - we don't want to include the whole submodule because it includes other syntaxes ("Haskell improved") as well.